les organisations d’administrateur uip et amp; Locataires

Syntaxe et options pour les organisations `uip admin` et `uip admin tenants`, qui gèrent l'organisation de l'appelant, ses services enregistrables et le cycle de vie de ses locataires.

uip admin organizations lit et met à jour l'enregistrement de l'organisation de l'appelant, inspecte les opérations asynchrones OMS et gère l'enregistrement du service au niveau de l'organisation. uip admin tenants gère le cycle de vie des locataires au sein de cette organisation — création, liste, obtention, mise à jour, suppression réversible, activation/désactivation — plus l'enregistrement du service au niveau du locataire. Les deux groupes de commandes font partie de uip admin (package @uipath/admin-tool), qui enregistre toutes les commandes de ses sous-packages directement sur la commande de haut niveau admin sans imbrication supplémentaire - l'invocation réelle est toujours uip admin <verb>.

Concepts

• Une organisation par connexion. Il n'y a aucun argument <organization-id> nulle part dans ce groupe - chaque commande résout l'organisation à partir de votre contexte de connexion actuel. Changez d'organisations en vous reconnectant à une autre.
• L'ID de locataire est défini par défaut sur le locataire de votre connexion. Chaque verbe tenants qui prend un ID de locataire l'accepte comme argument positionnel facultatif (ou --tenant-id sur les sous-commandes services ); Omettez-le et la commande utilise le locataire auquel votre session de connexion est étendue. Si votre connexion n'est définie sur aucun locataire et que vous n'en transmettez pas un, la commande échoue avec une erreur explicite plutôt que de deviner en mode silencieux.
• La suppression est toujours temporaire. tenants delete suppressions réversibles (réversible via un flux de restauration ailleurs sur la plate-forme) — il n'y a aucun indicateur --hard nulle part dans ce groupe.
• Opérations asynchrones. tenants create, update et delete sont asynchrones - ils renvoient immédiatement une operationId ; interrogez-le avec organizations operation get tenants enable/disable et tous les services verbes sont synchrones.
• Catalogue de services vs. services enregistrés. services list-available renvoie le catalogue des services qui pourraient être enregistrés (au niveau de l’organisation ou du locataire, filtrable par région); services list renvoie ce qui est actuellement enregistré . L'enregistrement d'un service utilise services add/enable, et non un verbe create.
• Filtrage côté client. Plusieurs indicateurs de liste/filtre (--service, --region sur services list; --filter, --environment sur tenants list) sont appliqués côté client après avoir récupéré l'ensemble complet de résultats - les points de terminaison OMS sous-jacents n'ont pas de serveur - filtres secondaires pour la plupart d'entre eux. --status sur tenants list est envoyé en tant que paramètre de requête et réappliqué côté client, car le service ignore actuellement le paramètre de requête.
• Les balises d'environnement obsolètes sont définies par défaut Production. Les locataires créés avant l'expédition de la fonctionnalité de balise d'environnement ont un champ environment nul; tenants list/get la normalise sur "Production" avant de la revenir, afin que le filtrage --environment et les consommateurs en aval affichent une valeur cohérente.

Synthèse

uip admin organizations get [--full]
uip admin organizations update [--name <name>] [--logical-name <name>] [--language <code>] [--file <path>]
uip admin organizations regions list
uip admin organizations operation get <operationId>
uip admin organizations services list [--service <type>] [--status <status>] [--region <region>]
uip admin organizations services list-available

uip admin tenants list [--filter <fragment>] [--service <type>] [--status <status>] [--environment <env>] [--include-services]
uip admin tenants get [tenant-id]
uip admin tenants create [--name <name>] [--region <region>] [--environment <env>] [--file <path>]
uip admin tenants update [tenant-id] [--name <name>] [--region <region>] [--environment <env>] [--file <path>]
uip admin tenants delete [tenant-id]
uip admin tenants enable [tenant-id]
uip admin tenants disable [tenant-id] [--reason <text>]
uip admin tenants services list [--tenant-id <guid>] [--service <type>] [--region <region>]
uip admin tenants services list-available --region <region>
uip admin tenants services add [--tenant-id <guid>] [--service <type> | --file <path>]
uip admin tenants services remove [--tenant-id <guid>] [--service <type> | --file <path>]
uip admin tenants services enable [--tenant-id <guid>] --service <type>
uip admin tenants services disable [--tenant-id <guid>] --service <type>

Chaque verbe accepte également --login-validity <minutes> (remplacer la durée de vie du jeton de connexion interactive pour cet appel — rarement nécessaire).

organisations d’administrateur uip obtenir

Récupérer l'enregistrement de l'organisation de l'appelant.

Options

Long	Valeur (Value)	Description
--full	Drapeau	Retournez le bundle le plus enrichi (organisation + locataires + catalogue de services disponibles + logos) en un seul appel au lieu de l'enregistrement de l'organisation à barres.

Exemples

uip admin organizations get

uip admin organizations get --full

Format des données (--sortie json)

{
  "Code": "OmsOrganizationGet",
  "Data": {
    "id": "<org-guid>",
    "name": "Acme",
    "logicalName": "acme",
    "country": "US",
    "region": "UnitedStates",
    "status": "Active",
    "tenantsUrl": "https://cloud.uipath.com/acme",
    "language": "en-US",
    "createdOn": "<iso-date>",
    "organizationServiceInstances": []
  }
}

Avec --full, Data est { organization, tenants, services, logos } à la place.

mise à jour des organisations d’administrateur UiP

Mettez à jour les champs modifiables de l'organisation de l'appelant: --name, --logical-name, --language en ligne ou --file <path> avec le corps UpdateOrganizationCommand complet. Les indicateurs en ligne et --file sont mutuellement exclusifs; la transmission ne échoue avant aucun appel réseau.

Options

Long	Valeur (Value)	Description
--name <name>	string	Nouveau nom complet.
--logical-name <name>	string	Nouveau nom logique (champ de données dynamique d’URL).
--language <code>	string	Nouveau code de langue, par ex. en-US, fr-FR.
--file <path>	Chemin d'accès	Corps JSON UpdateOrganizationCommand complet. Capture mutuellement exclusive avec les indicateurs intégrés.

Exemples

uip admin organizations update --name "New Org Name"

uip admin organizations update --file ./org-patch.json

Format des données (--sortie json)

{ "Code": "OmsOrganizationUpdated", "Data": {} }

Liste des régions des organisations d’administrateur UiP

Répertoriez les régions dans lesquelles le portail peut être enregistré pour l’entreprise de l’appelant.

Exemple

uip admin organizations regions list

Format des données (--sortie json)

{ "Code": "OmsRegionsList", "Data": [{ "region": "UnitedStates" }, { "region": "Europe" }] }

opération des organisations d’administrateur UiP

Inspectez les opérations OMS asynchrones (de type tenants create/update/delete renvoie une operationId pour).

opération des organisations d’administrateur UiP

Arguments

Nom	Requis	Objectif
<operationId>	oui	UUID d'opération renvoyé d'un appel asynchrone précédent.

Exemple

uip admin organizations operation get 11111111-2222-3333-4444-555555555555

Format des données (--sortie json)

{
  "Code": "OmsOperationGet",
  "Data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "entityType": "Tenant",
    "entityId": "<entity-guid>",
    "operationStatus": "Completed",
    "errorMessage": null
  }
}

services des organisations d’administrateur UiP

Gérer les services au niveau de l’organisation (enregistrement, catalogue, statut).

liste des services des organisations d’administrateur UiP

Répertoriez les instances de service au niveau de l’organisation actuellement enregistrées.

Options

Long	Valeur (Value)	Description
--service <type>	string	Correspondance exacte sur serviceType (par ex. orchestrator). Filtre côté client.
--status <status>	ENUM	Correspondance exacte sur le statut de l’instance de service. Filtre côté client.
--region <region>	ENUM	Correspondance exacte sur la région de l’instance de service. Filtre côté client.

Exemple

uip admin organizations services list

Format des données (--sortie json)

{
  "Code": "OmsOrgServicesList",
  "Data": [
    {
      "id": "<service-instance-guid>",
      "serviceType": "orchestrator",
      "region": "UnitedStates",
      "status": "Enabled",
      "url": "https://cloud.uipath.com/acme/portal_",
      "isVisible": true
    }
  ]
}

Liste des services des organisations d'administrateur UIP-disponibles

Répertorie le catalogue de services qui peuvent être enregistrés au niveau de l’organisation. Aucune option.

Exemple

uip admin organizations services list-available

Format des données (--sortie json)

{
  "Code": "OmsOrgServicesAvailable",
  "Data": [
    {
      "id": "<service-guid>",
      "name": "orchestrator",
      "provisioningMode": "Implicit",
      "supportedRegions": ["UnitedStates", "Europe"],
      "defaultRegion": "UnitedStates",
      "isVisible": true,
      "isAlwaysProvision": false
    }
  ]
}

liste des locataires administrateur UiP

Répertorier les locataires dans l'organisation de l'appelant. Utilisez cette option pour rechercher l'UUID d'un locataire par nom avant d'appeler get/update/delete/ etc.

Options

Long	Valeur (Value)	Description
--filter <fragment>	string	Filtre de sous-chaînes insensible à la casse sur le nom du locataire. Côté client.
--service <type>	string	Uniquement les locataires pour lesquels le service concerné est enregistré. Côté serveur.
--status <status>	enum: Enabled, Disabled, Updating, Failed, Maintenance, Deleted	Uniquement les locataires dont le statut du cycle de vie correspond. Envoyé en tant que paramètre de requête et réappliqué côté client, car le service ignore actuellement le paramètre de requête.
--environment <env>	enum: Production, Staging, Development	Uniquement les locataires avec la balise d'environnement donnée. côté client; les balises manquantes/null sont définies par défaut sur Production avant le filtrage.
--include-services	Drapeau	Incluez le tableau services de chaque locataire en ligne dans la réponse.

Exemples

uip admin tenants list

uip admin tenants list --filter Default

uip admin tenants list --status Enabled --service orchestrator --include-services

Format des données (--sortie json)

{
  "Code": "OmsTenantsList",
  "Data": [
    {
      "id": "<tenant-guid>",
      "name": "DefaultTenant",
      "color": "#1f8feb",
      "region": "UnitedStates",
      "status": "Enabled",
      "tenantUrl": "https://cloud.uipath.com/acme/DefaultTenant",
      "environment": "Production",
      "isCanaryTenant": false,
      "createdBy": "<user-guid>",
      "createdOn": "<iso-date>"
    }
  ]
}

locataires d'administrateur UIP - Obtenir

Récupérez un locataire unique par ID.

Arguments

Nom	Requis	Objectif
[tenant-id]	non	UUID du locataire. La valeur par défaut est le locataire de la connexion actuelle.

Exemple

uip admin tenants get 11111111-2222-3333-4444-555555555555

Format des données (--sortie json)

{
  "Code": "OmsTenantGet",
  "Data": {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "DefaultTenant",
    "color": "#1f8feb",
    "region": "UnitedStates",
    "status": "Enabled",
    "tenantUrl": "https://cloud.uipath.com/acme/DefaultTenant",
    "environment": "Production",
    "isCanaryTenant": false,
    "createdBy": "<user-guid>",
    "createdOn": "<iso-date>",
    "updatedBy": "<user-guid>",
    "updatedOn": "<iso-date>",
    "tenantServiceInstances": []
  }
}

création de locataires d’administrateur uip

Créez un locataire dans l'organisation de l'appelant. Asynchrone: interrogez le operationId renvoyé via organizations operation get.

Options

Long	Valeur (Value)	Description
--name <name>	string	Nom complet du locataire. Obligatoire en mode en ligne.
--region <region>	ENUM	Région dans laquelle enregistrer le locataire.
--environment <env>	enum: Production, Staging, Development	Balise d'environnement.
--file <path>	Chemin d'accès	Corps CreateTenantRequestDto complet — nécessaire pour les champs non exposés en ligne (services[], customProperties, color, isDefaultTenant). Capture mutuellement exclusive avec les indicateurs intégrés.

Exemple

uip admin tenants create --file ./tenant.json

Format des données (--sortie json)

{
  "Code": "OmsTenantCreated",
  "Data": { "id": "<new-tenant-guid>", "name": "<name>", "status": "Updating", "operationId": "<operation-guid>" }
}

mise à jour des locataires d’administrateur UiP

Corrigez les champs modifiables d'un locataire. Asynchrone — interrogation operationId.

Arguments

Nom	Requis	Objectif
[tenant-id]	non	UUID du locataire. La valeur par défaut est le locataire de la connexion actuelle.

Options

Long	Valeur (Value)	Description
--name <name>	string	Nouveau nom complet.
--region <region>	ENUM	Nouvelle région.
--environment <env>	ENUM	Nouvelle balise d’environnement.
--file <path>	Chemin d'accès	Corps TenantUpdateDto complet — nécessaire pour services{}, customProperties, color. Capture mutuellement exclusive avec les indicateurs intégrés.

Exemple

uip admin tenants update 11111111-2222-3333-4444-555555555555 --file ./tenant-patch.json

Format des données (--sortie json)

{ "Code": "OmsTenantUpdated", "Data": { "operationId": "<operation-guid>" } }

suppression de locataires d’administrateur UIP

Effectuez la suppression réversible d'un locataire par ID (réversible via le flux de restauration). Asynchrone — interrogation operationId. Aucune option de suppression définitive.

Arguments

Nom	Requis	Objectif
[tenant-id]	non	UUID du locataire. La valeur par défaut est le locataire de la connexion actuelle.

Exemple

uip admin tenants delete 11111111-2222-3333-4444-555555555555

Format des données (--sortie json)

{ "Code": "OmsTenantDeleted", "Data": { "operationId": "<operation-guid>" } }

l'activation/la désactivation des locataires d'administration uip

Activer ou désactiver un locataire. Synchronisable (contrairement à create/update/delete).

Arguments

Nom	Requis	Objectif
[tenant-id]	non	UUID du locataire. La valeur par défaut est le locataire de la connexion actuelle.

Options (désactiver uniquement)

Long	Valeur (Value)	Description
--reason <text>	string	Raison en texte libre enregistrée avec l'action de désactivation.

Exemples

uip admin tenants enable 11111111-2222-3333-4444-555555555555

uip admin tenants disable 11111111-2222-3333-4444-555555555555 --reason "scheduled maintenance"

Format des données (--sortie json)

{ "Code": "OmsTenantEnabled", "Data": {} }

Code est OmsTenantDisabled pour disable.

services des locataires administrateur UiP

Gérer les services au niveau du locataire (enregistrement, statut, catalogue par région). Tous les verbes acceptent --tenant-id <guid>, la valeur par défaut étant le locataire de la connexion actuelle.

liste des services des locataires d’administrateur UiP

Options

Long	Valeur (Value)	Description
--tenant-id <guid>	GUID	Locataire cible. La valeur par défaut est l'identifiant du locataire.
--service <type>	string	Correspondance exacte sur serviceType. Côté client.
--region <region>	ENUM	Correspondance exacte sur la région. Côté client.

Exemple

uip admin tenants services list --tenant-id 11111111-2222-3333-4444-555555555555

Format des données (--sortie json)

{
  "Code": "OmsTenantServicesList",
  "Data": [
    { "serviceType": "orchestrator", "region": "UnitedStates", "organizationId": "<org-guid>", "serviceInstanceSettings": {}, "licenseList": [] }
  ]
}

Services locataires administrateur UiPath - Liste-disponibles

Options

Long	Valeur (Value)	Requis	Description
--region <region>	ENUM	oui	Région dont le catalogue de services doit interroger.

Exemple

uip admin tenants services list-available --region UnitedStates

Format des données (--sortie json)

{
  "Code": "OmsTenantServicesAvailable",
  "Data": [
    { "id": "<service-guid>", "name": "orchestrator", "provisioningMode": "Implicit", "supportedRegions": ["UnitedStates"], "defaultRegion": "UnitedStates", "isVisible": true, "isAlwaysProvision": false }
  ]
}

services de locataires uip admin ajouter/supprimer

Enregistrer ou supprimer temporairement les services au niveau des locataires. Synchroniser. --service et --file (multiple, AddRemoveTenantServiceRequestDto corps: { "services": { "<type>": true|false } }) sont mutuellement exclusifs; un --file pour add doit avoir chaque valeur true, et pour remove, chaque valeur false — une valeur non correspondante échoue côté client avant l'appel.

Options

Long	Valeur (Value)	Description
--tenant-id <guid>	GUID	Locataire cible. La valeur par défaut est l'identifiant du locataire.
--service <type>	string	Type de service unique à ajouter/supprimer.
--file <path>	Chemin d'accès	Corps AddRemoveTenantServiceRequestDto multiservice.

Exemples

uip admin tenants services add --tenant-id 11111111-2222-3333-4444-555555555555 --service orchestrator

uip admin tenants services remove --tenant-id 11111111-2222-3333-4444-555555555555 --file ./remove-services.json

Format des données (--sortie json)

{ "Code": "OmsTenantServicesAdded", "Data": {} }

Code est OmsTenantServicesRemoved pour remove.

Activation/désactivation des services des locataires d’administrateur UIP

Activez ou désactivez une instance de service au niveau du locataire. Synchroniser.

Options

Long	Valeur (Value)	Requis	Description
--tenant-id <guid>	GUID	non	Locataire cible. La valeur par défaut est l'identifiant du locataire.
--service <type>	string	oui	Identifiant du type de service, par exemple orchestrator.

Exemples

uip admin tenants services enable --tenant-id 11111111-2222-3333-4444-555555555555 --service orchestrator

uip admin tenants services disable --tenant-id 11111111-2222-3333-4444-555555555555 --service orchestrator

Format des données (--sortie json)

{ "Code": "OmsTenantServiceEnabled", "Data": {} }

Code est OmsTenantServiceDisabled pour disable.

Voir également

• Options globales
• Codes de sortie