Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

API de autenticação

  • Atualizado: 9/21/2020
    • Automation 360 v.x
    • Gerenciar
    • Espaço de trabalho RPA
    • Documentos de API

API de autenticação

Use a API de autenticação para gerar, atualizar e gerenciar os JSON Web Tokens (JWT) necessários para autorização em todas as APIs da Control Room.

Nota: Você pode exibir o Control Room APIs no Community Edition, mas a funcionalidade da API é limitada. Você precisa de uma edição licenciada do Automation 360 para acessar a funcionalidade completa das APIs.
O JWT é uma string de texto com 703 caracteres.
{
  "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",  . . . 
}

auth

POST http://<your_control_room_url>/v1/authentication
Parâmetros do corpo:
{
  "username": "string",
  "password": "string",
  "apiKey": "string"
}
Faça uma solicitação POST para gerar um JWT.
  • O nome de usuário do usuário da Automation Anywhere.
  • A senha do usuário da Automation Anywhere.
  • A apiKey é necessária para configurar login único (SSO). Também pode ser usada no lugar de uma senha para usuários atribuídos à Função de geração de chave de API.
  • Um JWT é necessário no cabeçalho de outras APIs da Control Room.
  • Os tokens de autenticação têm um tempo limite padrão de 20 minutos.

Nem todos os parâmetros são necessários para gerar um token de autenticação. No entanto, para uma Control Room implantada em Cloud e com autenticação SAML habilitada, use o nome de usuário e apikey para gerar o token de autenticação.

Consulte os exemplos a seguir para obter informações detalhadas:
Nota:
  • Mecanismo de negociação de GSS-API simples e protegido (SPNEGO)
    Você pode usar o SPNEGO, que se pronuncia "spenay-go", quando sua Control Room estiver configurada adequadamente com os seguintes recursos de autenticação:
    • Modo de autenticação do Active Directory (AD)
    • O AD é habilitado para Kerberos

    Em uma Control Room com o SPNEGO configurado adequadamente, os usuários não precisam inserir um nome de usuário e senha para gerar um JWT.

  • Exemplo de URL de API de autenticação SPNEGO:

    https://<your_control_room_url/v1/authentication/SPNEGO

GET http://<your_control_room_url>/v1/authentication/token/{token}
Parâmetro da URL:
O token que você está validando.
Nota: O token é passado como um parâmetro na URL. Não há parâmetros para o corpo da solicitação.

Ver Validar um token de autenticação para obter detalhes da tarefa.

POST http://<your_control_room_url>/v1/authentication/token
Parâmetro do corpo:
Um token de atualização permite que você obtenha um novo token sem a necessidade de coletar e autenticar credenciais sempre que um token expirar.
{
  "token": "string"
}

Clique em Atualizar um token de autenticação para obter um exemplo detalhado dessa API.

POST http://<your_control_room_url>/v1/authentication/logout
Parâmetro do cabeçalho:
Expira imediatamente o token que você adiciona ao cabeçalho da solicitação.
POST 'http://<your_control_room_url>/v1/authentication/logout'
-H 'X-Authorization: <access_token> 

Clique em Desconectar imediatamente (expirar) um token de autenticação para obter um exemplo detalhado dessa API.

POST http://<your_control_room_url>/v1/authentication/app/login
A API .../atuhentticataion/app/login é uma API de autenticação entre serviços usada por aplicativos da Automation Anywhere internamente compatíveis. Essa API não é compatível para uso por usuários externos.
Send Feedback (Enviar Feedback)