Buscar usuarios
Utilice la API Buscar usuarios para buscar todos los usuarios en el Control Room.
Antes de empezar
- Ver usuarios
- Los usuarios que tienen permisos para
ver usuarios
pueden recuperar todos los usuarios.
- URL:
http://<your_control_room_url>/v1/usermanagement/users/list
Reemplace el contenido en los soportes angulares con la URL de su Control Room.
- Método: POST
- Utilice los archivos de definición de Swagger instalados con su Control Room para probar las API. Vea las API de Swagger disponibles en:
http://<your_control_room_url>/swagger/
. - También puede utilizar un cliente REST para completar esta tarea.
Procedimiento
-
Agregue un token de autenticación a la cabecera de la solicitud.
Utilice la API Autenticación para generar un Web Token JSON. Consulte API de autenticación.
-
Seleccione POST como método.
Aplique filtros para realizar consultas condicionales básicas y control de paginación para procesar páginas web. Existen tres características básicas relacionadas con el filtrado: condiciones de filtrado, orden de columnas y parámetros de paginación. Consulte Filtros en un cuerpo de solicitud de API.
PUBLICAR http://<your_control_room_url>/v1/usermanagement/users/list
-
Envíe la solicitud.
- En un cliente REST, haga clic en ENVIAR.
- En la interfaz de Swagger, haga clic en Ejecutar.
Cuerpo de la solicitud:
La siguiente solicitud encuentra a todos los usuarios con unnombre de usuario
que contieneadmin
y que fueron creados entre el 1 de septiembre y el 6 de septiembre 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" } ] } }
La respuesta en este ejemplo devolvió datos para dos nombres de usuario que contenían la palabra
admin
,mdadmin
ymt_admin
.Cuerpo de la respuesta:{ "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 del cuerpo de la respuesta:Nombre del parámetro Descripción ID Número de ID generado por el sistema que creó un usuario. nombredeusuario Nombre de usuario para un nuevo usuario. dominio Nombre de dominio en Active Directory versión Número de versión generado por el sistema para un nuevo usuario. correoelectrónico Nueva dirección de correo electrónico del usuario. establecerContraseña Cadena: de 8 a 15 caracteres; a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, y . (punto). Establece una contraseña solo para un nuevo usuario. IDprincipal Número de ID generado por el sistema para un usuario principal en Active Directory que creó un nuevo usuario. Permiso Una ID de permiso específico. característicadeLicencia Licencia de Automation Anywhere asociada con este rol. Roles: id Número de ID del rol generado por el sistema asociado con este usuario. No todos los usuarios tienen un rol asociado. "-", "createdBy": Número de ID generado por el sistema de un usuario administrador que creó un nuevo usuario. ActualizadoPor Número de ID generado por el sistema de un usuario administrador que actualizó el usuario.