UIP-Administratororganisationen & Mandanten

Syntax und Optionen für „uip admin organization“ und „uip admin tenants“, die die Organisation des Aufrufers, ihre bereitstellbaren Dienste und den Lebenszyklus der darin enthaltenen Mandanten verwalten.

uip admin organizations liest und aktualisiert den Organisationsdatensatz des Aufrufers, überprüft asynchrone OMS-Vorgänge (Organization Management Service) und verwaltet die Bereitstellung von Diensten auf Organisationsebene. uip admin tenants verwaltet den Lebenszyklus der Mandanten innerhalb dieser Organisation – erstellen, auflisten, abrufen, aktualisieren, vorläufig löschen, aktivieren/deaktivieren – sowie die Bereitstellung von Diensten auf Mandantenebene. Beide Befehlsgruppen sind Teil von uip admin (Paket @uipath/admin-tool), das alle Befehle seiner Unterpakete direkt auf dem admin -Befehl auf oberster Ebene ohne weitere Verschachtelung registriert – der echte Aufruf ist immer uip admin <verb>.

Konzepte

• Eine Organisation pro Anmeldung. Es gibt kein <organization-id> -Argument in dieser Gruppe – jeder Befehl löst die Organisation aus Ihrem aktuellen Anmeldekontext auf. Wechseln Sie die Organisation, indem Sie sich erneut bei einer anderen anmelden.
• Die Mandanten-ID ist standardmäßig der Mandant Ihrer Anmeldung. Jedes tenants -Verb, das eine Mandanten-ID annimmt, akzeptiert diese als optionales Positionsargument (oder --tenant-id in den services -Unterbefehlen); Lassen Sie es weg und der Befehl verwendet den Mandanten, auf den Ihre Anmeldesitzung beschränkt ist. Wenn Ihre Anmeldung keinem Mandanten zugeordnet ist und Sie keinen übergeben, schlägt der Befehl mit einem expliziten Fehler fehl, anstatt eine im Hintergrund zu erraten.
• Das Löschen ist immer Soft-. tenants delete löscht automatisch (über einen Wiederherstellungsflow an anderer Stelle auf der Plattform rückgängig zu machen) – es gibt kein --hard -Flag in dieser Gruppe.
• Asynchrone Vorgänge. tenants create, update und delete sind asynchron – sie geben sofort ein operationId zurück; Rufen Sie es mit organizations operation get. tenants enable/disable und jedes services -Verb sind synchron.
• Dienstkatalog vs. bereitgestellte Dienste. services list-available gibt den Katalog der Dienste zurück, die bereitgestellt werden könnten (auf Organisations- oder Mandantenebene, filterbar nach Region); services list gibt zurück, was gerade bereitgestellt wird. Beim Bereitstellen eines Dienstes wird services add/enable verwendet, kein create -Verb.
• Clientseitige Filterung. Mehrere Listen-/Filter-Flags (--service, --region auf services list; --filter, --environment auf tenants list) werden clientseitig angewendet, nachdem der vollständige Ergebnissatz abgerufen wurde – die zugrunde liegenden OMS-Endpunkte haben keinen Server – für die meisten davon Seitenfilter. --status in tenants list wird als Abfrageparameter gesendet und clientseitig erneut angewendet, da der Dienst den Abfrageparameter derzeit ignoriert.
• Veraltete Umgebungs-Tags sind standardmäßig Production. Mandanten, die vor der Auslieferung der Umgebungs-Tag-Funktion erstellt wurden, haben ein environment -NULL-Feld; tenants list/get normalisieren ihn vor der Rückgabe auf "Production", damit --environment -Filterung und nachgelagerte Verbraucher einen konsistenten Wert sehen.

Zusammenfassung

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>

Jedes Verb akzeptiert auch --login-validity <minutes> (überschreiben Sie die Lebensdauer des interaktiven Anmeldetokens für diesen einen Aufruf – selten erforderlich).

UIP-Administratororganisationen erhalten

Rufen Sie den Organisationsdatensatz des Anrufers ab.

Optionen

Long	Wert	Beschreibung
--full	Markieren	Geben Sie das umfassendere Paket (Organisation + Mandanten + verfügbarer Dienstkatalog + Logos) in einem Aufruf anstelle des leeren Organisationsdatensatzes zurück.

Beispiele

uip admin organizations get

uip admin organizations get --full

Datenform (--output 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": []
  }
}

Bei --full ist Data stattdessen { organization, tenants, services, logos }.

Aktualisierung der UIP-Administratororganisationen

Aktualisieren Sie bearbeitbare Felder der Organisation des Aufrufers: --name, --logical-name, --language inline oder --file <path> mit dem vollständigen UpdateOrganizationCommand -Text. Inline-Flags und --file schließen sich gegenseitig aus; Übergeben von beiden schlägt vor einem Netzwerkaufruf fehl.

Optionen

Long	Wert	Beschreibung
--name <name>	string	Neuer Anzeigename.
--logical-name <name>	string	Neuer logischer Name (URL-Slug).
--language <code>	string	Neuer Sprachcode, z. B en-US, fr-FR).
--file <path>	Pfad	Vollständiger UpdateOrganizationCommand JSON-Text. Sich gegenseitig mit den Inline-Flags ausschließen.

Beispiele

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

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

Datenform (--output json)

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

UIP-Administratororganisationen Regionen Liste

Listen Sie die Regionen auf, in denen das Unternehmen des Aufrufers bereitgestellt werden kann.

Beispiel

uip admin organizations regions list

Datenform (--output json)

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

Vorgang der UIP-Administratororganisation

Überprüfen Sie asynchrone OMS-Vorgänge (die Art tenants create/update/delete gibt ein operationId zurück).

Get-Vorgang für UIP-Administratororganisationen

Argumente

Name	Erforderlich	Zweck
<operationId>	ja	Vorgangs-UUID, die von einem früheren asynchronen Aufruf zurückgegeben wurde.

Beispiel

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

Datenform (--output json)

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

UIP-Administratororganisationsdienste

Verwalten Sie Dienste auf Organisationsebene (Bereitstellung, Katalog, Status).

Liste der UIP-Administratororganisationen Dienste

Listen Sie die derzeit bereitgestellten Dienstinstanzen auf Organisationsebene auf.

Optionen

Long	Wert	Beschreibung
--service <type>	string	Genaue Übereinstimmung bei serviceType (z. B. orchestrator). Clientseitiger Filter.
--status <status>	ENUM	Genaue Übereinstimmung des Status der Dienstinstanz. Clientseitiger Filter.
--region <region>	ENUM	Genaue Übereinstimmung mit der Region der Dienstinstanz. Clientseitiger Filter.

Beispiel

uip admin organizations services list

Datenform (--output json)

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

UIP-Administratororganisationsdienste-Liste verfügbar

Listen Sie den Katalog der Dienste auf, die auf Organisationsebene bereitgestellt werden können. Keine Optionen.

Beispiel

uip admin organizations services list-available

Datenform (--output json)

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

UIP-Administratormandantenliste

Listen Sie Mandanten in der Organisation des Aufrufers auf. Verwenden Sie dies, um die UUID eines Mandanten anhand des Namens zu suchen, bevor Sie get/update/delete/etc aufrufen.

Optionen

Long	Wert	Beschreibung
--filter <fragment>	string	Teilzeichenfolgefilter ohne Groß-/Kleinschreibung für Mandantenname. Clientseite.
--service <type>	string	Nur Mandanten, für die der angegebene Dienst bereitgestellt wurde. Serverseitig.
--status <status>	Aufzählung: Enabled, Disabled, Updating, Failed, Maintenance, Deleted	Nur Mandanten, deren Lebenszyklusstatus übereinstimmt. Als Abfrageparameter gesendet und clientseitig erneut angewendet, da der Dienst den Abfrageparameter derzeit ignoriert.
--environment <env>	Aufzählung: Production, Staging, Development	Nur Mandanten mit dem angegebenen Umgebungs-Tag. Clientseitig; fehlende/null-Tags werden vor dem Filtern standardmäßig auf Production festgelegt.
--include-services	Markieren	Fügen Sie das services -Array jedes Mandanten inline in die Antwort ein.

Beispiele

uip admin tenants list

uip admin tenants list --filter Default

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

Datenform (--output 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>"
    }
  ]
}

UIP-Administratormandanten abrufen

Rufen Sie einen einzelnen Mandanten nach ID ab.

Argumente

Name	Erforderlich	Zweck
[tenant-id]	nein	Mandanten-UUID. Standardmäßig der Mandant der aktuellen Anmeldung.

Beispiel

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

Datenform (--output 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": []
  }
}

UIP-Administratormandanten erstellen

Erstellen Sie einen Mandanten in der Organisation des Aufrufers. Asynchron – Rufen Sie die zurückgegebene operationId über organizations operation get ab.

Optionen

Long	Wert	Beschreibung
--name <name>	string	Anzeigename des Mandanten. Erforderlich im Inline-Modus.
--region <region>	ENUM	Region, in der der Mandant bereitgestellt werden soll.
--environment <env>	Aufzählung: Production, Staging, Development	Umgebungs-Tag.
--file <path>	Pfad	Vollständiger CreateTenantRequestDto -Text – erforderlich für Felder, die nicht inline verfügbar gemacht werden (services[], customProperties, color, isDefaultTenant). Sich gegenseitig mit den Inline-Flags ausschließen.

Beispiel

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

Datenform (--output json)

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

Aktualisierung der UIP-Administratormandanten

Patch-bearbeitbare Felder eines Mandanten. Asynchron – Abfrage operationId.

Argumente

Name	Erforderlich	Zweck
[tenant-id]	nein	Mandanten-UUID. Standardmäßig der Mandant der aktuellen Anmeldung.

Optionen

Long	Wert	Beschreibung
--name <name>	string	Neuer Anzeigename.
--region <region>	ENUM	Neue Region.
--environment <env>	ENUM	Neues Umgebungs-Tag.
--file <path>	Pfad	Vollständiger TenantUpdateDto -Text – erforderlich für services{}, customProperties, color. Sich gegenseitig mit den Inline-Flags ausschließen.

Beispiel

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

Datenform (--output json)

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

UIP-Administratormandanten löschen

Löschen Sie einen Mandanten nach ID (über den Wiederherstellungsablauf rückgängig gemacht). Asynchron – Abfrage operationId. Keine Option zum endgültigen Löschen.

Argumente

Name	Erforderlich	Zweck
[tenant-id]	nein	Mandanten-UUID. Standardmäßig der Mandant der aktuellen Anmeldung.

Beispiel

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

Datenform (--output json)

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

UIP-Administratormandanten aktivieren/deaktivieren

Aktivieren oder deaktivieren Sie einen Mandanten. Synchron (im Gegensatz zu create/update/delete).

Argumente

Name	Erforderlich	Zweck
[tenant-id]	nein	Mandanten-UUID. Standardmäßig der Mandant der aktuellen Anmeldung.

Optionen (nur deaktivieren)

Long	Wert	Beschreibung
--reason <text>	string	Freitext-Grund, der mit der Deaktivierungsaktion aufgezeichnet wurde.

Beispiele

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

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

Datenform (--output json)

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

Code ist OmsTenantDisabled für disable.

UIP-Administratormandantendienste

Verwalten Sie Dienste auf Mandantenebene (Bereitstellung, Status, Katalog pro Region). Alle Verben akzeptieren --tenant-id <guid> und verwenden standardmäßig den Mandanten der aktuellen Anmeldung.

Liste der UIP-Administratormandantendienste

Optionen

Long	Wert	Beschreibung
--tenant-id <guid>	GUID	Zielmandant. Standardmäßig beim Anmelden des Mandanten.
--service <type>	string	Genaue Übereinstimmung bei serviceType. Clientseite.
--region <region>	ENUM	Genaue Übereinstimmung der Region. Clientseite.

Beispiel

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

Datenform (--output json)

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

UIP-Administratormandantendienste-Liste verfügbar

Optionen

Long	Wert	Erforderlich	Beschreibung
--region <region>	ENUM	ja	Region, deren Dienstkatalog abgefragt werden soll.

Beispiel

uip admin tenants services list-available --region UnitedStates

Datenform (--output json)

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

UIP-Administrator-Mandantendienste hinzufügen/entfernen

Bereitstellen oder entfernen von Diensten auf Mandantenebene. Synchron. --service (einzeln) und --file (mehrere, AddRemoveTenantServiceRequestDto -Text: { "services": { "<type>": true|false } }) schließen sich gegenseitig aus; ein --file für add muss jeden Wert true haben, und für remove muss jeder Wert false sein – ein nicht übereinstimmender Wert schlägt auf der Clientseite vor dem Aufruf fehl.

Optionen

Long	Wert	Beschreibung
--tenant-id <guid>	GUID	Zielmandant. Standardmäßig beim Anmelden des Mandanten.
--service <type>	string	Einzelner Diensttyp zum Hinzufügen/Entfernen.
--file <path>	Pfad	AddRemoveTenantServiceRequestDto -Textkörper für mehrere Dienste.

Beispiele

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

Datenform (--output json)

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

Code ist OmsTenantServicesRemoved für remove.

UIP-Administratormandantendienste aktivieren/deaktivieren

Aktivieren oder deaktivieren Sie eine Dienstinstanz auf Mandantenebene. Synchron.

Optionen

Long	Wert	Erforderlich	Beschreibung
--tenant-id <guid>	GUID	nein	Zielmandant. Standardmäßig beim Anmelden des Mandanten.
--service <type>	string	ja	Bezeichner des Diensttyps, z. B. orchestrator).

Beispiele

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

Datenform (--output json)

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

Code ist OmsTenantServiceDisabled für disable.

Siehe auch

• Globale Optionen
• Exitcodes