- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- uip coder
- uip context-grounding
- UiPath Docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- Tâches (Jobs)
- Dossiers
- Processus
- Paquets
- Machines
- Utilisateurs
- Rôles
- Licences
- Flux
- Pièces jointes (Attachments)
- Sessions
- Calendriers
- magasins d'informations d’identification
- journaux-audit
- paramètres
- Actifs
- Compartiments
- Compartiment-fichiers
- Bibliothèques
- Files d'attente (Queues)
- éléments de la file d'attente
- Déclencheurs (Triggers)
- Webhooks
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- get-library-object-repository
- get-object-repository
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- list-instances
- listes-exemples-workflow
- Créer un package
- Publier
- remote
- restore
- run, debug & execution
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- tm
- UIA
- uip tasks
- Traçages UIP
- uip traces feedback
- Migration
- Référence et assistance
Syntaxe et options pour `uip platform users`, qui gère l'attribution de bundle de licences par utilisateur via le compte de licence.
uip platform users manages per-user license-bundle allocation through the License Accountant, plus per-user consumable top-ups and license/consumable usage reporting. Three independent command groups live here: licenses (direct/group bundle allocation), top-ups (grant and track consumable top-ups), and usage (per-user license consumption).
Synthèse
uip platform users licenses <verb> [options] [<user>]
uip platform users top-ups <verb> [options]
uip platform users usage <verb> [options] [<user>]
uip platform users licenses <verb> [options] [<user>]
uip platform users top-ups <verb> [options]
uip platform users usage <verb> [options] [<user>]
Verbes
| Groupe | Verbe | Objectif |
|---|---|---|
licenses | set | Affectez des licences de bundle d'utilisateur directement à un utilisateur de répertoire. |
licenses | get | Répertoriez les baux de location de bundles d'utilisateurs actuellement détenus par un utilisateur de l'annuaire, avec la source de chaque location. |
licenses | available | Obtenez le récapitulatif des licences au niveau du compte (total, alloué, disponible). |
top-ups | create | Grant a top-up to a user from the organization's active consumable pool. |
top-ups | get | Check the status of a top-up grant job. |
top-ups | request | Request a top-up for yourself; notifies the organization's admins. |
usage | list | List users with license consumption in the organization. |
usage | get | Show per-user license consumption (your own, or an admin viewing another user's). |
Résolution de l'utilisateur
set et get prennent un argument positionnel <user> — un préfixe de nom ou d'e-mail. La CLI recherche les utilisateurs locaux et du répertoire avec une correspondance « commence par» et requiert exactement une correspondance:
- Aucune correspondance → erreur avec
"No directory user found matching '<input>'.". - Correspondances multiples → erreur répertoriant jusqu’à 10 candidats afin que vous puissiez affiner l’entrée.
jeu de licences utilisateurs uip platform
Attribuez des licences de bundle d'utilisateur à un utilisateur d'annuaire. Les bundles dans --input remplacent les bundles directement attribués à l'utilisateur; les bundles hérités des règles de groupe ne sont pas affectés par cette commande.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<user> | oui | Identifiant de l'utilisateur (nom ou préfixe de l'adresse e-mail; doit correspondre exactement à un utilisateur du répertoire). |
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--input | Chemin d'accès | requis | Chemin d'accès à un fichier JSON avec l'attribution de licences utilisateur souhaitée, par exemple [{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}]. |
--organization | ID-Compte | session par défaut | GUID du compte de l'organisation. Remplacer l’organisation résolue à partir de la connexion actuelle. |
Exemple
uip platform users licenses set "dan.dinu@uipath.com" \
--input ./user-bundles.json
uip platform users licenses set "dan.dinu@uipath.com" \
--input ./user-bundles.json
user-bundles.json :
[
{ "code": "RPADEVPRONU" },
{ "code": "ATTUNU" },
{ "code": "TSTNU" }
]
[
{ "code": "RPADEVPRONU" },
{ "code": "ATTUNU" },
{ "code": "TSTNU" }
]
Format des données (--sortie json)
{
"Code": "UserLicensesSet",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU" },
{ "code": "ATTUNU", "name": "ATTUNU" },
{ "code": "TSTNU", "name": "TSTNU" }
]
}
{
"Code": "UserLicensesSet",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU" },
{ "code": "ATTUNU", "name": "ATTUNU" },
{ "code": "TSTNU", "name": "TSTNU" }
]
}
Obtenir des licences utilisateur de la plate-forme uip
Obtenez les licences de bundle d'utilisateur actuellement locataires par un utilisateur d'annuaire. Chaque ligne correspond à un bundle locataire; source est "group" lorsque la location est héritée d'une règle de groupe, ou "direct" pour les attributions hors groupe.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<user> | oui | Identifiant de l'utilisateur (nom ou préfixe de l'adresse e-mail; doit correspondre exactement à un utilisateur du répertoire). |
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--organization | ID-Compte | session par défaut | GUID du compte de l'organisation. Remplacer l’organisation résolue à partir de la connexion actuelle. |
Exemple
uip platform users licenses get "dan.dinu@uipath.com"
uip platform users licenses get "dan.dinu@uipath.com"
Format des données (--sortie json)
{
"Code": "UserLicenses",
"Data": [
{
"source": "direct",
"code": "RPADEVPRONU",
"name": "RPADEVPRONU",
"leasedAt": "2026-04-15T10:30:00.000Z"
},
{
"source": "group",
"code": "ATTUNU",
"name": "ATTUNU",
"leasedAt": "2026-04-20T08:15:00.000Z"
}
]
}
{
"Code": "UserLicenses",
"Data": [
{
"source": "direct",
"code": "RPADEVPRONU",
"name": "RPADEVPRONU",
"leasedAt": "2026-04-15T10:30:00.000Z"
},
{
"source": "group",
"code": "ATTUNU",
"name": "ATTUNU",
"leasedAt": "2026-04-20T08:15:00.000Z"
}
]
}
les licences utilisateurs de la plate-forme uip sont disponibles
Obtenez le résumé au niveau du compte des licences de bundles d’utilisateurs: combien il existe de sièges par bundle (total), combien sont déjà attribués (allocated) et combien restent disponibles (available). Utilisez cette option avant l’attribution pour confirmer la capacité.
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--organization | ID-Compte | session par défaut | GUID du compte de l'organisation. Remplacer l’organisation résolue à partir de la connexion actuelle. |
Exemple
uip platform users licenses available
uip platform users licenses available
Format des données (--sortie json)
{
"Code": "UserLicensesAvailable",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU", "total": 100, "allocated": 42, "available": 58 },
{ "code": "ATTUNU", "name": "ATTUNU", "total": 50, "allocated": 50, "available": 0 }
]
}
{
"Code": "UserLicensesAvailable",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU", "total": 100, "allocated": 42, "available": 58 },
{ "code": "ATTUNU", "name": "ATTUNU", "total": 50, "allocated": 50, "available": 0 }
]
}
uip platform users top-ups
Grant and track per-user consumable top-ups. The source pool is resolved automatically from the organization's active consumables (PLTU preferred, else AGU) — you never pass the pool explicitly.
uip platform users top-ups create
Grant a top-up to a user.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<user> | oui | Identifiant de l'utilisateur (nom ou préfixe de l'adresse e-mail; doit correspondre exactement à un utilisateur du répertoire). |
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--wait | Drapeau | désactivé | Wait until the top-up job finishes and report whether it was granted. |
--count | integer (1-100) | 1 | Number of top-up units to grant. |
--organization | ID-Compte | session par défaut | Organization account GUID. |
Exemples
uip platform users top-ups create "jane.doe@example.com"
uip platform users top-ups create "jane.doe@example.com" --wait
uip platform users top-ups create "jane.doe@example.com" --count 5
uip platform users top-ups create "jane.doe@example.com"
uip platform users top-ups create "jane.doe@example.com" --wait
uip platform users top-ups create "jane.doe@example.com" --count 5
Format des données (--sortie json)
Sans --wait:
{
"Code": "TopUpStarted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "started",
"pool": "AGU",
"poolPercentConsumed": 42
}
}
{
"Code": "TopUpStarted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "started",
"pool": "AGU",
"poolPercentConsumed": 42
}
}
Avec --wait:
{
"Code": "TopUpCompleted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"pool": "AGU",
"poolPercentConsumed": 42,
"granted": true,
"rejectionReason": null
}
}
{
"Code": "TopUpCompleted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"pool": "AGU",
"poolPercentConsumed": 42,
"granted": true,
"rejectionReason": null
}
}
uip platform users top-ups get
Check the status of a top-up grant job.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<job-id> | oui | Top-up job id returned by top-ups create. |
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--organization | ID-Compte | session par défaut | Organization account GUID. |
Exemple
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
Format des données (--sortie json)
{
"Code": "TopUpStatus",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"granted": true,
"rejectionReason": null
}
}
{
"Code": "TopUpStatus",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"granted": true,
"rejectionReason": null
}
}
uip platform users top-ups request
Request a top-up for yourself (the logged-in user). This notifies your organization's admins — it does not grant anything directly.
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--organization | ID-Compte | session par défaut | Organization account GUID. |
Exemple
uip platform users top-ups request
uip platform users top-ups request
Format des données (--sortie json)
{
"Code": "TopUpRequested",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"outcome": "NotificationSent",
"message": "Your administrators have been notified."
}
}
{
"Code": "TopUpRequested",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"outcome": "NotificationSent",
"message": "Your administrators have been notified."
}
}
A non-NotificationSent outcome (for example NotEligible or NoActiveDistribution) is returned as a failure with the server's message.
uip platform users usage
View per-user license consumption: monthly pool percent-consumed and top-up wallet percent-consumed.
uip platform users usage list
List users with license consumption in the organization.
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--limit | Integer | default page size | Nombre maximal d'utilisateurs à renvoyer. |
--offset | Integer | 0 | Nombre d'utilisateurs à ignorer. |
--sort-by | Champ | — | Sort by a field of the user usage row (for example email, displayName). |
--sort-order | asc | desc | — |
--license-codes | space-separated codes | — | Filter to users holding specific license bundles (for example RPADEVPRONU ATTUNU). |
--organization | ID-Compte | session par défaut | Organization account GUID. |
Exemples
uip platform users usage list
uip platform users usage list --limit 50 --offset 50 --sort-by email --sort-order asc --license-codes RPADEVPRONU ATTUNU
uip platform users usage list
uip platform users usage list --limit 50 --offset 50 --sort-by email --sort-order asc --license-codes RPADEVPRONU ATTUNU
Format des données (--sortie json)
{
"Code": "UserUsageList",
"Data": [
{
"userId": "11111111-1111-1111-1111-111111111111",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"licenses": ["RPADEVPRONU"],
"strongestLicense": "RPADEVPRONU",
"monthlyPercentConsumed": 64,
"topUpWalletPercentConsumed": 20,
"topups": 2,
"status": "TopUp"
}
]
}
{
"Code": "UserUsageList",
"Data": [
{
"userId": "11111111-1111-1111-1111-111111111111",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"licenses": ["RPADEVPRONU"],
"strongestLicense": "RPADEVPRONU",
"monthlyPercentConsumed": 64,
"topUpWalletPercentConsumed": 20,
"topups": 2,
"status": "TopUp"
}
]
}
monthlyPercentConsumed is null (not 0) when the user has no monthly allowance. status is one of MonthlyLimit, TopUp, PaidUnits.
uip platform users usage get
Show per-user license consumption: each consumable's monthly percent consumed, reset date, per-service breakdown, and top-up wallet when present.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
[user] | non | User identifier (name or email prefix). Omit to show the logged-in user's own usage; pass one (admin path) to see another user's. |
Options
| Long | Valeur (Value) | Default | Description |
|---|---|---|---|
--organization | ID-Compte | session par défaut | Organization account GUID. |
Exemples
uip platform users usage get
uip platform users usage get "jane.doe@example.com"
uip platform users usage get
uip platform users usage get "jane.doe@example.com"
Format des données (--sortie json)
{
"Code": "UserUsage",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"consumables": [
{
"entitlement": "AgenticPool",
"monthlyPercentConsumed": 64,
"resetsOn": "2026-08-01T00:00:00.000Z",
"services": [
{ "service": "AgentDevelopment", "serviceName": "Agent Development", "percentOfPool": 40 }
],
"topUpWallet": {
"monthlyPercentConsumed": 20,
"topups": 2,
"firstGrantedOn": "2026-07-10T09:00:00.000Z",
"services": [],
"topupCountPerMonth": [
{ "month": "2026-07-01T00:00:00.000Z", "topupCount": 2 }
]
}
}
]
}
}
{
"Code": "UserUsage",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"consumables": [
{
"entitlement": "AgenticPool",
"monthlyPercentConsumed": 64,
"resetsOn": "2026-08-01T00:00:00.000Z",
"services": [
{ "service": "AgentDevelopment", "serviceName": "Agent Development", "percentOfPool": 40 }
],
"topUpWallet": {
"monthlyPercentConsumed": 20,
"topups": 2,
"firstGrantedOn": "2026-07-10T09:00:00.000Z",
"services": [],
"topupCountPerMonth": [
{ "month": "2026-07-01T00:00:00.000Z", "topupCount": 2 }
]
}
}
]
}
}
Codes de sortie
Voir Codes de sortie. Aucun remplacement spécifique au verbe.
Commandes associées
uip platform groups— règles de groupe qui louent des bundles à plusieurs utilisateurs à la fois (celles-ci apparaissent avecsource: "group"dansusers licenses get).uip platform tenants— Runtime au niveau du locataire et affectation des consommables.
Voir également
- Synthèse
- Verbes
- Résolution de l'utilisateur
- jeu de licences utilisateurs uip platform
- Arguments
- Options
- Exemple
- Format des données (--sortie json)
- Obtenir des licences utilisateur de la plate-forme uip
- Arguments
- Options
- Exemple
- Format des données (--sortie json)
- les licences utilisateurs de la plate-forme uip sont disponibles
- Options
- Exemple
- Format des données (--sortie json)
- uip platform users top-ups
- uip platform users top-ups create
- uip platform users top-ups get
- uip platform users top-ups request
- uip platform users usage
- uip platform users usage list
- uip platform users usage get
- Codes de sortie
- Commandes associées
- Voir également