uip oder Rollen

uip or roles verwaltet Orchestrator-Rollen und -Berechtigungen (RBAC). Rollen bündeln Berechtigungen und werden Benutzern entweder auf Mandanten- (Scope) oder Ordnerebene (Scope) zugewiesen. Verben auf dieser Seite decken Rollen und deren Berechtigungen, die Mitgliedschaft als Rollenbenutzer und Zuweisungen auf Ordnerebene ab. Informationen zur Rollenzuweisung auf Mandantenebene pro Benutzer finden Sie unter users assign-roles in uip or users.

Zusammenfassung

uip or roles <verb> [options]

Verben

Verb	Zweck
list-permissions	Listen Sie die Namen der gewährten Berechtigungen auf.
list-roles	Listen Sie die Rollen im Mandanten auf.
get-role	Rufen Sie eine Rolle mit ihren gewährten Berechtigungen ab.
create-role	Erstellen Sie eine Rolle (ohne Berechtigungen) im Scope Tenant oder Folder .
edit-role	Berechtigungen für eine Rolle hinzufügen oder entfernen.
delete-role	Löschen Sie eine von einem Benutzer erstellte Rolle.
list-role-users	Listen Sie die Benutzer auf, die einer Rolle zugewiesen sind.
set-role-users	Hinzufügen oder Entfernen von Benutzern für eine Rolle (Massen).
list-user-roles	Zeigen Sie die vollständigen Rollenzuweisungen eines Benutzers für den Mandanten und jeden Ordner an.
assign	Weisen Sie einem Benutzer in einem bestimmten Ordner Rollen auf Ordnerebene zu.

UIP oder Rollenlistenberechtigungen

Listen Sie jeden gewährten Berechtigungsnamen auf. Verwenden Sie diese Namen mit roles edit-role --add-permissions.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	Name asc	OData-Sortierung.

Beispiele

uip or roles list-permissions --limit 200
uip or roles list-permissions --output-filter 'Data[].Name'
uip or roles list-permissions --output table

Datenform (--output json)

{
  "Code": "PermissionList",
  "Data": [{ "Name": "Assets.Create" }, { "Name": "Assets.Delete" }]
}

UIP oder Rollenlistenrollen

Listen Sie die Rollen auf. Gibt den Schlüssel (GUID), die ID, den Namen, den Anzeigenamen, den Typ und ob die Rolle bearbeitbar ist zurück.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--order-by	Feld	Id desc	OData-Sortierung.

Beispiele

uip or roles list-roles --limit 50
uip or roles list-roles --output-filter "Data[?Type=='Tenant'].Name"
uip or roles list-roles --output table

Datenform (--output json)

{
  "Code": "RoleList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "ID": 1,
      "Name": "Administrator",
      "DisplayName": "Administrator",
      "Type": "Tenant",
      "IsEditable": false
    }
  ]
}

uip oder Roles get-role

Rufen Sie eine Rolle mit ihren gewährten Berechtigungen ab.

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Rollenschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001
uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get-role a1b2c3d4-0000-0000-0000-000000000001 --output table

Datenform (--output json)

{
  "Code": "Role",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "ID": 1,
    "Name": "Administrator",
    "DisplayName": "Administrator",
    "Type": "Tenant",
    "IsStatic": true,
    "IsEditable": false,
    "Permissions": "Assets.View, Assets.Create, Jobs.View"
  }
}

UIP oder Roles: Create-Role

Erstellen Sie eine Rolle ohne Berechtigungen. Nach der Erstellung Berechtigungen mit roles edit-role --add-permissions gewähren.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--name	text	erforderlich	Rollenname.
–	--type	ENUM	erforderlich	Tenant (gilt für den gesamten Mandanten) oder Folder (gilt innerhalb von Ordnern).
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

uip or roles create-role --name "Read Only" --type Tenant
uip or roles create-role --name "Folder Viewer" --type Folder
uip or roles create-role --name "Read Only" --type Tenant \
    --output-filter 'Data.Key'

Datenform (--output json)

{
  "Code": "RoleCreated",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "ID": 10,
    "Name": "Read Only",
    "Type": "Tenant",
    "Status": "Created successfully"
  }
}

UIP oder Rollenbearbeitungsrolle

Berechtigungen für eine Rolle hinzufügen oder entfernen. Liest aktuelle Berechtigungen, schaltet isGranted für Namen in --add-permissions / --remove-permissions um und speichert. Neue Namen (noch nicht für die Rolle) werden im vollständigen Berechtigungskatalog des Mandanten gesucht und hinzugefügt.

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Rollenschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--add-permissions	CSV der Namen	–	Zu gewährende Berechtigungen.
–	--remove-permissions	CSV der Namen	–	Berechtigungen, die widerrufen werden sollen.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Von den Optionen --add-permissions und --remove-permissions ist mindestens eine erforderlich.

Beispiele

uip or roles edit-role a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View,Jobs.View

uip or roles edit-role a1b2c3d4-0000-0000-0000-000000000010 \
    --remove-permissions Jobs.Edit

uip or roles edit-role a1b2c3d4-0000-0000-0000-000000000010 \
    --add-permissions Assets.View --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "RoleUpdated",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Updated successfully" }
}

UIP oder Rollen löschen

Löschen Sie eine von einem Benutzer erstellte Rolle. Integrierte Rollen (wobei IsStatic=true) nicht entfernt werden können.

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Rollenschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

uip or roles delete-role a1b2c3d4-0000-0000-0000-000000000010
uip or roles delete-role a1b2c3d4-0000-0000-0000-000000000010 \
    --output-filter 'Data.Status'
uip or roles delete-role a1b2c3d4-0000-0000-0000-000000000010 --output plain

Datenform (--output json)

{
  "Code": "RoleDeleted",
  "Data": { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

UIP oder Rollen list-role-users

Listen Sie die Benutzer auf, die einer Rolle zugewiesen sind.

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Rollenschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.

Beispiele

uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001
uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles list-role-users a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data[].UserName'

Datenform (--output json)

{
  "Code": "RoleUserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "ID": 101,
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User"
    }
  ]
}

UIP oder Rollensatzrollenbenutzer

Hinzufügen oder Entfernen von Benutzern für eine Rolle (Massen). Geben Sie --add-user-keys, --remove-user-keys oder beides an. Mindestens eines ist erforderlich.

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Rollenschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--add-user-keys	CSV von GUIDs	–	Benutzer, die hinzugefügt werden sollen.
–	--remove-user-keys	CSV von GUIDs	–	Zu entfernende Benutzer.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

uip or roles set-role-users a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-0000-0000-0000-000000000001

uip or roles set-role-users a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001,d4e5f6a7-…-002 \
    --remove-user-keys d4e5f6a7-…-099

uip or roles set-role-users a1b2c3d4-0000-0000-0000-000000000010 \
    --add-user-keys d4e5f6a7-…-001 --output-filter 'Data.Added'

Datenform (--output json)

{
  "Code": "RoleUsersUpdated",
  "Data": {
    "RoleKey": "a1b2c3d4-0000-0000-0000-000000000010",
    "Added": 1,
    "Removed": 0,
    "Status": "Updated successfully"
  }
}

UIP oder Rollen list-user-roles

Listen Sie alle Rollenzuweisungen für einen Benutzer im Mandanten und in jedem Ordner auf. Nützlich für die Prüfung des vollständigen Zugriffsprofils eines Benutzers.

Argumente

Name	Erforderlich	Zweck
<username>	ja	Benutzername, nach dem gesucht werden soll.

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.

Beispiele

uip or roles list-user-roles [e-mail]
uip or roles list-user-roles [e-mail] \
    --output-filter "Data[?Scope=='Folder']"
uip or roles list-user-roles [e-mail] --output table

Datenform (--output json)

{
  "Code": "UserRoleList",
  "Data": [
    { "Scope": "Tenant", "FolderPath": "", "Role": "Administrator" },
    { "Scope": "Folder", "FolderPath": "Shared", "Role": "Folder Administrator" }
  ]
}

uip oder Rollen zuweisen

Weisen Sie einem Benutzer Rollen auf Ordnerebene zu. Verwenden Sie nur Rollen vom Typ Ordner. Erfordert --folder-path oder --folder-key.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--user-key	GUID	erforderlich	Benutzerschlüssel.
–	--role-keys	CSV von GUIDs	erforderlich	Rollen-GUIDs, die im Ordner zugewiesen werden sollen.
–	--folder-path	Pfad	–	Zielordner. Geben Sie dies oder --folder-key.
–	--folder-key	GUID	–	Zielordner.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared"

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-…-002,a1b2c3d4-…-003 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or roles assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --folder-path "Shared" --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "PermissionsAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

Exitcodes

Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.

Zugehörige Befehle

• uip or users – Benutzerschlüssel finden; users assign-roles für Rollenzuweisungen auf Mandantenebene.
• uip or folders – Suchen Sie Ordnerschlüssel für roles assign.

Siehe auch

• Globale Optionen.
• Authentifizierung.