uip oder Rollen

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

uip or roles manages Orchestrator roles and permissions (RBAC). Roles bundle permissions and are assigned to users, groups, robots, machines, or external applications at either the tenant (globally) or folder (scoped) level. Verbs on this page cover roles and their permissions, role-user membership, principal-level role/permission inspection, and folder-level assignments. For tenant-level role assignment per user, see 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	List a principal's (user, group, robot, machine, or external app) complete role assignments across tenant and every folder.
user-permissions list	List a user's effective permissions, tenant-wide or scoped to one folder.
assign	Weisen Sie einem Benutzer in einem bestimmten Ordner Rollen auf Ordnerebene zu.

uip or roles permissions list

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 or roles list

List roles. Returns key (GUID), ID, name, display name, type, and whether the role is editable. Use the role key with roles get, roles update, or 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 or roles get

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

Argumente

Name	Erforderlich	Zweck
<role-key>	ja	Role key (GUID). Use roles list to find it.

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 or roles create

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 applies across the tenant; Folder applies within folders.

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 or roles update

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 is a registered alias for this verb — uip or roles edit works identically to 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 or roles delete

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	–	Required. Confirms this irreversible operation — the CLI never prompts.

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 or roles users list

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

Add or remove users on a role (bulk). Provide --add-user-keys, --remove-user-keys, or both. At least one is required. Additive/subtractive only — existing membership not named in either flag is left untouched (unlike users assign-roles, which replaces the full list).

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 or roles user-roles list

List all role assignments for a principal — a user, directory group, directory robot, machine, or external application — across the tenant and every folder. Useful for auditing a principal's full access profile.

Argumente

Name	Erforderlich	Zweck
<principal-name>	ja	Username, group name, robot name, machine name, or external-app name to look up.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--type	User | Group | Robot | Machine | ExternalApplication	User	Principal type. The DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication spellings are also accepted as aliases.
-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 or roles user-permissions list

List a user's effective permissions. Without a folder option, shows tenant-level roles and permissions; with --folder-path/--folder-key, shows the roles and permissions granted in that specific folder instead. Returns the deduplicated union of permissions granted by all matching roles.

Argumente

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

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-path	Pfad	–	Show folder-level permissions for this folder instead of tenant-level.
–	--folder-key	GUID	–	Folder alternative to --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)

Tenant-level:

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

Folder-scoped:

{
  "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:

CAUTION — destructive on roles. The server replaces the user's entire folder-level role list for the target folder with the keys passed via --role-keys. Roles not in the payload are silently removed. To preserve existing folder roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. For additive tenant-level role membership on a role, use roles users set instead.

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.