Sessões e credenciais

uip sessão é o estado que vincula um comando a uma organização e tenant específicos da UiPath e que permite que a CLI apresenta um token de acesso válido sem solicitar ao usuário em cada chamada. As sessões são persistidas no disco para os fluxos de Aplicativo interativo e Externo, e são reconstruídas a partir de variáveis de ambiente para o fluxo env-var. Esta página explica onde esse estado reside, como uip o encontra e o que esperar quando você se move entre tenants ou máquinas.

A pasta de credenciais

uip login a sessão dentro de uma pasta chamada .uipath/. Trate seu conteúdo como opaco — eles são gerenciados por uip login, uip login tenant set e uip logout, e o layout no disco é um detalhe de implementação que pode ser alterado entre versões. A pasta contém um token de acesso, um token de atualização e a organização e o tenant ativos.

Proteja a pasta. Ele contém tokens que podem representar sua sessão até que sejam revogados. Em ambientes de vários usuários ou compartilhados, mantenha-o em um diretório inicial com as permissões usuais de 0600 sobre seu conteúdo. Em uma máquina de desenvolvedor, geralmente é suficiente deixá-la onde uip login a colocou. Adicione .uipath/ a .gitignore se uma sessão de projeto local for por desenvolvedor.

Resolução no local (check-up)

Quando uip comando é executado, a CLI procura a pasta de credenciais nesta ordem:

1. Caminho explícito — se um comando foi invocado com -f /path/to/folder, essa pasta será usada. O caminho pode ser absoluto ou relativo.
2. Caminho acima do diretório atual — começando em cwd, a CLI verifica ./.uipath/, então sobe a cadeia pai procurando a mesma pasta. O primeiro que encontrar vence.
3. Início do usuário — se nenhuma pasta local do projeto foi encontrada na atualização, a CLI recairá em ~/.uipath/.

uip login grava no caminho que seria lido pelo próximo comando:

• Se você executou uip login dentro de um diretório com um .uipath/ existente na cadeia de atual, o login atualizará essa sessão no local.
• Caso contrário, ele cria ~/.uipath/ em seu diretório inicial.

Por que fazer uma organização assistida?

Subir de cwd permite que uma pasta do projeto execute sua própria sessão sem modificar seu diretório inicial. Coloque uma pasta .uipath/ em uma raiz do repositório, e todos que executarem uip de dentro do repositório coletarão o login desse projeto, útil para credenciais do cliente por projeto, tenants de preparação ou ambientes de demonstração.

Substituição do local

Três maneiras de substituir a pesquisa:

• em -f, --file <folder> e uip login — use uip logout pasta especificada apenas para este comando.
• Um diretório inicial separado — em um servidor de compilação compartilhado, execute HOME=/srv/build-home uip login para gravar em /srv/build-home/.uipath/.
• uip completion e outros comandos não recebem um sinalizador -f e sempre usam o fallback inicial + inicial.

Para inspeção:

# print the current session status (reads via walk-up)
uip login status

uip login status lê por meio do fallback + fallback inicial; ele não aceita -f. Para inspecionar uma sessão em uma pasta não padrão, altere para esse diretório (ou um subdiretório dele) antes de executar uip login status ou liste os tenants disponíveis com uip login tenant list -f /path/to/creds.

Organização e tenant ativos

Uma sessão armazena uma organização e um tenant de cada vez. O tenant é o conceito da UiPath que abrange pastas, trabalhos, filas e recursos — efetivamente a "conta" que a CLI alcança sempre que você uip or ….

Altere o tenant ativo sem autenticar novamente:

uip login tenant list           # show all tenants this session can access
uip login tenant set MyTenant   # switch the active tenant

Nos bastidores, uip login tenant set cria novos tokens de acesso/atualização para o novo tenant e atualiza a sessão armazenada no local.

Passe --tenant <name> em qualquer chamada uip or … para substituir o tenant ativo da sessão para um único comando, sem alterar a sessão no disco:

uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production

Atualizando tokens

Os tokens de acesso são de curta duração. Quando a CLI detecta que o token de acesso armazenado está próximo da expiração, ela usa o token de atualização para solicitar um novo e atualiza silenciosamente a sessão armazenada. Você não precisa executar novamente uip login a menos que um dos seguintes problemas aconteça:

• O próprio token de atualização expira ou é revogado (normalmente após semanas de inatividade ou quando um administrador força uma logout).
• Você alterou a organização.
• Você precisa de um conjunto de escopos diferente daquele com o qual a sessão foi autenticada.

uip login status relata Expired quando a atualização falhou; esse é o sinal para executar uip login novamente.

O fluxo env-var (sem arquivo)

O terceiro fluxo de autenticação, habilitado UIPATH_CLI_ENABLE_ENV_AUTH=true, ignora totalmente a pasta de credenciais. Cada comando uip lê o token e o tenant das variáveis de ambiente, os usa como estão e não grava nada no disco.

Esta é a escolha certa para:

• Contêineres que recebem um token de um pipeline pai.
• Executores de CI efêmeros onde persistir credenciais no disco é desperdiçador ou proibido.
• Qualquer ambiente em que a CLI deve ser sem estado entre invocações.

Diferenças dos fluxos baseados em arquivos:

• Sem atualização. O token é opaco para uip — se estiver expirado, o chamador é responsável por girá-lo.
• uip logout faz nada. Não há nenhum arquivo para remover. Desdefinir as variáveis de ambiente para "sconectar".
• A URL base é derivada do token. Qualquer declaração iss que o JWT carregue é tratada como autorizada — não defina UIPATH_URL em conjunto com UIPATH_CLI_AUTH_TOKEN, ou você dessincronizará.

Consulte Autenticação — Fluxo 3 para obter o conjunto completo de variáveis e Ações do GitHub / exemplos de contêiner.

Fazer logout

Fluxos baseados em arquivos:

uip logout                        # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds      # clear a specific credentials folder

logout limpa a sessão armazenada. As chamadas uip or … subsequentes falharão com AuthenticationError (código de saída 2) até que você execute uip login novamente. Para invalidar a sessão também no lado do servidor, revogue o segredo do aplicativo externo no Automation Cloud ou saia da sua conta de usuário.

Fluxo env-var: desdefinir UIPATH_CLI_ENABLE_ENV_AUTH (e as variáveis token, para ser seguro).

Veja também

• Autenticação — os três fluxos que gravam ou ignoram a pasta de credenciais.
• Configuração — precedência de variável de ambiente, que fica ao lado, mas separada da pasta de credenciais.
• referência de login uip, referência de status de login uip, referência de logout uip — listas de sinalizadores por comando e exemplos.
• Instalação do UiPath CLI — Remover credenciais e dados — limpeza após a desinstalação.