Leia e revise a documentação do Automation Anywhere

Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

Configurar uma credencial com valores de atributo usando a API

  • Atualizado: 2021/01/31
    • Automation 360 v.x
    • Explorar
    • Espaço de trabalho RPA

Configurar uma credencial com valores de atributo usando a API

Crie uma credencial com um atributo padrão e adicione dois atributos adicionais com valores de entrada do usuário.

Pré-requisitos

Nota: Você pode visualizar o Control Room APIs no Community Edition, mas a funcionalidade da API é limitada. Você precisa de uma Automation 360 edição licenciada para acessar a funcionalidade completa das APIs.
  • Use a API de autenticação para gerar um JSON Web Token. Consulte API de autenticação.
  • Todas as funções têm a permissão Gerenciar minhas credenciais e cofres necessária para configurar credenciais e atributos. Não são necessárias permissões adicionais para usar esse endpoint.
Neste exemplo, você configura uma credencial com três atributos para armazenar o nome de host, nome de usuário e senha do e-mail.

Procedimento

  1. Adicione o token de autenticação ao cabeçalho da solicitação.
  2. Criar uma credencial. Use o método POST e o URL de endpoint: <your_control_room_url>/v2/credentialvault/credentials.
    Corpo da solicitação: Esta solicitação de exemplo inclui os seguintes parâmetros necessários:
    • userProvided: um valor booliano que configura se o atributo requer a entrada de um usuário (verdadeiro) ou é padrão para todos os usuários (falso).
    • mascarado: um valor booleano que configura se o valor do atributo é mascarado com asteriscos (verdadeiro) ou se é visível para os usuários (falso).
    {
      "name": "Email",
      "attributes": [
      	{
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 	
      ]
    }
  3. Envie a
    Corpo da resposta: Em uma solicitação bem-sucedida, esse endpoint retorna os seguintes dados:
    • id: um identificador numérico exclusivo para a credencial.
    • attributes:id: um identificador numérico exclusivo para o atributo.
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
                "id": "3335",
                "name": "hostname",
                "description": "",
                "userProvided": false,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366448Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            }
        ],
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:04:41.366460Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:04:41.366464Z",
        "version": "0"
    }
    A API REST responde a cada solicitação com um código de resposta HTTP. Para códigos de resposta, consulte Códigos de resposta da API.
  4. Atribuir um valor padrão ao atributo do nome do host para a credencial. Use o método POST e o URL de endpoint:<your_control_room_url>/{credentialId}v2/credentialvault/credentials//attributevalues.
    {
      "list": [
        {
          "credentialAttributeId": "3335",
          "value": "mail.example.com"
        }
      ]
    }
  5. Envie a
    Corpo da resposta:
    {
      "list": [
        {
          "id": "1630",
          "credentialAttributeId": "3335",
          "value": "mail.example.com",
          "userId": "1508",
          "createdBy": "1508",
          "createdOn": "2020-12-28T22:04:41.366460Z",
          "updatedBy": "1508",
          "updatedOn": "2020-12-28T22:04:41.366464Z",
          "version": "0"
        }
      ]
    }
  6. Adicione os atributos de nome de usuário e senha à credencial de e-mail. Use o método PUT e o URL do endpoint:<your_control_room_url>/v2/credentialvault/credentials/{credentialId}.
    Corpo da solicitação: Como você especificou o ID da credencial no URL da solicitação, não é necessário incluir o ID ou o nome da credencial no corpo da solicitação. Neste exemplo de corpo de solicitação, os atributos de nome de usuário e senha são configurados com valores que aceitam uma entrada diferente de cada usuário. Além disso, o atributo de senha é configurado para mascarar o valor inserido com asteriscos.
    {
        "attributes": [
      	{
          "name": "username",
          "userProvided": true,
          "masked": false
        },
         {
          "name": "password",
          "userProvided": true,
          "masked": true
        }	
      ]
    }
  7. Envie a
    Corpo da resposta: O corpo da resposta retorna a credencial com detalhes dos três atributos.
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
                "id": "3335",
                "name": "hostname",
                "description": "",
                "userProvided": false,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366448Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            },
            {
                "id": "3336",
                "name": "username",
                "description": "",
                "userProvided": true,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366450Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            },
            {
                "id": "3337",
                "name": "password",
                "description": "",
                "userProvided": true,
                "masked": true,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366450Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            }
        ],
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:04:41.366460Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:06:35.366464Z",
        "version": "2"
    }

Próximas etapas

Se você estiver seguindo as etapas para configurar o Credential Vault, faça isso a seguir: Atribuir credencial à locker API.
Send Feedback (Enviar Feedback)