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 gère les rôles et les autorisations d'Orchestrator. Les rôles regroupent les autorisations et sont attribués aux utilisateurs, aux groupes, aux robots, aux machines ou aux applications externes au niveau du locataire (globalement) ou du dossier (à l'échelle). Les verbes de cette page couvrent les rôles et leurs autorisations, l'appartenance à un rôle d'utilisateur, l'inspection du rôle/de l'autorisation au niveau principal et les affectations au niveau du dossier. Pour l’attribution de rôle au niveau du locataire par utilisateur, consultez users assign-roles dans 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	Répertoriez les attributions complètes de rôles d'un principal (utilisateur, groupe, robot, machine ou application externe) sur l'ensemble du locataire et de chaque dossier.
user-permissions list	Répertoriez les autorisations effectives d'un utilisateur, à l'échelle du locataire ou à l'échelle d'un dossier.
assign	Attribuez des rôles au niveau du dossier à un utilisateur dans un dossier spécifique.

liste des autorisations uip ou rôles

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

liste UIP ou rôles

Dressez la liste des rôles. Renvoie la clé, l'ID, le nom, le nom complet, le type et si le rôle est modifiable. Utilisez la clé de rôle avec roles get, roles update ou 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 ou rôles obtenir

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

Arguments

Nom	Requis	Objectif
<role-key>	oui	Clé de rôle. Utilisez roles list pour le trouver.

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 ou rôles créer

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 s'applique à l'ensemble du locataire; Folder s'applique dans les dossiers.

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

mise à jour de l’IU ou des rôles

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 est un alias enregistré pour ce verbe - uip or roles edit fonctionne de manière identique à 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" }
}

suppression de l’interface utilisateur ou des rôles

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	—	Requis. Confirme cette opération irréversible — la CLI ne s'affiche jamais.

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

liste des utilisateurs UIP ou rôles

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 ou rôles définis par les utilisateurs

Ajouter ou supprimer des utilisateurs sur un rôle (en bloc). Indiquez --add-user-keys, --remove-user-keys ou les deux. Au moins une est requise. Additif/soustractif uniquement - l'appartenance existante non nommée dans l'un ou l'autre des indicateurs n'est pas affectée (contrairement à users assign-roles, qui remplace la liste complète).

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 ou rôles liste des rôles de l'utilisateur

Répertoriez toutes les attributions de rôles pour un principal — un utilisateur, un groupe de répertoire, un robot de répertoire, une machine ou une application externe — dans le locataire et chaque dossier. Utile pour auditer le profil d'accès complet d'un principal.

Arguments

Nom	Requis	Objectif
<principal-name>	oui	Nom d'utilisateur, nom de groupe, nom de robot, nom de machine ou nom d'application externe à rechercher.

Options

Short	Long	Valeur (Value)	Default	Description
—	--type	User | Group | Robot | Machine | ExternalApplication	User	Type principal. Les orthographies DirectoryUser/DirectoryGroup/DirectoryRobot/DirectoryExternalApplication sont également acceptées comme alias.
-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 ou rôles liste des autorisations utilisateur

Lister les autorisations effectives d'un utilisateur. Sans option de dossier, affiche les rôles et les autorisations au niveau du locataire; avec --folder-path/--folder-key, affiche à la place les rôles et les autorisations accordés dans ce dossier spécifique. Renvoie l'union dé dupliquée des autorisations accordées par tous les rôles correspondants.

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-path	Chemin d'accès	—	Afficher les autorisations au niveau du dossier pour ce dossier plutôt qu’au niveau du locataire.
—	--folder-key	GUID	—	Alternative de dossier à --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)

Au niveau du locataire:

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

À l’échelle du dossier:

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

AVERTISSEMENT — irréversible sur les rôles. Le serveur remplace la liste complète des rôles de l'utilisateur au niveau du dossier pour le dossier cible par les clés transmises via --role-keys. Les rôles non présents dans la charge utile sont supprimés en mode silencieux. Pour conserver les rôles de dossier existants, lisez-les d'abord avec roles user-roles list <principal-name> --type <type> et transmettez l'union complète souhaitée à --role-keys. Pour une appartenance à un rôle au niveau du locataire sur un rôle, utilisez roles users set à la place.

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.