UiPath Documentation
test-cloud
latest
false
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Guia da API do Test Cloud

Tokens de acesso pessoal

Observação:

A disponibilidade de funcionalidades depende da plataforma de nuvem que você usa. Para obter detalhes, consulte a página Disponibilidade de recursos.

Os tokens de acesso pessoal (PATs) permitem acessar serviços e recursos do UiPath com facilidade, mantendo um alto nível de segurança.

O que são tokens de acesso pessoal?

Um token de acesso pessoal é uma string alfanumérica exclusiva que serve para substituir suas credenciais ao interagir com nossas APIs e serviços. Em vez de fornecer seu nome de usuário e senha diretamente, você pode gerar um token de acesso pessoal que concede acesso controlado a recursos específicos do UiPath.

Observação:

OS PATs estão disponíveis apenas para usuários locais. Eles não estão disponíveis para usuários de diretório ou SAML.

Benefícios de usar tokens para autenticação

O uso de tokens de acesso pessoal para autenticação oferece vários benefícios importantes:

  1. Segurança aprimorada: os PATs reduzem o risco de expor suas credenciais primárias, pois são usados no lugar de seu nome de usuário e senha.
  2. Controle de acesso refinado: com escopos e permissões, você pode definir com precisão o nível de acesso de cada token, permitindo que você limite ações apenas ao que é necessário.
  3. Data de expiração: você pode garantir que os tokens tenham um período de validade limitado atribuindo-lhes uma data de expiração.

Escopos e permissões de tokens

Os escopos de tokens definem as ações ou recursos específicos que um token pode acessar. Ao criar um token, você é solicitado a selecionar os escopos apropriados com base no que você pretende fazer com ele. Os exemplos de escopos podem incluir:

  • TM.Defects.Read — permite realizar ações relacionadas à leitura ou acesso a defeitos no Test Manager.
  • OR.Folders — permite ler dados de pasta, criar, modificar e gerenciar pastas no Orchestrator.

Seleção de escopos apropriados para suas necessidades

Ao gerar um token de acesso pessoal, você precisa selecionar escopos que se alinhem às tarefas que você pretende realizar. Você deve solicitar apenas escopos que sejam necessários para seu caso de uso. Ao minimizar as permissões de um token, você reduz o impacto que ele pode ter se ficar comprometido e, assim, você aumenta a segurança.

Para selecionar escopos apropriados:

  1. Determine as tarefas que você precisa que o token realize, como ler dados de pastas ou gerenciar pastas.
  2. Consulte a lista de escopos disponíveis e suas descrições no processo de geração de tokens.
  3. Escolha o menor conjunto de escopos que permitirá que seu token realize tarefas com eficácia.

Geração de um token

Para gerar um token, siga estas etapas:

  1. Select the user icon in the top-right corner of the window and select Preferences. The Preferences page opens.

    Figura 1. Preferências de menu de usuário. Captura de tela do menu de usuário mostrando a opção Preferências. Essa opção permite que você personalize sua experiência ajustando configurações de acordo com suas preferências.

  2. On the left, select Personal Access Token.

    The Personal Access Token page shows a list of personal tokens generated for your user, if any.

  3. To generate a new token, select Generate new token. The Generate personal access token pane opens on the right.

  4. Forneça um nome no campo Nome para fins de identificação.

  5. Forneça uma data de validade no campo Data de expiração. Após essa data, o token torna-se inválido.

  6. Defina as permissões e ações específicas que o token está autorizado a realizar dentro de um aplicativo, selecionando seu escopo no campo Escopo > Recursos.

    Figura 2. Configuração de tokens de acesso pessoal. Captura de tela da janela de configuração para tokens de acesso pessoal e seus escopos. Os usuários podem gerenciar e personalizar o acesso definindo os recursos, escopos e data de validade de cada token.

  7. After configuring the fields, select Save to save your token. The system generates a unique access token for you, which is displayed on the Token generated window.

    Figure 3. Generated Token Confirmation. Screenshot confirming the successful generation of a token. The interface displays a newly generated token with a unique alphanumeric code. A checkmark symbolizes the completion of the process. Users can now use this token to authenticate and access specific UiPath resources securely.

    A notification advises users that the token will not be visible again.

  8. Once generated, copy the access token immediately. This is your only opportunity to view the token. Keep it in a safe place, as you will not be able to see it again.

    You can now use this token to authenticate and access UiPath resources through our APIs.

Revogação de um token

A revogação de um token permite que você desabilite imediatamente o acesso para tokens que não são mais necessários ou que foram comprometidos. Para revogar um token, siga estas etapas:

  1. Select the user icon in the top-right corner of the window and select Preferences. The Preferences page opens.

  2. On the left, select Personal Access Token. The Personal Access Token page shows a list of personal tokens generated for your user.

  3. To revoke a token, select Show more actions > Revoke for the specific token. The Revoke token window is displayed, asking you to confirm the revocation.

    Figura 4. Confirmação de revogação de token. Captura de tela da janela de revogação de tokens, indicando a revogação bem-sucedida de um token. Quaisquer usos anteriores do token não serão mais válidos.

  4. Select Delete to revoke the token.

    After deleting it, the token is removed from the list of available tokens, and is no longer valid for accessing UiPath resources.

    Importante:

    O mecanismo de cache do Orchestrator armazena PATs por uma hora. Consequentemente, os tokens revogados ainda podem acessar recursos do Orchestrator por até uma hora extra antes que o cache expire.

Regeneração de tokens

Em cenários nos quais você precisa manter o mesmo nível de acesso, mas deseja atualizar seu token, você pode considerar regenerar um token de acesso pessoal. A regeneração cria um novo token com escopos e permissões idênticos aos do original. No entanto, certifique-se de atualizar quaisquer scripts, aplicativos ou integrações que utilizam o token antigo com o novo.

Importante:

A regeneração é aplicável apenas a tokens que ainda não expiraram. Depois que um token expira, ele não pode ser regenerado. O mecanismo de cache do Orchestrator armazena PATs por uma hora. Consequentemente, os tokens revogados ainda podem acessar recursos do Orchestrator por até uma hora extra antes que o cache expire.

Regeneração de um token

Para regenerar um token, siga estas etapas:

  1. Select the user icon in the top-right corner of the window and select Preferences. The Preferences page opens.

  2. On the left, select Personal Access Token. The Personal Access Token page shows a list of personal tokens generated for your user.

  3. To regenerate a token, select Show more actions > Regenerate for an unexpired token. The Regenerate token window is displayed.

    Figura 5. Confirmação de regeneração de tokens. Captura de tela da janela de confirmação de regeneração de tokens. Os usuários são solicitados a confirmar sua intenção de regenerar o token.

  4. Select Confirm to regenerate the token. The system generates a unique access token for you, which is displayed on the Token generated window.

    Figure 6. Generated Token Confirmation. Screenshot confirming the successful generation of a token. The interface displays a newly generated token with a unique alphanumeric code. A checkmark symbolizes the completion of the process. You can now use this token to authenticate and access specific UiPath resources securely.

    A notification advises you that the token will not be visible again.

  5. Once generated, copy the access token immediately. This is your only opportunity to view the token. Keep it in a safe place, as you will not be able to see it again.

    You can now use this token to authenticate and access UiPath resources through our APIs.

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