Créer un rôle

Utiliser Créer un rôle pour créer un nouveau rôle avec des permissions dans l'environnement . Control Room.

Demande

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

Header: X-Authorization <<authentication token>>

Tous les appels d'API doivent contenir un jeton d'authentification dans l'en-tête de la demande. Utilisez l'option Authentification pour générer un jeton Web JSON. Reportez-vous à API d'authentification.

Corps de la demande :

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

Paramètres de la demande


Paramètre	Type	Obligatoire	Description
nom	Chaîne	Oui	Nom du rôle.
description	Chaîne	Non	Description du rôle.
autorisations	Tableau	Non	Un tableau de permissions qui seront accordées pour le rôle. Chaque autorisation requiert les paramètres obligatoires. Pour plus de détails sur les paramètres, voir ci-dessous.
principals	Tableau	Non	Un tableau/une collection de principaux (utilisateurs) qui auront l'accès avec le rôle. For more information on the parameters, see below.

paramètres du tableau des autorisations


Paramètre	Type	Obligatoire	Description
id	Entier	Non	La valeur numérique qui identifie de façon unique l'autorisation.
action	Chaîne	Non	L'action que l'autorisation permet de réaliser.
resourceId	Chaîne	Non	L'identifiant de la ressource à laquelle l'action appartient.
Type de ressource	Tableau	Non	Le groupe de ressources auquel l'action appartient. En général, un utilisateur reçoit l'autorisation de jouer un rôle en même temps que l'autorisation de gérer les utilisateurs. Rôles et autorisations

paramètres du tableau de prinicpals


Paramètre	Type	Obligatoire	Description
id	Entier	Non	Id de l'utilisateur.
nom d'utilisateur	Chaîne	Non	Nom d'utilisateur de l'utilisateur.
subjectId	Chaîne	Non	Id du sujet de l'utilisateur.
domaine	Chaîne	Non	Domaine du répertoire actif, si l'utilisateur est un utilisateur AD.
autoLoginEnabled	Booléen	Non	Drapeau indiquant si la connexion automatique est activée ou non.
supprimé	Booléen	Non	Drapeau pour indiquer si l'utilisateur est supprimé ou non.
emailVerified	Booléen	Non	Drapeau pour indiquer si l'email est vérifié ou non.
pwdExpired	Booléen	Non	Flag pour indiquer si le mot de passe est expiré ou non.

Réponse

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

Paramètres de la réponse


Paramètre	Type	Description
id	Entier	Identifiant unique représentant le nouveau rôle créé.
nom	Chaîne	Nom du rôle créé.
description	Chaîne	Description du rôle créé.
version	Entier	Version de l'instance de rôle.
createdBy	Entier	ID de l'utilisateur qui a créé le rôle.
createdOn	Chaîne	Le timestamp de la création du rôle.
updatedBy	Entier	ID de l'utilisateur qui a effectué la dernière mise à jour du rôle.
updatedOn	Chaîne	Le timestamp de la dernière mise à jour du rôle.
autorisations	Tableau	Un tableau d'autorisations uniques qui ont été assignées au rôle.
principals	Tableau	Un tableau d'utilisateurs uniques qui ont été assignés au rôle.

Remarque : Vous pouvez consulter le Control Room APIs dans le Community Editionmais la fonctionnalité de l'API est limitée. Vous devez posséder une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalités des API.

L'API REST répond à chaque demande par un code de réponse HTTP. Pour les codes de réponse, voir Codes de réponse de l'API.