Recuperar un rol

Use la API Obtener rol por ID para recuperar un rol específico en la Control Room.

Solicitud

GET https://{{ControlRoomURL}}/v1/usermanagement/roles/<role ID>

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

Todas las llamadas a la API deben contener un identificador de autenticación de API de autenticación (genera identificador web JSON) o un identificador de portador de servicios OAuth. No se pueden utilizar ambos a la vez en una API.

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
ID del rol	Entero	Sí	Ingrese el ID del rol.

Respuesta

200 OK

{
    "id": 264,
    "createdBy": 10,
    "createdOn": "2022-04-12T12:12:39Z",
    "updatedBy": 10,
    "updatedOn": "2022-04-12T12:12:39Z",
    "tenantId": 1,
    "version": 0,
    "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
    "description": "",
    "name": "Device admin",
    "permissions": [
        {
            "id": 1345,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "managecredentials",
            "resourceId": null,
            "resourceType": "credentials"
        },
        {
            "id": 1424,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "delete",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1425,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "edit",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1344,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "myschedule",
            "resourceId": null,
            "resourceType": "taskscheduling"
        },
        {
            "id": 1426,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "view",
            "resourceId": null,
            "resourceType": "dashboard"
        },
        {
            "id": 1414,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "attestcredentials",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1381,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "register",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1321,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "view",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1423,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "all",
            "resourceId": null,
            "resourceType": "devices"
        }
    ],
    "countPrincipals": 0,
    "systemRole": false,
    "principals": [
        {
            "id": 21,
            "createdBy": 10,
            "createdOn": "2022-04-12T12:12:19Z",
            "updatedBy": 21,
            "updatedOn": "2022-04-13T03:37:08Z",
            "tenantId": 1,
            "version": 19,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "username": "john_user",
            "description": "User",
            "deleted": false,
            "disabled": false,
            "email": "john.doe@aa.com",
            "firstName": "John",
            "lastName": "Doe",
            "autoLoginEnabled": true,
            "emailVerified": true,
            "clientRegistered": false,
            "passwordSet": true,
            "questionsSet": true,
            "activeDirectory": false,
            "passwordChangedOn": "2022-04-12T12:13:35Z",
            "deviceCredentialAttested": false,
            "multipleLoginAllowed": true
        }
    ]
}

Parámetros de respuesta


Parámetro	Tipo	Descripción
id	Entero	Identificador único que representa el nuevo rol creado.
nombre	Cadena	Nombre del rol creado.
descripción	Cadena	Descripción del rol creado.
versión	Entero	Versión de la instancia del rol.
creado por	Entero	ID del usuario que creó el rol.
creado el	Cadena	La marca de tiempo de creación del rol.
actualizado por	Entero	ID del usuario que ha realizado la última actualización del rol.
actualizado el	Cadena	La última marca de tiempo de actualización del rol.
permisos	Matriz	Una matriz de permisos únicos que se han asignado al rol.
principales	Matriz	Una matriz de usuarios únicos que se han asignado al rol.

Nota: Puede ver Control Room APIs en la Community Edition, pero la funcionalidad de la API está limitada. Necesita una Edition de Automatización 360 con licencia para acceder a la funcionalidad completa de las API.

La API REST responde a cada solicitud con un código de respuesta HTTP.Para ver los códigos de respuesta, consulte Códigos de respuesta de API.