Recupera un ruolo

Utilizza l'API Ottieni ruolo per ID per recuperare un ruolo specifico nella Control Room.

Richiesta

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

Header: X-Authorization <<authentication token>>

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Parametri della richiesta


Parametro	Tipo	Obbligatorie	Descrizione
ID ruolo	Integer	Sì	Inserire l'ID del ruolo.

Risposta

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
        }
    ]
}

Parametri di risposta


Parametro	Tipo	Descrizione
id	Integer	Identificatore univoco che rappresenta il nuovo ruolo creato.
nome	Stringa	Nome del ruolo creato.
descrizione	Stringa	Descrizione del ruolo creato.
versione	Integer	Versione dell'istanza del ruolo.
Creato da	Integer	ID dell'utente che ha creato il ruolo.
Data di creazione	Stringa	Il timestamp di creazione del ruolo.
Aggiornato da	Integer	ID dell'utente che ha effettuato l'ultimo aggiornamento del ruolo.
Aggiornato il	Stringa	Il timestamp dell'ultimo aggiornamento del ruolo.
autorizzazioni	Array	Un array di autorizzazioni univoche assegnate al ruolo.
principali	Array	Un array di utenti univoci assegnati al ruolo.

Nota: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.