Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

Pesquisar usuários

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

Pesquisar usuários

Use a API Pesquisar usuários para pesquisar todos os usuários em Control Room.

Pré-requisitos

Exibir usuários
Usuários com permissões para exibir usuários podem recuperar todos os usuários.
  • URL: http://<your_control_room_url>/v1/usermanagement/users/list.

    Substitua o conteúdo entre colchetes pela URL da sua Control Room.

  • Método: POST
  • Use os arquivos de definição Swagger instalados com a Control Room para testar as APIs. Veja as APIs do Swagger disponíveis em: http://<your_control_room_url>/swagger/.
  • Você também pode usar um client REST para concluir esta tarefa.

Procedimento

  1. Adicione um token de autenticação ao cabeçalho da solicitação.
    Use a API de autenticação para gerar um JSON Web Token. Ver API de autenticação.
  2. Selecione POST como método.
    Aplique filtros para executar consultas condicionais básicas e controle de paginação para processamento de páginas da web. Existem três recursos básicos relacionados à filtragem: condições de filtragem, colunas de classificação e parâmetros de paginação. Ver Filtros em um corpo de solicitação de API.
    POST http://<your_control_room_url>/v1/usermanagement/users/list
  3. Envie a solicitação.
    • Em um client REST, clique em ENVIAR.
    • Na interface do Swagger, clique em Executar.

    Corpo da solicitação:

    A solicitação a seguir encontra todos os usuários com um nome de usuário que contém admin e que foram criados entre 1.º e 6 de setembro de 2020.
    {
      "fields": [],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "substring",
            "field": "username",
            "value": "mdadmin"
          },
          {
            "operator": "gt",
            "field": "createdOn",
            "value": "2020-09-01T00:00:00.989Z"
          },
          {
            "operator": "lt",
            "field": "createdOn",
            "value": "2020-09-06T23:00:00.123Z"
          }
        ]
      }
    }

    A resposta neste exemplo retornou dados para dois nomes de usuário contendo a palavra admin, mdadmin e mt_admin.

    Corpo da resposta:
    {
      "page": {
        "offset": 0,
        "total": 310,
        "totalFilter": 2
      },
      "list": [
        {
          "id": 1513,
          "username": "mdadmin",
          "domain": "",
          "firstName": "Mira",
          "lastName": "Dytko",
          "version": 17,
          "principalId": 1513,
          "email": "md@aa.com",
          "emailVerified": true,
          "passwordSet": true,
          "questionsSet": true,
          "enableAutoLogin": false,
          "disabled": false,
          "clientRegistered": false,
          "description": "To be used for API testing",
          "createdBy": 1,
          "createdOn": "2020-09-01T11:01:17.760Z",
          "updatedBy": 1,
          "updatedOn": "2020-09-01T11:01:17.760Z",
          "licenseFeatures": [],
          "roles": [
            {
              "id": 1,
              "name": "AAE_Admin"
            },
            {
              "id": 2,
              "name": "AAE_Basic"
            }
          ],
          "deleted": false
        },
        {
          "id": 1520,
          "username": "mt_admin",
          "domain": "",
          "firstName": "",
          "lastName": "",
          "version": 6,
          "principalId": 1520,
          "email": "a@a.com",
          "emailVerified": true,
          "passwordSet": true,
          "questionsSet": true,
          "enableAutoLogin": false,
          "disabled": false,
          "clientRegistered": false,
          "description": "",
          "createdBy": 1,
          "createdOn": "2020-09-02T08:47:19.723Z",
          "updatedBy": 1,
          "updatedOn": "2020-09-02T08:47:19.723Z",
          "licenseFeatures": [],
          "roles": [
            {
              "id": 1,
              "name": "AAE_Admin"
            }
          ],
          "deleted": false
        }
      ]
    }
    Parâmetros do corpo de resposta:
    Nome do parâmetro Descrição
    ID Número de ID gerado pelo sistema que criou um usuário.
    nomedeusuário Nome de usuário para um novo usuário.
    domínio Nome do domínio do Active Directory.
    versão Número de versão gerado pelo sistema para um novo usuário.
    email Novo endereço de e-mail do usuário.
    Definir senha String: 8 a 15 caracteres; a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, e . (ponto). Defina uma senha apenas para um novo usuário.
    ID Principal Número de ID gerado pelo sistema de um usuário principal do Active Directory que criou um novo usuário.
    Permissão ID de permissão específica.
    Recurso de licença Licença da Automation Anywhere associada a essa função.
    Funções: id Número de ID da função associada a esse usuário, gerado pelo sistema. Nem todo usuário tem uma função associada.
    Criado por Número de ID gerado pelo sistema de um usuário administrador que criou um novo usuário.
    Atualizado por Número de ID gerado pelo sistema de um usuário administrador que atualizou o usuário.
Send Feedback (Enviar Feedback)