UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

contas-robô administrador do uip

Sintaxe e opções para "uip admin robot-accounts", "uip admin deslizar" e "uip admin escopos" — identidades não humanas, tokens de acesso pessoal e a referência de escopo do OAuth2.

Três grupos de comando independentes relacionados: robot-accounts (identidades de diretório não humanos usados para automação unattended), pat (tokens de acesso pessoal para autenticação de API) e scopes (uma referência somente leitura de cada escopo OAuth2 disponível para aplicativos externos e PATs).

Resumo​

uip admin robot-accounts list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin robot-accounts get <robot-account-id>
uip admin robot-accounts create <name> [--display-name <name>]
uip admin robot-accounts update <robot-account-id> --display-name <name>
uip admin robot-accounts delete <robot-account-id>

uip admin pat list [--scope all] [--search <term>] [--limit <n>] [--offset <n>]
uip admin pat create --description <text> --expiration <date> --scope <scopes>
uip admin pat revoke <id>
uip admin pat regenerate <id> --expiration <date>

uip admin scopes list
uip admin robot-accounts list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin robot-accounts get <robot-account-id>
uip admin robot-accounts create <name> [--display-name <name>]
uip admin robot-accounts update <robot-account-id> --display-name <name>
uip admin robot-accounts delete <robot-account-id>

uip admin pat list [--scope all] [--search <term>] [--limit <n>] [--offset <n>]
uip admin pat create --description <text> --expiration <date> --scope <scopes>
uip admin pat revoke <id>
uip admin pat regenerate <id> --expiration <date>

uip admin scopes list

Verbo​

GrupoTextoFinalidade
robot-accountslistListe contas de robôs na partição.
robot-accountsgetObtenha os detalhes de uma conta de robô por ID.
robot-accountscreateCrie uma nova conta de robô.
robot-accountsupdateAtualize o nome de exibição de uma conta de robô.
robot-accountsdeleteExcluir uma conta de robô por ID.
patlistListe tokens de acesso pessoal (seu ou da organização com --scope all).
patcreateCrie um novo token de acesso pessoal.
patrevokeRevogar um token.
patregenerateGere novamente um token com uma nova expiração.
scopeslistListe todos os escopos do OAuth2 disponíveis, agrupados por recurso.

lista de contas-robô do administrador do uip​

Liste contas de robôs na partição. Retorna o ID da conta, o nome, o nome de exibição e a hora de criação.

Opções​

LongShortValorPadrãoDescription
--search <term>-sString—Pesquise por nome.
--sort-by <field>String—Classificar campo, por exemplo Name).
--sort-order <direction>asc|descascClassificar direção.
--limit <number>-lNúmero inteiro50Número de itens a serem retornados.
--offset <number>Número inteiro0Número de itens a serem ignorados.

Exemplo​

uip admin robot-accounts list --limit 5
uip admin robot-accounts list --limit 5

Formato dos dados (--output json)​

{
  "Code": "RobotAccountList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}
{
  "Code": "RobotAccountList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}

contas-robô do administrador do uip obter​

Obtenha detalhes da conta do robô por ID.

Argumentos​

NameRequiredFinalidade
<robot-account-id>simID de conta do robô (UUID).

Exemplo​

uip admin robot-accounts get a1b2c3d4-0000-0000-0000-000000000001
uip admin robot-accounts get a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{ "Code": "RobotAccountDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z", "groupIds": [] } }
{ "Code": "RobotAccountDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z", "groupIds": [] } }

criação de contas-robô do administrador do uip​

Crie uma nova conta de robô na partição.

Argumentos​

NameRequiredFinalidade
<name>simNome da conta do robô.

Opções​

LongValorDescription
--display-name <name>StringNome de exibição. Quando omitido, o padrão é <name>.

Exemplo​

uip admin robot-accounts create "automation-bot" --display-name "Automation Bot"
uip admin robot-accounts create "automation-bot" --display-name "Automation Bot"

Formato dos dados (--output json)​

{ "Code": "RobotAccountCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "automation-bot", "displayName": "Automation Bot" } }
{ "Code": "RobotAccountCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "automation-bot", "displayName": "Automation Bot" } }

atualização de contas-robô do administrador do uip​

Atualize o nome de exibição de uma conta de robô. --display-name é o único campo e é efetivamente necessário — omiti-lo falha no lado do cliente ("No fields to update").

Argumentos​

NameRequiredFinalidade
<robot-account-id>simID de conta do robô (UUID).

Opções​

LongValorRequiredDescription
--display-name <name>StringsimNovo nome de exibição.

Exemplo​

uip admin robot-accounts update a1b2c3d4-0000-0000-0000-000000000001 --display-name "Updated Bot"
uip admin robot-accounts update a1b2c3d4-0000-0000-0000-000000000001 --display-name "Updated Bot"

Formato dos dados (--output json)​

{ "Code": "RobotAccountUpdated" }
{ "Code": "RobotAccountUpdated" }

exclusão de contas-robô do administrador do uip​

Excluir uma conta de robô por ID.

Argumentos​

NameRequiredFinalidade
<robot-account-id>simID de conta do robô (UUID).

Exemplo​

uip admin robot-accounts delete a1b2c3d4-0000-0000-0000-000000000001
uip admin robot-accounts delete a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{ "Code": "RobotAccountDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }
{ "Code": "RobotAccountDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

lista de configuração de configuração do administrador do uip​

Listar tokens de acesso pessoal. Por padrão, lista apenas as suas; --scope all (somente administrador) lista cada token na organização.

Opções​

LongValorDescription
--scope <scope>allApenas "all" é aceito — qualquer outro valor falha no lado do cliente com um erro explícito. Omita para listar apenas seus próprios tokens.
--search <term>StringFiltra por termo de pesquisa do usuário. Implica --scope all mesmo que --scope não seja passado.
--limit <number> (-l)Número inteiroPadrão 50. Número de itens a serem retornados.
--offset <number>Número inteiro0Padrão. Número de itens a ignorar.

Exemplo​

uip admin pat list
uip admin pat list

Formato dos dados (--output json)​

{
  "Code": "PatList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "description": "CI/CD token", "expiration": "2027-01-15T00:00:00.000Z", "scopes": ["OR.Folders.Read"] }
  ]
}
{
  "Code": "PatList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "description": "CI/CD token", "expiration": "2027-01-15T00:00:00.000Z", "scopes": ["OR.Folders.Read"] }
  ]
}

na criação do patch de administrador do uip​

Crie um novo token de acesso pessoal. O valor do token é retornado apenas uma vez — não pode ser recuperado posteriormente.

Opções​

LongValorRequiredDescription
--description <text>StringsimDescrição do token.
--expiration <date>YYYY-MM-DDsimData de expiração. Validado estritamente — rejeita datas e substituições de calendário malformadas (por exemplo 2027-02-30).
--scope <scopes>separados por vírgulasimUm ou mais escopos, por exemplo OR.Folders.Read,OR.Jobs.Read). Consulte scopes list para obter o catálogo completo.

Exemplo​

uip admin pat create --description "CI/CD token" --expiration 2027-01-15 --scope "OR.Folders.Read,OR.Jobs.Read"
uip admin pat create --description "CI/CD token" --expiration 2027-01-15 --scope "OR.Folders.Read,OR.Jobs.Read"

Formato dos dados (--output json)​

{ "Code": "PatCreated", "Data": { "Token": "...", "Warning": "Save this token now. It will not be shown again." } }
{ "Code": "PatCreated", "Data": { "Token": "...", "Warning": "Save this token now. It will not be shown again." } }

uip adminpath revogar​

Revogar um token de acesso pessoal.

Argumentos​

NameRequiredFinalidade
<id>simID do token (UUID). Encontre-o com pat list.

Exemplo​

uip admin pat revoke a1b2c3d4-0000-0000-0000-000000000001
uip admin pat revoke a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)​

{ "Code": "PatRevoked", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Revoked successfully" } }
{ "Code": "PatRevoked", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Revoked successfully" } }

Automação de Automação de Automação (uip admin)​

Gere novamente um token de acesso pessoal com uma nova expiração. Como create, o novo valor do token é mostrado apenas uma vez.

Argumentos​

NameRequiredFinalidade
<id>simID do token (UUID).

Opções​

LongValorRequiredDescription
--expiration <date>YYYY-MM-DDsimNova data de expiração. Mesma validação rigorosa de create.

Exemplo​

uip admin pat regenerate a1b2c3d4-0000-0000-0000-000000000001 --expiration 2028-01-15
uip admin pat regenerate a1b2c3d4-0000-0000-0000-000000000001 --expiration 2028-01-15

Formato dos dados (--output json)​

{ "Code": "PatRegenerated", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Token": "...", "Warning": "Save this token now. It will not be shown again." } }
{ "Code": "PatRegenerated", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Token": "...", "Warning": "Save this token now. It will not be shown again." } }

lista de escopos de administrador do uip​

Liste todos os escopos do OAuth2 disponíveis para aplicativos externos e tokens de acesso pessoal, agrupados por recurso. Somente leitura, sem opções além das globais.

Exemplo​

uip admin scopes list
uip admin scopes list

Formato dos dados (--output json)​

{
  "Code": "ScopesList",
  "Data": [
    {
      "name": "UiPath.Orchestrator",
      "displayName": "Orchestrator API Access",
      "scopes": [
        { "name": "OR.Folders", "displayName": "OR.Folders", "type": "user" }
      ]
    }
  ]
}
{
  "Code": "ScopesList",
  "Data": [
    {
      "name": "UiPath.Orchestrator",
      "displayName": "Orchestrator API Access",
      "scopes": [
        { "name": "OR.Folders", "displayName": "OR.Folders", "type": "user" }
      ]
    }
  ]
}

type em cada entrada de escopo é "user" (delegado, requer um usuário conectado) ou "application" (somente aplicativo) — a mesma distinção entre os sinalizadores --user-scope/--app-scope do external-apps create e pat create a sinalização --scope de }.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades