Search Multiple Profiles
Este endpoint permite recuperar la información de un listado de perfiles asociados a la compañia. Como respuesta, se entrega un arreglo de diccionarios con información sobre distintos perfil.
Se puede personalizar el arreglo presente en la respuesta con los parámetros de búsqueda page y per_page, los cuales controlan la páginación de la respuesta. Sus valores por defecto son 1 y 5, respectivamente.
También se encuentran los parámetros fields, el cuál es un string separado por comas regula cuales de los campos de los perfiles son mostrados en las respuestas; y el parámetro disabled_profile, el cuál es un valor booleano, que al tomar un valor true.
Además se puede incluir en el cuerpo de la request campos de un perfil como llave y añadir un string como valor para realizar una búsqueda con perfiles que tengan ese valor.
Endpoint#
Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json | |
| Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Query Params
Los filtros disponibles son los siguientes:
| Field | Description |
|---|---|
| page | Posición de la página a visualizar. |
| per_page | Número de elementos presentes dentro de una página. |
| fields | String separado por comas que contiene los campos a visualizar en respuesta. Valores permitidos: nin, origin, username, phone_number, email, name, lastname, birthday, nationality, timezone |
| disabled_profile | Campo booleano que indica si la busqueda debe incluir perfiles deshabilitados. Sólo puede tomar el valor true |
Path Variables:
| Key | Value Example | Description |
|---|---|---|
| company_id | -1 | Identificador de la compañia, provisto por la empresa Trust. Obligatorio |
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea.
Body#
Fields#
Dentro del body, se da la opción de realizar un filtrado más fino, al indicar campos de usuario como llaves y asignarle valores, lo que conlleva a realizar una consultar por todos los usuarios que contenga dicho valor en ese campo.
Todos los campos pueden recibir como valor un string con un valor específico o un arreglo de string, permitiendo generar alternativas de valores (Similar a un operador or).
- nin: Filtro por identificador Único Nacional de la persona a registrar.
- origin: Filtro por subdivisión interna de la compañia aplicada al perfil de usuario.
- username: Filtro por apodo o identificador personalizado creado por el usuario.
- phone_number: Filtro por número de teléfono utilizado por el usuario para el contacto.
- email: Filtro por correo electrónico utilizado por el usuario para el contacto
- name: Filtro por nombre de pila del usuario.
- lastname: Filtro por apellido o nombre de familia del usuario.
- birthday: Filtro por fecha de nacimiento del usuario.
- nationality: Filtro por país de nacimiento del usuario.
- timezone: Filtro por zona horaria utilizada por el usuario.
- active: Filtro por valor booleano que setea el estado de acceso al usuario.
- created_at: Permite filtrar usando la fecha de creación del dispositivo.
- updated_at: Permite filtrar usando la fecha de actualización del dispositivo.
Example#
Code Examples#
- Curl
- JavaScript
- Python