UIP 管理者: 組織とテナント

「uip admin organizations」および「uip admin tenants」の構文とオプション。呼び出し元の組織、そのプロビジョニング可能なサービス、およびその中のテナントのライフサイクルを管理します。

uip admin organizations は、呼び出し元の組織レコードの読み取りと更新、非同期 OMS (組織管理サービス) 操作の検査、および組織レベルのサービス プロビジョニングの管理を行います。uip admin tenants 、その組織内のテナントのライフサイクル (作成、一覧表示、取得、更新、論理的な削除、有効化/無効化) に加えて、テナント レベルのサービス プロビジョニングを管理します。どちらのコマンドグループも uip admin (パッケージ @uipath/admin-tool) の一部であり、すべてのサブパッケージのコマンドを admin のトップ uip admin <verb>レベルコマンドに直接登録します。

概念

• ログインごとに 1 つの組織。このグループのどこにも <organization-id> 引数はありません。すべてのコマンドは、現在のログイン コンテキストから組織を解決します。別の組織に対して再度ログインして、組織を切り替えます。
• テナント ID は、既定でログインのテナントになります。テナント ID を受け取るすべての tenants 動詞は、テナント ID を任意の位置引数 (またはservicesサブコマンドの--tenant-id) として受け入れます。省略すると、コマンドはログイン セッションのスコープの対象となるテナントを使用します。ログインのスコープがどのテナントにも設定されておらず、どのテナントにも合格しない場合、コマンドはサイレントに推測するのではなく、明示的なエラーで失敗します。
• 削除は常にソフトです。tenants delete 論理的な削除 (プラットフォーム内の他の場所で復元フローを介して元に戻す可能) — このグループには --hard フラグがありません。
• 非同期操作。tenants create、update、およびdeleteは非同期であり、すぐにoperationIdを返します。organizations operation getでポーリングします。tenants enable/disable とすべての services 動詞は同期です。
• サービス カタログとプロビジョニングされたサービスservices list-available は、プロビジョニングできるサービスの カタログ を返します (組織レベルまたはテナント レベル、リージョン別にフィルター処理可能)。 services list は、現在 実際にプロビジョニングされている 内容を返します。サービスをプロビジョニングするには、create動詞ではなく services add/enableを使用します。
• クライアント側のフィルター処理すべての結果セットを取得した後、いくつかのリスト/フィルター フラグ (--service、 --region services list、 --filter、 --environment tenants list) がクライアント側で適用されます。基になる OMS エンドポイントには、これらのほとんどに対応するサーバー側のフィルターがありません。tenants list の--statusはクエリ パラメーターとして送信され、クライアント側で再適用されます。現在、サービスではクエリ パラメーターが無視されるためです。
• 古い環境タグは、既定で Productionに設定されます。環境タグ機能が出荷される前に作成されたテナントには、null の environment フィールドがあります。 tenants list/get を返す前に "Production" に正規化するため、 --environment フィルター処理と下流のコンシューマーには一貫した値が表示されます。

概要

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>

すべての動詞は --login-validity <minutes> も受け入れます (その 1 回の呼び出しの対話型ログイン トークンの有効期間を上書きします - 必要になることはほとんどありません)。

UIP 管理者組織は、以下を取得します。

呼び出し元の組織レコードを取得します。

オプション

長押し	値 (Value)	説明
--full	フラグ	裸の組織レコードではなく、より豊富なバンドル (組織 + テナント + 利用可能なサービス カタログ + ロゴ) を 1 回の呼び出しで返します。

例

uip admin organizations get

uip admin organizations get --full

データシェイプ(--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": []
  }
}

--fullでは、代わりに Data が{ organization, tenants, services, logos }されます。

UIP 管理者組織の更新

呼び出し元の組織の編集可能なフィールドを更新します。[--name]、[--logical-name]、[--languageインライン]、またはUpdateOrganizationCommand本文全体を含む--file <path>します。インライン フラグと --file は相互に排他的です。どちらもネットワーク呼び出しの前に失敗しません。

オプション

長押し	値 (Value)	説明
--name <name>	string	新しい表示名。
--logical-name <name>	string	新しい論理名 (URL スラッグ)。
--language <code>	string	新しい言語コード (例:en-US、 fr-FRです。
--file <path>	パス	完全な UpdateOrganizationCommand JSON 本文。インライン フラグと相互に排他的です。

例

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

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

データシェイプ(--output json)

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

UIP 管理組織のリージョンのリスト

発信者の会社に対してポータルをプロビジョニングできるリージョンをリストします。

例

uip admin organizations regions list

データシェイプ(--output json)

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

UIP 管理組織の操作

非同期 OMS 操作 (operationIdを返す tenants create/update/deleteの種類) を検査します。

uip admin organizations operation: get

引数

名前	Required	目的
<operationId>	○	前の非同期呼び出しから返された操作 UUID です。

例

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

データシェイプ(--output json)

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

UIP 管理組織サービス

組織レベルのサービス (プロビジョニング、カタログ、ステータス) を管理します。

UIP 管理組織のサービス リスト

現在プロビジョニングされている組織レベルのサービス インスタンスのリストを表示します。

オプション

長押し	値 (Value)	説明
--service <type>	string	serviceTypeの完全一致 (例:orchestrator)。クライアント側のフィルター。
--status <status>	ENUM	サービス インスタンスのステータスが完全に一致している。クライアント側のフィルター。
--region <region>	ENUM	サービス インスタンスのリージョンの完全一致。クライアント側のフィルター。

例

uip admin organizations services list

データシェイプ(--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 管理組織 サービス リスト - 利用可能

組織レベルでプロビジョニングできるサービスのカタログを一覧表示します。オプションはありません。

例

uip admin organizations services list-available

データシェイプ(--output json)

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

UIP 管理者のテナント リスト

呼び出し元の組織内のテナントのリストを取得します。これを使用して、テナントの UUID を名前で検索してから、 get/update/delete/etc を呼び出します。

オプション

長押し	値 (Value)	説明
--filter <fragment>	string	テナント名の部分文字列フィルターで大文字と小文字を区別しません。クライアント側。
--service <type>	string	特定のサービスがプロビジョニングされているテナントのみ。サーバー側。
--status <status>	列挙型: Enabled、 Disabled、 Updating、 Failed、 Maintenance、 Deleted	ライフサイクル ステータスが一致するテナントのみ。クエリ パラメーターとして送信 され 、クライアント側で再適用されます。現在、サービスではクエリ パラメーターが無視されるためです。
--environment <env>	列挙型: Production、 Staging、 Development	指定した環境タグを持つテナントのみ。クライアント側存在しない/null のタグは、フィルター処理前に既定で Production されます。
--include-services	フラグ	応答には、各テナントの services 配列をインラインで含めます。

例

uip admin tenants list

uip admin tenants list --filter Default

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

データシェイプ(--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 管理者テナントは、以下を取得します。

ID で単一のテナントを取得します。

引数

名前	Required	目的
[tenant-id]	×	テナントの UUID。既定では、現在のログインのテナントです。

例

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

データシェイプ(--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 管理者テナント 作成

呼び出し元の組織にテナントを作成します。非同期 — 返された operationId を organizations operation getでポーリングします。

オプション

長押し	値 (Value)	説明
--name <name>	string	テナントの表示名。インライン モードでは必須です。
--region <region>	ENUM	テナントをプロビジョニングするリージョンです。
--environment <env>	列挙型: Production、 Staging、 Development	環境タグ。
--file <path>	パス	完全な CreateTenantRequestDto 本文 — インラインで公開されていないフィールドに必要です (services[]、 customProperties、 color、 isDefaultTenant)。インライン フラグと相互に排他的です。

例

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

データシェイプ(--output json)

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

UIP 管理者テナントの更新

テナントの編集可能なフィールドにパッチを適用します。非同期 — ポーリング operationId。

引数

名前	Required	目的
[tenant-id]	×	テナントの UUID。既定では、現在のログインのテナントです。

オプション

長押し	値 (Value)	説明
--name <name>	string	新しい表示名。
--region <region>	ENUM	新しいリージョン。
--environment <env>	ENUM	新しい環境タグ。
--file <path>	パス	完全な TenantUpdateDto 本文 — services{}、 customProperties、 colorに必要です。インライン フラグと相互に排他的です。

例

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

データシェイプ(--output json)

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

UIP 管理者テナントの削除

ID によるテナントの論理的な削除 (復元フローで元に戻す可能)。非同期 — ポーリング operationId。物理的な削除オプションはありません。

引数

名前	Required	目的
[tenant-id]	×	テナントの UUID。既定では、現在のログインのテナントです。

例

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

データシェイプ(--output json)

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

UIP 管理者テナントの有効化/無効化

テナントを有効化または無効化します。同期 ( create/update/deleteとは異なります)。

引数

名前	Required	目的
[tenant-id]	×	テナントの UUID。既定では、現在のログインのテナントです。

オプション (無効化のみ)

長押し	値 (Value)	説明
--reason <text>	string	無効化アクションで記録されたフリーテキストの理由。

例

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

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

データシェイプ(--output json)

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

Code は disableに対してOmsTenantDisabledです。

UIP 管理テナント サービス

テナント レベルのサービス (プロビジョニング、ステータス、リージョンごとのカタログ) を管理します。すべての動詞は --tenant-id <guid>を受け入れ、既定では現在のログインのテナントになります。

UIP 管理者のテナント サービス リスト

オプション

長押し	値 (Value)	説明
--tenant-id <guid>	GUID	対象のテナント。既定値はログイン テナントです。
--service <type>	string	serviceTypeの完全一致。クライアント側。
--region <region>	ENUM	リージョンの完全一致。クライアント側。

例

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

データシェイプ(--output json)

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

uip admin tenants services list-available

オプション

長押し	値 (Value)	Required	説明
--region <region>	ENUM	○	クエリを実行するサービス カタログが存在するリージョンです。

例

uip admin tenants services list-available --region UnitedStates

データシェイプ(--output json)

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

UIP 管理、テナント サービス、追加/削除

テナント レベルのサービスをプロビジョニングまたは論理的に削除します。同期。--service (単一) と--file (複数、AddRemoveTenantServiceRequestDto本文: { "services": { "<type>": true|false } }) は相互に排他的です。add の--fileではすべての値が trueである必要があり、 remove のすべての値がfalseされている必要があります — 不一致の値があると、呼び出しの前にクライアント側で失敗します。

オプション

長押し	値 (Value)	説明
--tenant-id <guid>	GUID	対象のテナント。既定値はログイン テナントです。
--service <type>	string	追加/削除するサービスの種類は 1 つです。
--file <path>	パス	マルチサービス AddRemoveTenantServiceRequestDto 本体。

例

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

データシェイプ(--output json)

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

Code は removeに対してOmsTenantServicesRemovedです。

UIP 管理テナント サービスの有効化/無効化

テナント レベルのサービス インスタンスを 1 つ有効化または無効化します。同期。

オプション

長押し	値 (Value)	Required	説明
--tenant-id <guid>	GUID	×	対象のテナント。既定値はログイン テナントです。
--service <type>	string	○	サービスの種類の識別子 (例:orchestratorです。

例

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

データシェイプ(--output json)

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

Code は disableに対してOmsTenantServiceDisabledです。

参照

• グローバル オプション
• 終了コード