uip ou utilisateurs

Syntaxe et options pour `uip ou users`, qui gère les utilisateurs du locataire Orchestrator et leurs attributions de dossiers et de rôles.

uip or users manages Orchestrator users at the tenant level. Orchestrator users are backed by Identity Service (IS) — this tool does not create standalone users from scratch. Instead, users import references an existing IS directory principal (a user, group, robot account, or external application) and provisions it into the tenant; users update then edits the tenant-side properties (license, session permissions, unattended credentials) that live on the Orchestrator side. There is no users delete — user removal is managed through Identity Service or the Orchestrator portal, not this CLI. For folder-level role management, see uip or roles.

Synthèse

uip or users list [options]
uip or users list-in-folder [--folder-path <path> | --folder-key <key>] [options]
uip or users list-available [--folder-path <path> | --folder-key <key>] [options]
uip or users get <user-key>
uip or users import (--username <name> | --directory-id <id>) --type <type> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users assign --user-key <key> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users unassign --user-key <key> [--folder-path <path> | --folder-key <key>]
uip or users update <user-key> [options]
uip or users current
uip or users assign-roles <user-key> --role-keys <keys>

Verbes

Verbe	Objectif
list	Répertoriez les utilisateurs du locataire avec des filtres facultatifs.
list-in-folder	Répertoriez les utilisateurs affectés à un dossier, avec leurs rôles au niveau du dossier.
list-available	Répertoriez les utilisateurs qui peuvent toujours être affectés à un dossier (pas encore affectés).
get	Récupérer un utilisateur par clé.
import	Import an existing Identity Service directory principal into the tenant.
assign	Affectez un utilisateur à un dossier, en option avec des rôles au niveau du dossier.
unassign	Supprime un utilisateur d'un dossier.
update (alias edit)	Update a user's tenant-side properties (PATCH semantics).
current	Renvoyez les détails de l’utilisateur actuellement authentifié.
assign-roles	Remplacez les attributions de rôles au niveau du locataire d'un utilisateur.

liste uip ou utilisateurs

Lister les utilisateurs dans le locataire. Renvoie la clé utilisateur, le nom d'utilisateur, le nom complet, l'e-mail, le type et le statut actif.

Options

Short	Long	Valeur (Value)	Default	Description
—	--key	GUID	—	Filtrer par clé utilisateur (correspondance exacte).
—	--username	text	—	Filtrer par nom d'utilisateur (contient la correspondance).
—	--email	text	—	Filtrer par adresse e-mail (contient une correspondance).
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--sort-by	Champ	—	Tri OData (par exemple, UserName asc).
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API au lieu du résumé sélectionné.

Exemples

uip or users list --limit 10
uip or users list --username admin
uip or users list --output-filter 'Data[].{key:Key, name:UserName}'

Format des données (--sortie json)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Email": "[e-mail]",
      "Type": "User",
      "IsActive": true
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0 }
}

uip ou utilisateurs - liste-in-dossier

Répertoriez les utilisateurs affectés à un dossier, avec leurs rôles au niveau du dossier. Nécessite --folder-path ou --folder-key.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-path	Chemin d'accès	—	Dossier cible. Indiquez ceci ou --folder-key.
—	--folder-key	GUID	—	Dossier cible. Indiquez ceci ou --folder-path.
—	--include-inherited	Drapeau	désactivé	Afficher également les utilisateurs hérités des dossiers parents.
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--sort-by	Champ	Id desc	Tri OData.
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API au lieu du résumé sélectionné.

Exemples

uip or users list-in-folder --folder-path "Shared"
uip or users list-in-folder --folder-path "Shared" --include-inherited
uip or users list-in-folder --folder-path "Shared" \
    --output-filter 'Data[].{name:UserName, roles:Roles}'

Format des données (--sortie json)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User",
      "IsInherited": false,
      "Roles": "Folder Administrator"
    }
  ]
}

UIP ou liste d'utilisateurs disponible

Répertoriez les utilisateurs du locataire qui peuvent toujours être affectés à un dossier. Utilisez les clés renvoyées avec users assign ou roles assign.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-path	Chemin d'accès	—	Dossier cible. Indiquez ceci ou --folder-key.
—	--folder-key	GUID	—	Dossier cible. Indiquez ceci ou --folder-path.
-s	--search	text	—	Filtrer par nom d'utilisateur (contient la correspondance).
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.

Exemples

uip or users list-available --folder-path "Shared"
uip or users list-available --folder-path "Shared" --search admin
uip or users list-available --folder-path "Shared" \
    --output-filter 'Data[].Key'

Format des données (--sortie json)

{
  "Code": "UserAvailableList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000003",
      "UserName": "[e-mail]",
      "Roles": ""
    }
  ]
}

uip ou utilisateurs obtenir

Récupérer un utilisateur par clé GUID.

Arguments

Nom	Requis	Objectif
<user-key>	oui	Clé d'utilisateur.

Options

Short	Long	Valeur (Value)	Default	Description
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API au lieu du résumé sélectionné.

Exemples

uip or users get d4e5f6a7-0000-0000-0000-000000000001
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --all-fields
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --output-filter 'Data.Email'

Format des données (--sortie json)

{
  "Code": "User",
  "Data": {
    "Key": "d4e5f6a7-0000-0000-0000-000000000001",
    "UserName": "[e-mail]",
    "FullName": "Admin User",
    "Email": "[e-mail]",
    "Type": "User",
    "IsActive": true
  }
}

uip or users import

Import a directory principal — an Identity Service user, group, robot account, or external application — into this tenant. This is the only way this CLI provisions a new tenant user; there is no standalone "create a user" verb, because Orchestrator users are always backed by an IS principal.

References an existing IS principal by --username or --directory-id, plus --type to declare which kind of principal it is (the CLI does not guess). Optionally assigns folder roles in the same call with --folder-path/--folder-key and --role-keys — both a folder and roles must be provided together, or neither. --directory-id imports are idempotent: importing an already-imported principal by directory ID returns the existing tenant record instead of failing.

Robot accounts and external applications must be imported with --directory-id (the IS UUID) — Orchestrator can't resolve them by <domain>\<name> the way it resolves a directory user. Find the ID with uip admin robot-accounts list --search <name> or uip admin external-apps list.

Arguments and required identifiers

Nom	Requis	Objectif
--username	one of --username/--directory-id	Identity Service username (typically an email).
--directory-id	one of --username/--directory-id	Identity Service directory identifier (OIDC subject / IS UUID). Required for DirectoryRobot and DirectoryExternalApplication types.

Options

Short	Long	Valeur (Value)	Default	Description
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	requis	Directory principal type.
—	--domain	text	—	Directory domain name as configured in Identity Service. Only needed for on-premises environments with configured AD domains.
—	--folder-path	Chemin d'accès	—	Folder to assign the imported principal to. Use with --role-keys.
—	--folder-key	GUID	—	Folder alternative to --folder-path. Use with --role-keys.
—	--role-keys	CSV de GUID	—	Folder role GUIDs to grant. Requires a folder option; a folder option without --role-keys is also rejected.

Exemples

uip or users import --username [e-mail]

uip or users import --username [e-mail] \
    --folder-path Shared --role-keys a1b2c3d4-0000-0000-0000-000000000001

# Robot account — directory ID required
uip or users import --directory-id 11111111-2222-3333-4444-555555555555 \
    --type DirectoryRobot

Format des données (--sortie json)

{
  "Code": "UserImported",
  "Data": {
    "UserName": "[e-mail]",
    "Type": "DirectoryUser",
    "AssignedFolderPath": "Shared",
    "AssignedRoleKeys": ["a1b2c3d4-0000-0000-0000-000000000001"]
  }
}

AlreadyImported: true is added when --directory-id matched a principal already present in the tenant.

UIP ou utilisateurs affecter

Affectez un utilisateur à un dossier, en option avec des rôles au niveau du dossier.

Remarque :

CAUTION — destructive on roles. If --role-keys is passed, the server replaces all of the user's existing roles in the target folder with the ones supplied — roles not in the payload are removed silently. To preserve existing 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	—	GUID du rôle de l'étendue du dossier.
—	--folder-path	Chemin d'accès	—	Dossier cible. Indiquez ceci ou --folder-key.
—	--folder-key	GUID	—	Dossier cible.

Exemples

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Format des données (--sortie json)

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

UIP ou utilisateurs désaffecter

Remove a user from a folder. The user is not deleted — only their folder assignment is removed.

Options

Short	Long	Valeur (Value)	Default	Description
—	--user-key	GUID	requis	Clé d'utilisateur.
—	--folder-path	Chemin d'accès	—	Dossier à partir duquel supprimer. Indiquez ceci ou --folder-key.
—	--folder-key	GUID	—	Dossier à partir duquel supprimer.

Exemples

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Format des données (--sortie json)

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

uip or users update

Update a user's tenant-side properties by key (GUID). Reads current values, merges the supplied fields, and saves. Provide at least one option.

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

Reliably editable: license profile, session flags, and unattended robot credentials. Identity attributes (--name, --surname, --email, --type) are accepted by the API, but for directory principals (DirectoryUser/Group/Robot/ExternalApplication) those fields are normally synced from Identity Service — changing them here only edits the Orchestrator-side cached copy and may be overwritten on the next IS sync. For a durable identity change, edit the IS principal directly.

This command does not expose role assignments — use users assign (folder roles) or users assign-roles (tenant roles) for that; the current tenant role list is always re-sent unchanged so an update never touches it.

Arguments

Nom	Requis	Objectif
<user-key>	oui	Clé d'utilisateur.

Options

Identity (Orchestrator-side cache only for directory principals)

Long	Valeur (Value)	Description
--name	text	New first name.
--surname	text	New last name.
--email	text	New email address.
--type	text	New user type (for example User, DirectoryUser).

License and session permissions

Long	Valeur (Value)	Description
--license-type	text	For example Attended, Unattended, StudioPro.
--allow-unattended / --deny-unattended	Drapeau	Autorisez ou refusez l’exécution de la tâche non assistée.
--allow-attended / --deny-attended	Drapeau	Autoriser ou refuser les sessions Attended.
--allow-login / --deny-login	Drapeau	Autoriser ou refuser la connexion à Orchestrator.
--allow-personal-workspace / --deny-personal-workspace	Drapeau	Autoriser ou refuser l’espace de travail personnel.
--active / --inactive	Drapeau	Activez ou désactivez l’utilisateur.

Informations d’identification d’exécution Unattended

Long	Valeur (Value)	Description
--unattended-username	text	Windows account for unattended execution (for example DOMAIN\user).
--unattended-password	text	Password, or — for a read-only credential store — the external secret reference name.
--credential-store-key	GUID	Credential store for unattended execution credentials. Use credential-stores list to find it.
--credential-type	Default | SmartCard	Credential type.
--limit-concurrent / --no-limit-concurrent	Drapeau	Autorisez ou interdisez l’exécution simultanée sur plusieurs machines.

If you set any unattended-credential flag on a user with no existing UnattendedRobot record, both --unattended-username and --unattended-password are required together — Orchestrator silently discards an incomplete record, so the CLI refuses to submit one rather than report a false success. Editing an existing record accepts any subset of these flags.

Exemples

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --email [e-mail]

uip or users update d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --inactive \
    --output-filter 'Data.Status'

Format des données (--sortie json)

{
  "Code": "UserUpdated",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000001", "Status": "Updated successfully" }
}

uip ou utilisateurs actuels

Renvoyez l’utilisateur actuellement authentifié. Utile pour vérifier la session et découvrir votre propre clé d'utilisateur.

Options

Short	Long	Valeur (Value)	Default	Description

Exemples

uip or users current
uip or users current --output-filter 'Data.Key'
uip or users current --output table

Format des données (--sortie json)

Même User forme que users get.

uip ou utilisateurs assignent-rôles

Assign tenant-level roles to a user.

Remarque :

CAUTION — destructive. The server replaces the user's entire tenant-level role list with the keys passed via --role-keys — roles not in the payload are removed silently. To preserve existing tenant roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. Unlike users assign (folder-level roles), this sets roles that apply across the entire tenant.

Arguments

Nom	Requis	Objectif
<user-key>	oui	Clé d'utilisateur.

Options

Short	Long	Valeur (Value)	Default	Description
—	--role-keys	CSV de GUID	requis	GUID de rôle à attribuer à l’étendue du locataire.

Exemples

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001,a1b2c3d4-0000-0000-0000-000000000002

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.RolesAssigned'

Format des données (--sortie json)

{
  "Code": "UserRolesAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "RolesAssigned": 1,
    "Status": "Assigned successfully"
  }
}

Codes de sortie

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

Commandes associées

• uip or roles — manage roles, role-user membership, and principal permission inspection (roles user-roles list, roles user-permissions list).
• uip or folders — recherchez des clés de dossier pour users assign / unassign.
• uip or jobs — en particulier jobs start --user-keys.

Voir également

• Authentification.
• Options globales.