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 gère les utilisateurs d'Orchestrator au niveau du locataire. Les utilisateurs d'Orchestrator sont soutenus par le service d'identité — cet outil ne crée pas d'utilisateurs autonomes à partir de zéro. Au lieu de cela, users import fait référence à un principal d’annuaire IS existant (un utilisateur, un groupe, un compte Robot ou une application externe) et l’enregistre dans le locataire; users update modifie ensuite les propriétés côté locataire (licence, autorisations de session, informations d’identification non assistées) qui existent du côté Orchestrator. Il n'y a pas de users delete — la suppression de l'utilisateur est gérée via Identity Service ou le portail Orchestrator, pas cette CLI. Pour la gestion des rôles au niveau du dossier, consultez 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	Importez un principal d'annuaire Identity Service existant dans le locataire.
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)	Mettez à jour les propriétés côté locataire d'un utilisateur (sémantique PATCH).
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
  }
}

importation d’utilisateurs ou d’IU

Importez un principal d'annuaire — un utilisateur, un groupe, un compte Robot ou une application externe — dans ce locataire. C'est la seule façon dont cette CLI enregistre un nouvel utilisateur de locataire; il n’y a pas de « créer un utilisateur » autonome. car les utilisateurs d'Orchestrator sont toujours soutenus par un principal IS.

Référence un principal IS existant par --username ou --directory-id, plus --type pour déclarer de quel type de principal il s’agit (la CLI ne devine pas). Attribue éventuellement des rôles de dossier dans le même appel avec --folder-path/--folder-key et --role-keys — un dossier et des rôles doivent ou non être fournis ensemble. Les importations --directory-id sont idempotentes: l'importation d'un principal déjà importé par ID d'annuaire renvoie l'enregistrement du locataire existant au lieu d'échouer.

Les comptes Robot et les applications externes doivent être importés avec --directory-id (l'EST UUID) — Orchestrator ne peut pas les résoudre en <domain>\<name> comme il résout un utilisateur du répertoire. Recherchez l'ID avec uip admin robot-accounts list --search <name> ou uip admin external-apps list.

Arguments et identifiants requis

Nom	Requis	Objectif
--username	Un de --username/--directory-id	Nom d’utilisateur du service d’identité (généralement un e-mail).
--directory-id	Un de --username/--directory-id	Identifiant du répertoire du service d’identité (objet OIDC/IS UUID). Requis pour les types DirectoryRobot et DirectoryExternalApplication .

Options

Short	Long	Valeur (Value)	Default	Description
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	requis	Type principal du répertoire.
—	--domain	text	—	Nom de domaine du répertoire tel que configuré dans Identity Service. Uniquement nécessaire pour les environnements locaux avec des domaines AD configurés.
—	--folder-path	Chemin d'accès	—	Dossier auquel attribuer l'identifiant principal importé. Utiliser avec --role-keys.
—	--folder-key	GUID	—	Alternative de dossier à --folder-path. Utiliser avec --role-keys.
—	--role-keys	CSV de GUID	—	GUID du rôle de dossier à accorder. Nécessite une option de dossier; une option de dossier sans --role-keys est également rejetée.

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 est ajouté lorsque --directory-id correspond à un principal déjà présent dans le locataire.

UIP ou utilisateurs affecter

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

Remarque :

AVERTISSEMENT — irréversible sur les rôles. Si --role-keys est défini, le serveur remplace tous les rôles existants de l'utilisateur dans le dossier cible par ceux qui sont fournis. Les rôles non présents dans la charge utile sont supprimés en mode silencieux. Pour conserver les rôles 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	—	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

Supprime un utilisateur d'un dossier. L'utilisateur n'est pas supprimé: seule son affectation de dossier est supprimée.

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

mise à jour de l’UIP ou des utilisateurs

Mettez à jour les propriétés côté locataire d'un utilisateur par clé. Lit les valeurs actuelles, fusionne les champs fournis et enregistre. Indiquez au moins une option.

edit est un alias enregistré pour ce verbe - uip or users edit fonctionne de manière identique à uip or users update.

Modifiable en toute fiabilité: profil de licence, indicateurs de session et informations d'identification de l'Unattended Robot. Les attributs d'identité (--name, --surname, --email, --type) sont acceptés par l'API, mais pour les principaux d'annuaire (DirectoryUser/Group/Robot/ExternalApplication), ces champs sont normalement synchronisées depuis Identity Service — leur modification modifie ici uniquement la copie mise en cache côté Orchestrator et peut être écrasé lors de la prochaine synchronisation IS. Pour un changement d’identité permanent, modifiez directement le principal IS.

Cette commande n'expose pas les attributions de rôles — utilisez pour cela users assign (rôles de dossier) ou users assign-roles (rôles de locataire); la liste actuelle des rôles de locataire est toujours renvoyée inchangée de sorte qu'une mise à jour ne la affecte jamais.

Arguments

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

Options

Identité (Cache côté Orchestrator uniquement pour les principaux répertoires)

Long	Valeur (Value)	Description
--name	text	Nouveau prénom.
--surname	text	Nouveau nom de famille.
--email	text	Nouvelle adresse e-mail.
--type	text	Nouveau type d’utilisateur (par exemple User, DirectoryUser).

Autorisations de licence et de session

Long	Valeur (Value)	Description
--license-type	text	Par exemple 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	Compte Windows pour l’exécution Unattended (par exemple DOMAIN\user).
--unattended-password	text	Mot de passe ou, pour un magasin d'identifiants en lecture seule, nom de référence du secret externe.
--credential-store-key	GUID	Magasin d'informations d'identification pour les informations d'identification d'exécution unattended. Utilisez credential-stores list pour le trouver.
--credential-type	Default | SmartCard	Type d'informations d’identification.
--limit-concurrent / --no-limit-concurrent	Drapeau	Autorisez ou interdisez l’exécution simultanée sur plusieurs machines.

Si vous définissez un indicateur d'informations d'identification non assistées sur un utilisateur sans enregistrement UnattendedRobot existant, les deux --unattended-username et --unattended-password sont requis ensemble. Orchestrator supprime silencieusement un enregistrement incomplet, de sorte que la CLI refuse d'en soumettre un plutôt que de signaler un faux réussite. La modification d’un enregistrement existant accepte n’importe quel sous-ensemble de ces indicateurs.

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

Attribuer des rôles au niveau du locataire à un utilisateur.

Remarque :

AVERTISSEMENT — destructrice. Le serveur remplace la liste complète des rôles au niveau du locataire de l'utilisateur 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 locataire existants, lisez-les d'abord avec roles user-roles list <principal-name> --type <type> et transmettez l'union complète souhaitée à --role-keys. Contrairement à users assign (rôles au niveau du dossier), cela définit des rôles qui s’appliquent à l’ensemble du locataire.

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 — gérez les rôles, l'adhésion aux rôles des utilisateurs et l'inspection des autorisations principales (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.