Rolle erstellen

verwenden Rolle erstellen API, um eine neue Rolle mit Berechtigungen in der Control Room.

Anforderung

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

Header: X-Authorization <<authentication token>>

Alle API-Aufrufe müssen ein Authentifizierungs-Token in der Kopfzeile der Anfrage enthalten. Verwenden Sie die Authentifizierung API, um ein JSON-Web-Token zu erzeugen. Einzelheiten finden Sie unter Authentifizierungs-API.

Anforderungstext:

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

Anforderungsparameter


Parameter	Typ	Erforderlich	Beschreibung
Name	Zeichenfolge	Ja	Name der Rolle.
description	Zeichenfolge	Nein	Beschreibung der Rolle.
permissions	Array	Nein	Eine Reihe von Berechtigungen, die für die Rolle gewährt werden. Für jede Genehmigung sind die obligatorischen Parameter erforderlich. Weitere Einzelheiten zu den Parametern finden Sie weiter unten.
principals	Array	Nein	Ein Array/eine Sammlung von Principals (Benutzern), denen mit der Rolle Zugang gewährt wird. Weitere Informationen zu den Parametern finden Sie weiter unten.

Parameter des Erlaubnisfeldes


Parameter	Typ	Erforderlich	Beschreibung
id	Integer	Nein	Der numerische Wert, der die Berechtigung eindeutig identifiziert.
Aktion	Zeichenfolge	Nein	Die Aktion, die das Recht ermöglicht.
resourceId	Zeichenfolge	Nein	Die Ressourcen-ID, zu der die Aktion gehört.
resourceType	Array	Nein	Die Ressourcengruppe, zu der die Aktion gehört. Normalerweise wird einem Benutzer die Rollenberechtigung in Verbindung mit der Benutzerverwaltungsberechtigung erteilt. Rollen und Befugnisse

prinicpals Array-Parameter


Parameter	Typ	Erforderlich	Beschreibung
id	Integer	Nein	Id des Benutzers.
Nutzername	Zeichenfolge	Nein	Benutzername des Benutzers.
subjectId	Zeichenfolge	Nein	Betreff: Id des Benutzers.
Domain	Zeichenfolge	Nein	Active-Directory-Domäne, wenn der Benutzer ein AD-Benutzer ist.
autoLoginEnabled	Boolescher Wert	Nein	Kennzeichen, das angibt, ob die automatische Anmeldung aktiviert ist oder nicht.
gelöscht	Boolescher Wert	Nein	Flagge, die anzeigt, ob der Benutzer gelöscht ist oder nicht.
emailVerified	Boolescher Wert	Nein	Kennzeichen, das anzeigt, ob die E-Mail verifiziert ist oder nicht.
pwdExpired	Boolescher Wert	Nein	Kennzeichen, das anzeigt, ob das Passwort abgelaufen ist oder nicht.

Antwort

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

Antwortparameter


Parameter	Typ	Beschreibung
id	Integer	Eindeutige Kennung für die neu erstellte Rolle.
name	Zeichenfolge	Name der erstellten Rolle.
description	Zeichenfolge	Beschreibung der erstellten Rolle.
version	Integer	Version der Rolleninstanz.
createdBy	Integer	ID des Nutzers, der die Rolle erstellt hat.
createdOn	Zeichenfolge	Zeitstempel der Erstellung der Rolle.
updatedBy	Integer	ID des Nutzers, der die letzte Aktualisierung der Rolle vorgenommen hat.
updatedOn	Zeichenfolge	Zeitstempel der letzten Aktualisierung der Rolle.
permissions	Array	Ein Array mit eindeutigen Berechtigungen, die der Rolle zugewiesen wurden.
principals	Array	Ein Array mit eindeutigen Nutzern, die der Rolle zugewiesen wurden.

Anmerkung: Sie können die Control Room APIs in der Community Editionaber die API-Funktionalität ist begrenzt. Sie benötigen eine lizenzierte Automation 360 Edition, um die volle Funktionalität der APIs nutzen zu können.

Die REST-API antwortet auf jede Anfrage mit einem HTTP-Antwortcode. Für Antwortcodes, siehe API-Antwort-Codes.