API Buscar usuarios

Utilice la API Buscar usuarios para buscar todos los usuarios en Control Room.

Solicitud

POST http://{{ControlRoomURL}}/v1/usermanagement/users/list

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

Todas las llamadas a la API deben contener un identificador de autenticación de API de autenticación (genera identificador web JSON) o un identificador de portador de servicios OAuth. No se pueden utilizar ambos a la vez en una API.

Para buscar usuarios, debe tener uno de los siguientes:

Rol de Administrador
Rol personalizado con permiso para Ver usuarios

Cuerpo de la solicitud:

{
  "filter": {
    "operator": "and",
    "operands": [
      "substring"
    ],
    "field": "name",
    "value": "device"
  },
  "sort": [
    {
      "field": "name",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "total": 100,
    "totalFilter": 100
  }
}

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
ordenar	Matriz	No	Los resultados de búsqueda se clasifican en orden descendente con respecto a sus identificadores. Para especificar una clasificación alternativa, utilice el parámetro de consulta ordenar. Ingrese el campo por el que desea ordenar junto con la dirección `asc` (ascendente) o `desc` (descendente).
filtrar	Objeto	No	Filtra el resultado.
página	Objeto	No	El objeto de página permite obtener los número de las páginas deseadas.

Para obtener más información sobre el filtrado, la paginación y la clasificación, consulte Filtrado, paginación y clasificación.

Respuesta

{
    {
  "page": {
    "offset": 0,
    "total": 100,
    "totalFilter": 100
  },
  "list": [
    {
      "id": 110,
      "roles": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "permissions": [
        {
          "id": 59,
          "action": "managecredentials",
          "resourceId": null,
          "resourceType": "credentials"
        }
      ],
      "licenseFeatures": [
        "DEVELOPMENT"
      ],
      "principalId": 110,
      "domain": null,
      "email": "xyz@automationanywhere.com",
      "emailVerified": true,
      "passwordSet": true,
      "questionsSet": true,
      "enableAutoLogin": true,
      "username": "bot_creator",
      "firstName": "Mike",
      "lastName": "Bots",
      "description": "User to manage bots",
      "disabled": true,
      "clientRegistered": true,
      "createdBy": 27,
      "createdOn": "2022-03-17T19:32:20.620Z",
      "updatedBy": 29,
      "updatedOn": "2022-03-24T02:20:13.787Z"
    }
  ]
}

Parámetros de respuesta


Parámetro	Tipo	Descripción
compensación	Entero	El desplazamiento de la lista inicial, utilizado para la paginación.
total	Entero	Cantidad total de registros.
Filtrototal	Entero	Número de registros después de aplicar el filtro.
Lista	Matriz	Matriz de objeto de roles de listas.
Objeto de roles de listas
id	Entero	Id único de un rol específico.
nombre	Cadena	Nombre de rol.
permisos	Matriz	Colección de permisos únicos que se asignaron al rol.
licenseFeatures	Cadena	Características de la licencia que incluyen lo siguiente: DESARROLLO - TIEMPO DE EJECUCIÓN - IQBOTRUNTIME - ANALYTICSCLIENT - ANALYTICSAPI
descripción	Cadena	Descripción del rol.
principalId	Número	ID único del usuario principal.
correo electrónico	Entero	ID del correo electrónico del usuario.
emailVerified	Booleano	Indica si el ID de correo electrónico fue verificado.
establecerContraseña	Booleano	Indica si el usuario estableció su contraseña.
enableAutoLogin	Booleano	Indica si el inicio de sesión automático está habilitado para el usuario.
nombre de usuario	Cadena	Nombre de inicio de sesión del usuario.
firstName	Cadena	Nombre especificado para el usuario.
lastName	Cadena	Apellido especificado para el usuario.
creado por	Entero	ID del usuario que creó el rol.
creado el	Cadena	Marca de tiempo cuando se creó el rol.
actualizado por	Entero	ID del usuario que actualizó por última vez el rol.
actualizado el	Cadena	Marca de tiempo cuando el rol se actualizó por última vez.
systemRole	Booleano	Indica si este rol es o no un rol de sistema.

Nota: Puede ver Control Room APIs en la Community Edition, pero la funcionalidad de la API está limitada. Necesita una Edition de Automatización 360 con licencia para acceder a la funcionalidad completa de las API.

La API REST responde a cada solicitud con un código de respuesta HTTP. Para ver los códigos de respuesta, consulte Códigos de respuesta de API.