uip ou utilisateurs

uip or users gère les utilisateurs d'Orchestrator au niveau du locataire - liste, création, modification et suppression d'utilisateurs, plus leur affectation à des dossiers et la gestion des affectations de rôle au niveau du locataire. Pour la gestion des rôles au niveau du dossier, consultez uip or roles.

Synthèse

uip or users <verb> [options]

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é.
create	Créer un nouvel utilisateur; vous pouvez éventuellement attribuer des rôles de locataire et définir des informations d'identification d'exécution Unattended.
delete	Supprimez un utilisateur par clé.
assign	Affectez un utilisateur à un dossier, en option avec des rôles au niveau du dossier.
unassign	Supprime un utilisateur d'un dossier.
edit	Modifier les propriétés de l’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.
—	--order-by	Champ	—	Tri OData (par exemple, UserName asc).
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API.

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, "HasMore": false }
}

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--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.
—	--order-by	Champ	Id desc	Tri OData.

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
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--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
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API.

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 ou utilisateurs créent

Créez un nouvel utilisateur de locataire. Seul --username est requis. L’API nécessite rolesList, donc --role-keys est efficacement requis dans la pratique — utilisez-le avec des GUID de rôle à l’échelle du locataire.

Options

Identité

Short	Long	Valeur (Value)	Default	Description
—	--username	text	requis	Nom d'utilisateur de connexion.
—	--name	text	—	Prénom.
—	--surname	text	—	Nom de famille.
—	--email	text	—	« [e-mail] ».
—	--type	ENUM	—	Type d'utilisateur (par exemple, User, DirectoryUser).
-t	--tenant	name	session par défaut	Remplacer le locataire.

Rôles et licences

Short	Long	Valeur (Value)	Default	Description
—	--role-keys	CSV de GUID	—	GUID de rôle à l'échelle du locataire (résolu par les noms de rôle pour la charge utile de l'API).
—	--license-type	ENUM	—	Par exemple, Attended, Unattended, StudioPro.

Autorisations de session (paires d'indicateurs)

Short	Long	Valeur (Value)	Default	Description
—	--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

Short	Long	Valeur (Value)	Default	Description
—	--unattended-username	text	—	Compte Windows (par exemple, DOMAIN\user).
—	--unattended-password	text	—	Mot de passe ou, pour les magasins d'identifiants en lecture seule, nom de référence du secret externe.
—	--credential-store-key	GUID	—	Magasin dʹidentifiants. Utilisez credential-stores list pour le trouver.
—	--credential-type	ENUM	—	Default ou SmartCard.
—	--limit-concurrent / --no-limit-concurrent	Drapeau	—	Autorisez ou interdisez l’exécution simultanée sur plusieurs machines.

Exemples

uip or users create --username [e-mail] --email [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users create --username [e-mail] --name Bot --surname Worker \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users create --username [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Key'

Format des données (--sortie json)

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

uip ou suppression d’utilisateurs

Supprimer définitivement un utilisateur du locataire.

Arguments

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

Options

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

Exemples

uip or users delete d4e5f6a7-0000-0000-0000-000000000010
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output-filter 'Data.Status'
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output plain

Format des données (--sortie json)

{
  "Code": "UserDeleted",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

UIP ou utilisateurs affecter

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

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

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

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

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

modification de l'interface utilisateur ou des utilisateurs

Modifiez un utilisateur par clé. Lit les valeurs actuelles, fusionne les champs fournis et enregistre. Indiquez au moins une option à mettre à jour.

Arguments

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

Options

Mêmes indicateurs que users create, à l'exception de --username (ne peut pas être modifié) et --role-keys (utilisez users assign-roles à la place). Toutes les paires d’indicateurs d’autorisation de session, le type de licence et les options d’informations d’identification Unattended s’appliquent.

Exemples

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

uip or users edit d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended

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

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. Cela remplace les rôles de locataire actuels de l’utilisateur. Utilisez roles set-role-users pour une appartenance supplémentaire au niveau du rôle.

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.
-t	--tenant	name	session par défaut	Remplacer le 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 et l'appartenance à un utilisateur rôle.
• 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.