Crea ruolo

Use Create role API to create a new role with permissions in the Control Room.

Richiesta

POST https://{{ControlRoomURL}}//v1/usermanagement/roles

Header: X-Authorization <<authentication token>>

Tutte le chiamate API devono contenere un token di autenticazione nell'intestazione della richiesta. Usare la funzione Autenticazione per generare un token web JSON. Vedi API di autenticazione.

Corpo della richiesta:

{
   "name":"Trigger Manager",
   "description":"View and Manage the triggers",
   "permissions":[
      {
         "id":148,
         "action":"view",
         "resourceType":"dashboard",
         "resourceId":null
      },
      {
         "id":58,
         "action":"myschedule",
         "resourceType":"taskscheduling",
         "resourceId":null
      },
      {
         "id":59,
         "action":"managecredentials",
         "resourceType":"credentials",
         "resourceId":null
      },
      {
         "id":30,
         "action":"view",
         "resourceType":"devices",
         "resourceId":null
      },
      {
         "id":150,
         "action":"manage",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":149,
         "action":"view",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":131,
         "action":"managemytriggers",
         "resourceType":"eventtriggers",
         "resourceId":null
      }
   ],
   "principals":[
      {
         "id":3
      }
   ]
}

Parametri della richiesta


Parametro	Tipo	Obbligatorie	Descrizione
nome	Stringa	Sì	Name of the role.
descrizione	Stringa	No	Description of the role.
autorizzazioni	Array	No	An array of permissions that will be granted for the role. Each permission requires the mandatory parameters. For more details on the parameters, see below.
principali	Array	No	An array/collection of principals (users) who will be granted access with the role. For more information on the parameters, see below.

permission array parameters


Parametro	Tipo	Obbligatorie	Descrizione
id	Integer	No	The numeric value that uniquely identifies the permission.
action	Stringa	No	The action the permission enables.
resourceId	Stringa	No	The resource id to which the action belongs.
resourceType	Array	No	The resource group to which the action belongs. Typically a user is given the role permission in conjunction with user management permission. Roles and permissions

prinicpals array parameters


Parametro	Tipo	Obbligatorie	Descrizione
id	Integer	No	Id of the user.
nome utente	Stringa	No	User name of the user.
subjectId	Stringa	No	Subject Id of the user.
domain	Stringa	No	Active directory domain, if the user is an AD User.
autoLoginEnabled	Operatore booleano	No	Flag to indicate if auto login is enabled or not.
deleted	Operatore booleano	No	Flag to indicate if user is deleted or not.
emailVerified	Operatore booleano	No	Flag to indicate if email is verified or not.
pwdExpired	Operatore booleano	No	Flag to indicate if password is expired or not.

Risposta

201 Created

{
   "id":25,
   "createdBy":1,
   "createdOn":"2022-04-11T11:53:03Z",
   "updatedBy":1,
   "updatedOn":"2022-04-11T11:53:03Z",
   "tenantId":1,
   "version":0,
   "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
   "description":"View and Manage the triggers",
   "name":"Trigger Manager",
   "permissions":[
      {
         "id":59,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:21Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:21Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"managecredentials",
         "resourceId":null,
         "resourceType":"credentials"
      },
      {
         "id":131,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:31Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:31Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"managemytriggers",
         "resourceId":null,
         "resourceType":"eventtriggers"
      },
      {
         "id":149,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:42Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:42Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"view",
         "resourceId":null,
         "resourceType":"eventtriggers"
      },
      {
         "id":58,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:21Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:21Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"myschedule",
         "resourceId":null,
         "resourceType":"taskscheduling"
      },
      {
         "id":148,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:38Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:38Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"view",
         "resourceId":null,
         "resourceType":"dashboard"
      },
      {
         "id":150,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:42Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:42Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"manage",
         "resourceId":null,
         "resourceType":"eventtriggers"
      },
      {
         "id":30,
         "createdBy":0,
         "createdOn":"2022-02-28T23:49:21Z",
         "updatedBy":0,
         "updatedOn":"2022-02-28T23:49:21Z",
         "tenantId":1,
         "version":0,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "action":"view",
         "resourceId":null,
         "resourceType":"devices"
      }
   ],
   "countPrincipals":0,
   "systemRole":false,
   "principals":[
      {
         "id":3,
         "createdBy":1,
         "createdOn":"2022-03-17T19:33:06Z",
         "updatedBy":1,
         "updatedOn":"2022-04-08T21:54:29Z",
         "tenantId":1,
         "version":274,
         "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
         "username":"john_doe",
         "description":"",
         "deleted":false,
         "disabled":false,
         "email":"aa@aa.com",
         "firstName":"John",
         "lastName":"Doe",
         "autoLoginEnabled":true,
         "emailVerified":true,
         "clientRegistered":false,
         "passwordSet":true,
         "questionsSet":true,
         "activeDirectory":false,
         "passwordChangedOn":"2022-03-17T19:33:59Z",
         "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: È possibile visualizzare il Control Room APIs nel file Community Editionma le funzionalità dell'API sono limitate. È necessario disporre di una licenza Automation 360 Edition per accedere a tutte le funzionalità delle API.

L'API REST risponde a ogni richiesta con un codice di risposta HTTP. Per i codici di risposta, vedere Codici di risposta API.