organizações de administrador da UIP e; Tenants

Sintaxe e opções para "organizações de administrador do UIP" e "tenants de administrador do uip", que gerenciam a organização do chamador, seus serviços provisionáveis e o ciclo de vida dos tenants dentro dela.

uip admin organizations lê e atualiza o registro da organização do chamador, inspeciona operações assíncronas do OMS (Organization Management Service) e gerencia o provisionamento de serviços no nível da organização. uip admin tenants gerencia o ciclo de vida de tenants dentro dessa organização — criar, listar, obter, atualizar, excluir automaticamente, habilitar/desabilitar — além do provisionamento de serviços no nível do tenant. Ambos os grupos de comando fazem parte do uip admin (pacote @uipath/admin-tool), que registra todos os comandos de seus subpacotes diretamente no comando de nível superior admin sem aninhamento adicional — a invocação real é sempre uip admin <verb>.

Conceitos

• Uma organização por login. Não há argumento <organization-id> em nenhum lugar desse grupo — cada comando resolve a organização a partir de seu contexto de login atual. Para mudar de organização, faça login novamente em uma organização diferente.
• O ID do tenant usa o tenant do seu login. Cada verbo tenants que recebe um ID de tenant o aceita como um argumento posicional opcional (ou --tenant-id nos subcomandos services ); omita-o e o comando usa o tenant para o qual sua sessão de logon está no escopo. Se seu login não estiver com escopo para nenhum tenant e você não passar um, o comando falhará com um erro explícito em vez de suposições silenciosas.
• A exclusão é sempre suave. exclusões reversíveis tenants delete (reversíveis por meio de um fluxo de restauração em outro lugar da plataforma) — não há sinalizador --hard neste grupo.
• Operações assíncronas. tenants create, update e delete são assíncronos — eles retornam um operationId imediatamente; pesquise com organizations operation get. tenants enable/disable e cada verbo services são síncronos.
• Catálogo de serviços versus serviços provisionados. services list-available o catálogo de serviços que poderiam ser provisionados (no nível da organização ou do tenant, filtráveis por região); services list retorna o que está realmente provisionado no momento. O provisionamento de um serviço usa services add/enable, não um verbo create.
• Filtragem do lado do cliente. Vários sinalizadores de lista/filtro (--service, --region em services list; --filter, --environment em tenants list) são aplicados no lado do cliente após buscar o conjunto de resultados completo — os pontos de extremidade do OMS subjacentes não têm servidor filtros laterais para a maioria deles. --status em tenants list é enviado como um parâmetro de consulta e reaplicado no lado do cliente, porque o serviço atualmente ignora o parâmetro de consulta.
• Tags de ambiente obsoletos têm o padrão de Production. Os tenants criados antes do envio da funcionalidade de tag de ambiente têm um campo environment nulo; tenants list/get normaliza-o para "Production" antes de retornar, para que a filtragem --environment e os consumidores downstream vejam um valor consistente.

Resumo

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>

Cada verbo também aceita --login-validity <minutes> (substitua o tempo de vida do token de login interativo para essa chamada — raramente necessário).

organizações de administrador do uip obter

Busca o registro da organização do chamador.

Opções

Long	Valor	Description
--full	Bandeira	Retorne o pacote mais rico (organização + tenants + catálogo de serviços disponíveis + logotipos) em uma chamada, em vez do registro da organização apenas.

Exemplos

uip admin organizations get

uip admin organizations get --full

Formato dos dados (--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": []
  }
}

Com --full, Data é { organization, tenants, services, logos } em vez disso.

atualização das organizações de administrador do uip

Atualize os campos editáveis da organização do chamador: --name, --logical-name, --language em linha ou --file <path> com o corpo completo UpdateOrganizationCommand. Os sinalizadores incorporados e --file são mutuamente exclusivos; passar nenhum dos dois falha antes de qualquer chamada de rede.

Opções

Long	Valor	Description
--name <name>	String	Novo nome de exibição.
--logical-name <name>	String	Novo nome lógico (campo de dados dinâmico da URL).
--language <code>	String	Novo código de idioma, por exemplo en-US, fr-FR.
--file <path>	Path	Corpo UpdateOrganizationCommand JSON completo. Exclusivo mutuamente com os sinalizadores incorporados.

Exemplos

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

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

Formato dos dados (--output json)

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

administrador organizações regiões listar uip

Lista as regiões em que o portal pode ser provisionado para a empresa do chamador.

Exemplo

uip admin organizations regions list

Formato dos dados (--output json)

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

operação das organizações de administrador do uip

Inspecione operações assíncronas do OMS (o tipo tenants create/update/delete retorna um operationId para).

operação de organizações de administrador do uip obter

Argumentos

Name	Required	Finalidade
<operationId>	sim	UUID da operação retornada de uma chamada assíncrona anterior.

Exemplo

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

Formato dos dados (--output json)

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

serviços de organizações de administrador do uip

Gerenciar serviços no nível da organização (provisionamento, catálogo, status).

lista de serviços das organizações de administrador do uip

Lista as instâncias de serviço no nível da organização provisionadas atualmente.

Opções

Long	Valor	Description
--service <type>	String	Correspondência exata em serviceType (por exemplo orchestrator). Filtro do lado do cliente.
--status <status>	ENUM	Correspondência exata no status da instância do serviço. Filtro do lado do cliente.
--region <region>	ENUM	Correspondência exata na região da instância do serviço. Filtro do lado do cliente.

Exemplo

uip admin organizations services list

Formato dos dados (--output json)

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

organizações de administrador do uip lista de serviços disponíveis

Lista o catálogo de serviços que podem ser provisionados no nível da organização. Sem opções.

Exemplo

uip admin organizations services list-available

Formato dos dados (--output json)

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

lista de tenants de administrador do uip

Liste tenants na organização do chamador. Use isso para pesquisar o UUID de um tenant por nome antes de chamar get/update/delete/ etc.

Opções

Long	Valor	Description
--filter <fragment>	String	Filtro de substring que não diferencia maiúsculas de minúsculas no nome do tenant. No lado do cliente.
--service <type>	String	Apenas tenants que tenham o serviço fornecido provisionado. No lado do servidor.
--status <status>	enum: Enabled, Disabled, Updating, Failed, Maintenance, Deleted	Apenas tenants com correspondências de status de ciclo de vida. Enviado como um parâmetro de consulta e reaplicado do lado do cliente, pois o serviço atualmente ignora o parâmetro de consulta.
--environment <env>	enum: Production, Staging, Development	Apenas tenants com a tag de ambiente fornecida. No lado do cliente; tags ausentes/nulas têm o padrão de Production antes da filtragem.
--include-services	Bandeira	Inclua a matriz services de cada tenant embutida na resposta.

Exemplos

uip admin tenants list

uip admin tenants list --filter Default

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

Formato dos dados (--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>"
    }
  ]
}

tenants de administrador do uip obter

Buscar um único tenant por ID.

Argumentos

Name	Required	Finalidade
[tenant-id]	não	UUID do tenant. O padrão é o tenant do login atual.

Exemplo

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

Formato dos dados (--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": []
  }
}

tenants de administrador do uip criar

Crie um tenant na organização do chamador. Assíncrono — pesquise o operationId retornado por meio de organizations operation get.

Opções

Long	Valor	Description
--name <name>	String	Nome de exibição do tenant. Necessário no modo em linha.
--region <region>	ENUM	Região na qual provisionar o tenant.
--environment <env>	enum: Production, Staging, Development	Tag do ambiente.
--file <path>	Path	Corpo completo CreateTenantRequestDto — necessário para campos não expostos em linha (services[], customProperties, color, isDefaultTenant). Exclusivo mutuamente com os sinalizadores incorporados.

Exemplo

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

Formato dos dados (--output json)

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

Atualização de tenants do administrador do uip

Corrija os campos editáveis de um tenant. Assíncrono — enquete operationId.

Argumentos

Name	Required	Finalidade
[tenant-id]	não	UUID do tenant. O padrão é o tenant do login atual.

Opções

Long	Valor	Description
--name <name>	String	Novo nome de exibição.
--region <region>	ENUM	Nova região.
--environment <env>	ENUM	Nova tag de ambiente.
--file <path>	Path	Corpo completo TenantUpdateDto — necessário para services{}, customProperties, color. Exclusivo mutuamente com os sinalizadores incorporados.

Exemplo

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

Formato dos dados (--output json)

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

exclusão de tenants do administrador do uip

Exclua temporariamente um tenant por ID (reversível pelo fluxo de restauração). Assíncrono — enquete operationId. Sem opção de exclusão forçada.

Argumentos

Name	Required	Finalidade
[tenant-id]	não	UUID do tenant. O padrão é o tenant do login atual.

Exemplo

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

Formato dos dados (--output json)

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

tenants do administrador do uip habilitar / desabilitar

Habilite ou desabilite um tenant. Síncrono (ao contrário de create/update/delete).

Argumentos

Name	Required	Finalidade
[tenant-id]	não	UUID do tenant. O padrão é o tenant do login atual.

Opções (somente para desabilitar)

Long	Valor	Description
--reason <text>	String	Motivo em texto livre gravado com a ação desabilitar.

Exemplos

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

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

Formato dos dados (--output json)

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

Code é OmsTenantDisabled para disable.

Serviços de tenants de administrador do uip

Gerencie serviços no nível do tenant (provisionamento, status, catálogo por região). Todos os verbos aceitam --tenant-id <guid>, usando como padrão o tenant do login atual.

lista de serviços dos tenants do administrador do uip

Opções

Long	Valor	Description
--tenant-id <guid>	GUID	Tenant de destino. O padrão é o tenant de logon.
--service <type>	String	Correspondência exata em serviceType. No lado do cliente.
--region <region>	ENUM	Correspondência exata por região. No lado do cliente.

Exemplo

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

Formato dos dados (--output json)

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

uip admin tenants serviços lista-disponível

Opções

Long	Valor	Required	Description
--region <region>	ENUM	sim	Região cujo catálogo de serviços será consultado.

Exemplo

uip admin tenants services list-available --region UnitedStates

Formato dos dados (--output json)

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

serviços de tenants de administrador do uip adicionar/remover

Provisionar ou remover serviços no nível do tenant de forma suave. Síncrono. --service (simples) e --file (múltiplo, AddRemoveTenantServiceRequestDto corpo: { "services": { "<type>": true|false } }) são mutuamente exclusivos; um --file para add deve ter todos os valores true e para remove todos os valores false — um valor incompatível falha do lado do cliente antes da chamada.

Opções

Long	Valor	Description
--tenant-id <guid>	GUID	Tenant de destino. O padrão é o tenant de logon.
--service <type>	String	Único tipo de serviço a ser adicionado/remover.
--file <path>	Path	Corpo de AddRemoveTenantServiceRequestDto multiserviço.

Exemplos

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

Formato dos dados (--output json)

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

Code é OmsTenantServicesRemoved para remove.

serviços de tenants do administrador do uip habilitar / desabilitar

Habilite ou desabilite uma instância de serviço no nível do tenant. Síncrono.

Opções

Long	Valor	Required	Description
--tenant-id <guid>	GUID	não	Tenant de destino. O padrão é o tenant de logon.
--service <type>	String	sim	Identificador do tipo de serviço, por exemplo orchestrator).

Exemplos

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

Formato dos dados (--output json)

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

Code é OmsTenantServiceDisabled para disable.

Veja também

• Opções globais
• Códigos de saída