uip 管理员组织和管理员组织租户

“uip admin Organization”和“uip admin Tenants”的语法和选项，用于管理调用者的组织、可配置的服务以及其中租户的生命周期。

uip admin organizations 读取并更新调用者的组织记录，检查异步 OMS（组织管理服务）操作，并管理组织级别的服务配置。uip admin tenants 管理该组织内租户的生命周期（创建、列出、获取、更新、软删除、启用/禁用）以及租户级别的服务配置。这两个命令组都是 uip admin（包 @uipath/admin-tool）的一部分，它直接在 admin 顶层命令上注册其所有子包的命令，无需进一步嵌套 — 实际调用始终为 uip admin <verb>。

概念

• 一次登录连接一个组织。此组中的任何位置都没有 <organization-id> 参数 — 每个命令都会从您当前的登录上下文解析组织。通过在不同的组织上再次登录来切换组织。
• “租户 ID”默认为您登录的租户。每个接受租户 ID 的tenants动词都接受将其作为可选的位置参数（或--tenant-id子命令中的services ）；省略它，并且该命令使用您的登录会话限定的租户。如果您的登录名未限定在任何租户范围内，并且您未传递一个限定值，则该命令将失败并显示明确错误，而不是静默猜测错误。
• 删除始终为软删除。tenants delete 软删除（可通过平台中其他位置的还原流程撤销）— 此组中的任何位置都没有 --hard 标志。
• 异步操作。tenants create 、 update和delete是异步的 — 它们立即返回operationId ；使用organizations operation get进行轮询。tenants enable/disable 和每个 services 动词都是同步的。
• 服务目录与已配置的服务。services list-available返回可配置的服务目录（组织或租户级别，可按区域筛选）； services list返回当前实际配置的内容。配置服务使用 services add/enable，而不是 create 动词。
• 客户端筛选。获取完整结果集后，多个列表/筛选器标志（--service、--region 上的 services list；--filter 、--environment 上的 tenants list）在客户端应用，即基础 OMS 端点没有服务器-适用于其中大多数的侧边筛选器。--status上的tenants list作为查询参数发送并在客户端重新应用，因为服务当前会忽略查询参数。
• 已过时的环境标签默认为Production 。在环境标签功能推出之前创建的租户 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>（覆盖该一次调用的交互式登录令牌生存期 — 很少需要）。

uip 管理员组织获取

获取调用者的组织记录。

选项

长	值	描述
--full	标记	在一次调用中返回内容更丰富的捆绑包（组织 + 租户 + 可用服务目录 + 徽标），而不是返回空白的组织记录。

示例

uip admin organizations get

uip admin organizations get --full

数据形状（--输出 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内联或--file <path>使用完整的UpdateOrganizationCommand正文。内联标志和 --file 互斥；在任何网络调用之前传递两者都不失败。

选项

长	值	描述
--name <name>	字符串	新显示名称。
--logical-name <name>	字符串	新逻辑名称（URL 缩略名）。
--language <code>	字符串	新的语言代码，例如en-US，fr-FR。
--file <path>	路径	完整的 UpdateOrganizationCommand JSON 正文。与内联标志互斥。

示例

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

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

数据形状（--输出 json）

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

UIP 管理员组织区域列表

列出可以为调用者的公司配置门户的区域。

示例

uip admin organizations regions list

数据形状（--输出 json）

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

UIP 管理员组织操作

检查异步 OMS 操作（tenants create/update/delete 返回 operationId 的类型）。

UIP 管理员组织操作获取

参数

名称	必填	用途
<operationId>	是	上一个异步调用返回的操作 UUID。

示例

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

数据形状（--输出 json）

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

UIP 管理员组织服务

管理组织级别的服务（配置、目录、状态）。

UIP Administrator 组织服务列表

列出当前配置的组织级别服务实例。

选项

长	值	描述
--service <type>	字符串	与 serviceType 完全匹配（例如orchestrator）。客户端筛选器。
--status <status>	枚举	服务实例状态的精确匹配。客户端筛选器。
--region <region>	枚举	服务实例区域精确匹配。客户端筛选器。

示例

uip admin organizations services list

数据形状（--输出 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

数据形状（--输出 json）

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

uip 管理员租户列表

列出调用者所在组织中的租户。在调用 get/update/delete 等之前，使用此方法可以按名称查找租户的 UUID。

选项

长	值	描述
--filter <fragment>	字符串	针对租户名称的不区分大小写的子字符串筛选器。客户端。
--service <type>	字符串	仅适用于已配置给定服务的租户。服务器端。
--status <status>	枚举：Enabled、Disabled、Updating、Failed、Maintenance、Deleted	仅限生命周期状态匹配的租户。作为查询参数发送，并在客户端重新应用，因为服务当前会忽略查询参数。
--environment <env>	枚举：Production、Staging、Development	仅限具有给定环境标签的租户。客户端；在筛选之前，缺失/为空标签默认为 Production。
--include-services	标记	在响应中包含每个租户的 services 数组。

示例

uip admin tenants list

uip admin tenants list --filter Default

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

数据形状（--输出 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 获取单个租户。

参数

名称	必填	用途
[tenant-id]	否	租户 UUID。默认为当前登录的租户。

示例

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

数据形状（--输出 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。

选项

长	值	描述
--name <name>	字符串	租户显示名称。在内联模式下为必需。
--region <region>	枚举	要在其中配置租户的区域。
--environment <env>	枚举：Production、Staging、Development	环境标签。
--file <path>	路径	完整的 CreateTenantRequestDto 正文 — 用于未内联公开的字段（services[]、customProperties、color、isDefaultTenant）。与内联标志互斥。

示例

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

数据形状（--输出 json）

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

uip 管理员租户更新

修补租户的可编辑字段。异步 — 轮询 operationId。

参数

名称	必填	用途
[tenant-id]	否	租户 UUID。默认为当前登录的租户。

选项

长	值	描述
--name <name>	字符串	新显示名称。
--region <region>	枚举	新区域。
--environment <env>	枚举	新环境标签。
--file <path>	路径	完整的 TenantUpdateDto 正文 — services{}、customProperties、color 需要。与内联标志互斥。

示例

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

数据形状（--输出 json）

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

uip 管理员租户删除

按 ID 软删除租户（可通过还原流程撤销）。异步 — 轮询 operationId。没有硬删除选项。

参数

名称	必填	用途
[tenant-id]	否	租户 UUID。默认为当前登录的租户。

示例

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

数据形状（--输出 json）

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

uip admin 租户启用/禁用

启用或禁用租户。同步（不同于 create/update/delete）。

参数

名称	必填	用途
[tenant-id]	否	租户 UUID。默认为当前登录的租户。

选项（仅禁用）

长	值	描述
--reason <text>	字符串	使用禁用操作记录的自由文本原因。

示例

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

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

数据形状（--输出 json）

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

Code 的 OmsTenantDisabled 为 disable。

uip admin 租户服务

管理租户级别的服务（配置、状态、按区域的目录）。所有动词都接受 --tenant-id <guid>，默认为当前登录的租户。

uip admin 租户服务列表

选项

长	值	描述
--tenant-id <guid>	GUID	目标租户。默认为登录租户。
--service <type>	字符串	与 serviceType 精确匹配。客户端。
--region <region>	枚举	区域精确匹配。客户端。

示例

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

数据形状（--输出 json）

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

uip admin 租户服务列表-可用

选项

长	值	必填	描述
--region <region>	枚举	是	要查询其服务目录的区域。

示例

uip admin tenants services list-available --region UnitedStates

数据形状（--输出 json）

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

uip admin Tenant 服务添加/删除

配置或软删除租户级别服务。同步。--service（单个）与 --file（多个，AddRemoveTenantServiceRequestDto 正文: { "services": { "<type>": true|false } }）互斥； a --file 为 add 必须具有每个值 true，而对于 remove 必须具有每个值 false — 不匹配的值会在调用之前导致客户端失败。

选项

长	值	描述
--tenant-id <guid>	GUID	目标租户。默认为登录租户。
--service <type>	字符串	要添加/删除的单个服务类型。
--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

数据形状（--输出 json）

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

Code 的 OmsTenantServicesRemoved 为 remove。

启用/禁用 uip admin Tenant 服务

启用或禁用一个租户级别的服务实例。同步。

选项

长	值	必填	描述
--tenant-id <guid>	GUID	否	目标租户。默认为登录租户。
--service <type>	字符串	是	服务类型标识符，例如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

数据形状（--输出 json）

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

Code 的 OmsTenantServiceDisabled 为 disable。

另请参阅

• 全局选项
• 退出代码