Logon da UIP

uip login autentica a CLI no UiPath Cloud e persiste a sessão resultante dentro de uma pasta local .uipath/ . Em caso de sucesso, a CLI tem um token de acesso e um tenant selecionado; ferramentas executadas por comandos subsequentes os coletam automaticamente. Consulte Autenticação para o modelo de credencial e Sessões e credenciais para saber onde a pasta reside.

Para verificar o status, consulte uip login status. Para desmontar uma sessão, consulte uip logout.

Resumo

uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]

Todos os subcomandos uip login respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

Logon da UIP

Autenticação interativa por meio do navegador ou de forma não interativa, usando credenciais do cliente de aplicativo externo.

Argumentos

Nenhum.

Opções

• -f, --file <folder> — Caminho para uma pasta de credenciais. A sessão é persistida dentro de <folder>. Sem ele, a CLI usa o local padrão (consulte Sessões e credenciais).
• --authority <url> — URL de autoridade personalizada. Use para nuvens não padrão.
• --client-id <id> ID do cliente ou ID do aplicativo para um aplicativo externo da UiPath. Aceita env.NAME para ler a partir de uma variável de ambiente.
• --client-secret <secret> Segredo do cliente para um aplicativo externo confidencial. Aceita env.NAME para ler a partir de uma variável de ambiente.
• — Escopos separados "OR.Folders OR.Jobs" -s, --scope <scopes> . Use com credenciais de Aplicativos Externos.
• -t, --tenant <name> — Nome do tenant (modo não interativo). Se omitido, emparelhe com --interactive.
• --organization <name> — Nome lógico da organização, pré-selecionado durante o login do navegador. Ignora o seletor de organizações quando seu usuário está em várias organizações.
• --it, --interactive Após a autenticação, solicite interativamente para selecionar um tenant da lista retornada pela nuvem.

Modos de Credencial

• Credenciais interativas / de usuário — execute uip login (opcionalmente com --interactive, --tenant ou --organization). O fluxo do navegador é concluído na autoridade do UiPath Cloud; os tokens resultantes são armazenados dentro da pasta de credenciais.
• Aplicativo externo (não interativo) — passe --client-id, --client-secret e --scope, normalmente com --tenant. Adequado para executores de CI. Leia o segredo de uma variável de ambiente com --client-secret env.UIPATH_CLIENT_SECRET para mantê-la fora do histórico do seu shell.

Exemplos

# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath

Formato dos dados (--output json)

{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}

Modos de falha

• Tenant ausente após um login não interativo gera um ConfigError com Message: "No tenant selected" e instrui você a executar novamente com --tenant <name> ou --interactive.
• Erros de transporte e respostas não 2xx da superfície de autoridade como AuthenticationError, com o status HTTP original em Context.httpStatus quando disponível.
• Uma referência env.NAME malformada em --client-id / --client-secret produz um ConfigError antes de qualquer chamada de rede.

lista de tenants de login uip

Lista todos os tenants visíveis para o usuário autenticado na organização atual. Requer um logon ativo.

Argumentos

Nenhum.

Opções

• -f, --file <folder> Caminho para a pasta de credenciais. O padrão é a sessão usada pelo último uip login.

Exemplo

uip login tenant list

Formato dos dados (--output json)

{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}

Se a sessão não estiver logada, o comando emite AuthenticationError com instruções para executar uip login primeiro.

conjunto de tenant de login uip

Selecione o tenant ativo por nome. O tenant deve existir na lista retornada por login tenant list; a CLI atualiza a sessão armazenada com a nova seleção.

Argumentos

• <name> (necessário) — Nome do tenant conforme retornado por uip login tenant list.

Opções

• -f, --file <folder> Caminho para a pasta de credenciais. O padrão é a sessão usada pelo último uip login.

Exemplo

uip login tenant set DefaultTenant

Formato dos dados (--output json)

{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Modos de falha

• Nome de tenant desconhecido produz ValidationError com Instructions listando os tenants disponíveis, por exemplo, argument should be one of DefaultTenant, ProductionTenant.
• Se a CLI não puder atualizar a sessão armazenada, o erro será exibido como Failure com uma dica relacionada às permissões.

Relacionado

• uip login status — mostra a sessão atual sem atualizar.
• uip logout — limpar a sessão armazenada.
• Autenticação — fluxos de usuário versus Aplicativo Externo.
• Sessões e credenciais — como a pasta de credenciais é localizada e girada.
• Configuração — precedência de fontes de credenciais (env vars, file, flags).