UIP ou rôles

Syntaxe et options pour `uip ou rôles`, qui gère les rôles, les autorisations et les affectations au niveau du dossier dans Orchestrator.

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.

Synthèse

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

Verbes

Verbe	Objectif
permissions list	Répertorie les noms des autorisations accordées.
list	Répertoriez les rôles dans le locataire.
get	Récupérez un rôle avec ses autorisations accordées.
create	Créez un rôle (sans autorisations) au niveau de l’étendue Tenant ou Folder .
update (alias edit)	Ajoutez ou supprimez des autorisations sur un rôle.
delete	Supprimez un rôle créé par l'utilisateur.
users list	Répertoriez les utilisateurs affectés à un rôle.
users set	Ajouter ou supprimer des utilisateurs sur un rôle (en bloc).
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	Attribuez des rôles au niveau du dossier à un utilisateur dans un dossier spécifique.

uip or roles permissions list

Répertorie chaque nom d'autorisation accordable. Utilisez ces noms avec roles update --add-permissions.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--sort-by	Champ	Name asc	Tri OData.

Exemples

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

Format des données (--sortie 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.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--sort-by	Champ	Id desc	Tri OData.

Exemples

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

Format des données (--sortie json)

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

uip or roles get

Récupérez un rôle avec ses autorisations accordées.

Arguments

Nom	Requis	Objectif
<role-key>	oui	Role key (GUID). Use roles list to find it.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

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

Format des données (--sortie 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

Créez un rôle sans autorisations. Après la création, accordez des autorisations avec roles update --add-permissions.

Options

Short	Long	Valeur (Value)	Default	Description
—	--name	text	requis	Nom du rôle.
—	--type	Tenant | Folder	requis	Tenant applies across the tenant; Folder applies within folders.

Exemples

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'

Format des données (--sortie json)

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

uip or roles update

Ajoutez ou supprimez des autorisations sur un rôle. Lit les autorisations actuelles, active isGranted pour les noms dans --add-permissions / --remove-permissions et enregistre. Les nouveaux noms (pas encore sur le rôle) sont recherchés dans le catalogue complet des autorisations du locataire et ajoutés.

edit is a registered alias for this verb — uip or roles edit works identically to uip or roles update.

Arguments

Nom	Requis	Objectif
<role-key>	oui	Clé de rôle.

Options

Short	Long	Valeur (Value)	Default	Description
—	--add-permissions	CSV de noms	—	Autorisations à accorder.
—	--remove-permissions	CSV de noms	—	Autorisations à révoquer.

Au moins une des propriétés --add-permissions ou --remove-permissions est requise.

Exemples

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'

Format des données (--sortie json)

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

uip or roles delete

Supprimez un rôle créé par l'utilisateur. Les rôles intégrés (où IsStatic=true) ne peuvent pas être supprimés.

Arguments

Nom	Requis	Objectif
<role-key>	oui	Clé de rôle.

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	Required. Confirms this irreversible operation — the CLI never prompts.

Exemples

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

Format des données (--sortie json)

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

uip or roles users list

Répertoriez les utilisateurs affectés à un rôle.

Arguments

Nom	Requis	Objectif
<role-key>	oui	Clé de rôle.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.

Exemples

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'

Format des données (--sortie 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).

Arguments

Nom	Requis	Objectif
<role-key>	oui	Clé de rôle.

Options

Short	Long	Valeur (Value)	Default	Description
—	--add-user-keys	CSV de GUID	—	Utilisateurs à ajouter.
—	--remove-user-keys	CSV de GUID	—	Utilisateurs à supprimer.

Exemples

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'

Format des données (--sortie 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.

Arguments

Nom	Requis	Objectif
<principal-name>	oui	Username, group name, robot name, machine name, or external-app name to look up.

Options

Short	Long	Valeur (Value)	Default	Description
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Principal type. The DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication spellings are also accepted as aliases.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.

Exemples

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']"

Format des données (--sortie 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.

Arguments

Nom	Requis	Objectif
<username>	oui	Nom d'utilisateur à rechercher.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-path	Chemin d'accès	—	Show folder-level permissions for this folder instead of tenant-level.
—	--folder-key	GUID	—	Folder alternative to --folder-path.

Exemples

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

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

Format des données (--sortie 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 ou rôles attribués

Attribuer des rôles au niveau du dossier à un utilisateur. Utilisez uniquement les rôles de type Dossier. Nécessite --folder-path ou --folder-key.

Remarque :

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.

Options

Short	Long	Valeur (Value)	Default	Description
—	--user-key	GUID	requis	Clé d'utilisateur.
—	--role-keys	CSV de GUID	requis	GUID de rôle à attribuer dans le dossier.
—	--folder-path	Chemin d'accès	—	Dossier cible. Indiquez ceci ou --folder-key.
—	--folder-key	GUID	—	Dossier cible.

Exemples

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'

Format des données (--sortie json)

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

Codes de sortie

Voir Codes de sortie. Aucun remplacement spécifique au verbe.

Commandes associées

• uip or users — trouver des clés utilisateur; users assign-roles pour les attributions de rôle au niveau du locataire.
• uip or folders — l'emplacement des clés de dossier pour roles assign.

Voir également

• Options globales.
• Authentification.