UIP ou rôles

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 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 utilisateur rôle 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 <verb> [options]

Verbes

Verbe	Objectif
list-permissions	Répertorie les noms des autorisations accordées.
list-roles	Répertoriez les rôles dans le locataire.
get-role	Récupérez un rôle avec ses autorisations accordées.
create-role	Créez un rôle (sans autorisations) au niveau de l’étendue Tenant ou Folder .
edit-role	Ajoutez ou supprimez des autorisations sur un rôle.
delete-role	Supprimez un rôle créé par l'utilisateur.
list-role-users	Répertoriez les utilisateurs affectés à un rôle.
set-role-users	Ajouter ou supprimer des utilisateurs sur un rôle (en bloc).
list-user-roles	Affichez les attributions de rôles complètes d'un utilisateur pour l'ensemble du locataire et de chaque dossier.
assign	Attribuez des rôles au niveau du dossier à un utilisateur dans un dossier spécifique.

uip ou rôles - liste-autorisations

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

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	Name asc	Tri OData.

Exemples

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

Format des données (--sortie json)

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

uip ou rôles - liste-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.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	Id desc	Tri OData.

Exemples

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

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 get-role

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

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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

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 create-role

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

Options

Short	Long	Valeur (Value)	Default	Description
—	--name	text	requis	Nom du rôle.
—	--type	ENUM	requis	Tenant (s'applique à l'ensemble du locataire) ou Folder (s'applique aux dossiers).
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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'

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 ou rôles edit-role

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.

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.
-t	--tenant	name	session par défaut	Remplacer le locataire.

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

Exemples

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'

Format des données (--sortie json)

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

uip ou rôles Delete-role

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
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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

Format des données (--sortie json)

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

uip ou rôles list-role-users

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.

Exemples

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'

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 set-role-users

Ajouter ou supprimer des utilisateurs sur un rôle (en bloc). Fournissez --add-user-keys, --remove-user-keys ou les deux. Au moins une est requise.

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.
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

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'

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

Répertoriez toutes les attributions de rôle pour un utilisateur sur l'ensemble du locataire et de chaque dossier. Utile pour auditer le profil d'accès complet d'un utilisateur.

Arguments

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

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.

Exemples

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

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

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.
-t	--tenant	name	session par défaut	Remplacer le locataire.

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.