UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

utilisateurs de la plate-forme uip

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 gère l’attribution de packs de licences par utilisateur via le Comptabilité de licence, ainsi que les recharges consommables par utilisateur et les rapports d’utilisation des licences/consommables. Trois groupes de commandes indépendants se trouvent ici: licenses (attribution directe/groupe de bundles), top-ups (octroi et suivi des recharges consommables) et usage (consommation de licence par utilisateur).

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

GroupeVerbeObjectif
licensessetAffectez des licences de bundle d'utilisateur directement à un utilisateur de répertoire.
licensesgetRépertoriez les baux de location de bundles d'utilisateurs actuellement détenus par un utilisateur de l'annuaire, avec la source de chaque location.
licensesavailableObtenez le récapitulatif des licences au niveau du compte (total, alloué, disponible).
top-upscreateAccordez un rechargement à un utilisateur à partir du pool consommable actif de l'organisation.
top-upsgetVérifier le statut d'une tâche d'octroi de recharge.
top-upsrequestDemandez un rechargement pour vous-même; notifie les administrateurs de l'organisation.
usagelistLister les utilisateurs ayant des licences dans l’organisation.
usagegetAffichez l’utilisation de licences par utilisateur (la vôtre ou celle d’un administrateur affichant celle d’un autre utilisateur).

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

NomRequisObjectif
<user>ouiIdentifiant de l'utilisateur (nom ou préfixe de l'adresse e-mail; doit correspondre exactement à un utilisateur du répertoire).

Options

LongValeur (Value)DefaultDescription
--inputChemin d'accèsrequisChemin d'accès à un fichier JSON avec l'attribution de licences utilisateur souhaitée, par exemple [{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}].
--organizationID-Comptesession par défautGUID 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

NomRequisObjectif
<user>ouiIdentifiant de l'utilisateur (nom ou préfixe de l'adresse e-mail; doit correspondre exactement à un utilisateur du répertoire).

Options

LongValeur (Value)DefaultDescription
--organizationID-Comptesession par défautGUID 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

LongValeur (Value)DefaultDescription
--organizationID-Comptesession par défautGUID 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 }
  ]
}

recharges des utilisateurs de la plate-forme uip

Accordez et suivez les recharges consommables par utilisateur. Le pool source est résolu automatiquement à partir des consommables actifs de l'organisation (PLTU de préférence, sinon AGU) — vous ne transmettez jamais le pool explicitement.

création de recharges d'utilisateurs uip platform

Accordez un rechargement à un utilisateur.

Arguments
NomRequisObjectif
<user>ouiIdentifiant de l'utilisateur (nom ou préfixe de l'adresse e-mail; doit correspondre exactement à un utilisateur du répertoire).
Options
LongValeur (Value)DefaultDescription
--waitDrapeaudésactivéAttendez que la tâche de recharge soit terminée et signalez si elle a été accordée.
--countentier (1-100)1Nombre d'unités supplémentaires à accorder.
--organizationID-Comptesession par défautGUID du compte de l'organisation.
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
  }
}

les recharges des utilisateurs de la plate-forme uip obtiennent

Vérifier le statut d'une tâche d'octroi de recharge.

Arguments
NomRequisObjectif
<job-id>ouiID de tâche de recharge renvoyé par top-ups create.
Options
LongValeur (Value)DefaultDescription
--organizationID-Comptesession par défautGUID du compte de l'organisation.
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
  }
}

demande de recharges des utilisateurs de la plate-forme uip

Demandez un rechargement pour vous-même (l'utilisateur connecté). Cela en informe les administrateurs de votre organisation — cela n’accorde rien directement.

Options
LongValeur (Value)DefaultDescription
--organizationID-Comptesession par défautGUID du compte de l'organisation.
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."
  }
}

Un résultat autre queNotificationSent (par exemple NotEligible ou NoActiveDistribution) est renvoyé comme un échec avec le message du serveur.

Utilisation des utilisateurs de la plate-forme uip

Afficher la consommation de licences par utilisateur: pourcentage utilisé pour le pool mensuel et pourcentage utilisé pour le portefeuille complémentaire.

liste d'utilisation des utilisateurs de la plate-forme uip

Lister les utilisateurs ayant des licences dans l’organisation.

Options
LongValeur (Value)DefaultDescription
--limitIntegertaille de page par défautNombre maximal d'utilisateurs à renvoyer.
--offsetInteger0Nombre d'utilisateurs à ignorer.
--sort-byChampTrier par un champ de la ligne d'utilisation de l'utilisateur (par exemple email, displayName).
--sort-orderascdesc
--license-codescodes séparés par des espacesFiltrez sur les utilisateurs possédant des bundles de licences spécifiques (par exemple RPADEVPRONU ATTUNU).
--organizationID-Comptesession par défautGUID du compte de l'organisation.
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 est null (non 0) lorsque l'utilisateur ne dispose pas d'allocation mensuelle. status est l'un des MonthlyLimit, TopUp et PaidUnits.

utilisation des utilisateurs de la plate-forme uip obtenir

Afficher la consommation de licences utilisateur: le pourcentage mensuel consommé de chaque consommable, la date de réinitialisation, la répartition par service et le portefeuille de recharge, le cas échéant.

Arguments
NomRequisObjectif
[user]nonIdentifiant de l’utilisateur (nom ou préfixe d’e-mail). Omettez pour afficher la propre utilisation de l'utilisateur connecté; transmettez un (chemin d'administration) pour voir celui d'un autre utilisateur.
Options
LongValeur (Value)DefaultDescription
--organizationID-Comptesession par défautGUID du compte de l'organisation.
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.

  • uip platform groups — règles de groupe qui louent des bundles à plusieurs utilisateurs à la fois (celles-ci apparaissent avec source: "group" dans users licenses get).
  • uip platform tenants — Runtime au niveau du locataire et affectation des consommables.

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour