uip oder Rollen

Syntax und Optionen für „uip or Roles“, die Orchestrator-RBAC-Rollen, Berechtigungen und Zuweisungen auf Ordnerebene verwaltet.

uip or roles verwaltet Orchestrator-Rollen und -Berechtigungen (RBAC). Rollen bündeln Berechtigungen und werden Benutzern, Gruppen, Robotern, Maschinen oder externen Anwendungen entweder auf Mandanten- (Scope) oder auf Mandantenebene (Scope) zugewiesen. Verben auf dieser Seite decken Rollen und ihre Berechtigungen, die Rollenbenutzermitgliedschaft, die Rollen-/Berechtigungsprüfung auf Prinzipalebene 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 permissions list [options]
uip or roles list [options]
uip or roles get <role-key>
uip or roles create --name <name> --type <Tenant|Folder>
uip or roles update <role-key> [--add-permissions <names>] [--remove-permissions <names>]
uip or roles delete <role-key> -y
uip or roles users list <role-key> [options]
uip or roles users set <role-key> [--add-user-keys <keys>] [--remove-user-keys <keys>]
uip or roles user-roles list <principal-name> [--type <type>] [options]
uip or roles user-permissions list <username> [--folder-path <path> | --folder-key <key>]
uip or roles assign --user-key <key> --role-keys <keys> [--folder-path <path> | --folder-key <key>]

Verben

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

UIP oder Rollenberechtigungsliste

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

Optionen

Short	Long	Wert	Standard	Beschreibung
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--sort-by	Feld	Name asc	OData-Sortierung.

Beispiele

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

Datenform (--output json)

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

UIP oder Rollenliste

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. Verwenden Sie den Rollenschlüssel mit roles get, roles update oder roles users set.

Optionen

Short	Long	Wert	Standard	Beschreibung
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--sort-by	Feld	Id desc	OData-Sortierung.

Beispiele

uip or roles list --limit 50
uip or roles list --output-filter "Data[?Type=='Tenant'].Name"
uip or roles list --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

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

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Rollenschlüssel (GUID). Verwenden Sie roles list, um ihn zu finden.

Optionen

Short	Long	Wert	Standard	Beschreibung

Beispiele

uip or roles get a1b2c3d4-0000-0000-0000-000000000001
uip or roles get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Permissions'
uip or roles get 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 Rollen erstellen

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

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--name	text	erforderlich	Rollenname.
–	--type	Tenant | Folder	erforderlich	Tenant gilt für den gesamten Mandanten; Folder gilt innerhalb von Ordnern.

Beispiele

uip or roles create --name "Read Only" --type Tenant
uip or roles create --name "Folder Viewer" --type Folder
uip or roles create --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 Rollenaktualisierung

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.

edit ist ein registrierter Alias für dieses Verb – uip or roles edit funktioniert identisch mit uip or roles update.

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.

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

Beispiele

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

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

uip or roles update 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
-y	--yes	Markieren	–	Erforderlich. Bestätigt diesen nicht rückgängig zu machenden Vorgang – die CLI fordert Sie nie auf.

Beispiele

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

Datenform (--output json)

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

UIP oder Rollenbenutzerliste

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
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.

Beispiele

uip or roles users list a1b2c3d4-0000-0000-0000-000000000001
uip or roles users list a1b2c3d4-0000-0000-0000-000000000001 --limit 200
uip or roles users list 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 von Benutzern festgelegte Rollen

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. Nur additiv/subtrahiert – eine vorhandene Mitgliedschaft, die in keinem der Flags benannt ist, bleibt unverändert (im Gegensatz zu users assign-roles, die die vollständige Liste ersetzt).

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.

Beispiele

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

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

uip or roles users set 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 Benutzerrollenliste

Listen Sie alle Rollenzuweisungen für einen Prinzipal – einen Benutzer, eine Verzeichnisgruppe, einen Verzeichnisroboter, eine Maschine oder eine externe Anwendung – im gesamten Mandanten und in jedem Ordner auf. Nützlich für die Prüfung des vollständigen Zugriffsprofils eines Prinzipals.

Argumente

Name	Erforderlich	Zweck
<principal-name>	ja	Benutzername, Gruppenname, Robotername, Maschinenname oder Name der externen App, nach der gesucht werden soll.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--type	User | Group | Robot | Machine | ExternalApplication	User	Prinzipaltyp. Die Schreibweisen DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication werden auch als Alias akzeptiert.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.

Beispiele

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

Datenform (--output json)

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

UIP oder Rollenbenutzerberechtigungen Liste

Listen Sie die effektiven Berechtigungen eines Benutzers auf. Ohne Ordneroption werden Rollen und Berechtigungen auf Mandantenebene angezeigt; Mit --folder-path/--folder-key werden stattdessen die Rollen und Berechtigungen angezeigt, die in diesem spezifischen Ordner gewährt wurden. Gibt die deduplizierte Vereinigung von Berechtigungen zurück, die von allen übereinstimmenden Rollen gewährt wurden.

Argumente

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

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-path	Pfad	–	Zeigen Sie für diesen Ordner Berechtigungen auf Ordnerebene anstelle von Berechtigungen auf Mandantenebene an.
–	--folder-key	GUID	–	Ordneralternative zu --folder-path.

Beispiele

uip or roles user-permissions list [e-mail]

uip or roles user-permissions list [e-mail] --folder-path "Shared"

Datenform (--output json)

Mandantenebene:

{
  "Code": "UserPermissionList",
  "Data": {
    "Roles": ["Administrator"],
    "Permissions": ["Jobs.View", "Assets.Create"]
  }
}

Ordnerbezogenen:

{
  "Code": "UserPermissionList",
  "Data": {
    "FolderPath": "Shared",
    "Roles": ["Folder User"],
    "Permissions": ["Jobs.View", "Assets.View"]
  }
}

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.

Hinweis:

ACHTUNG – destruktiv für Rollen. Der Server ersetzt die gesamte Rollenliste des Benutzers auf Ordnerebene für den Zielordner durch die über --role-keys übergebenen Schlüssel. Rollen, die sich nicht in der Nutzlast befinden, werden im Hintergrund entfernt. Um vorhandene Ordnerrollen beizubehalten, lesen Sie sie zuerst mit roles user-roles list <principal-name> --type <type> und übergeben Sie die vollständige gewünschte Vereinigung an --role-keys. Verwenden Sie für die zusätzliche Rollenmitgliedschaft auf Mandantenebene für eine Rolle stattdessen roles users set.

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.

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.