Get All Users
Este endpoint permite realizar una búsqueda avanzada de usuarios, con la posibilidad de agregar múltiples criterios para la búsqueda. Como respuesta se da un arreglo con los usuarios que cumplen el criterio de búsqueda planteado. Los valores por defecto page y per_page son 1 y 5, respectivamente.
Endpoint
Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json | |
| Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Method: GET
URL: https://atenea.trust.lat/users
Query Params:
| Key | Value Example | Description |
|---|---|---|
| fields | trust_id, system_name | Filtro que permite mostrar sólo los campos solicitados, si se desea retornar todo el contenido de la respuesta, omitir el parámetro. |
| search | inmo | Parámetro que permite buscar usuarios específicos por su 'email', 'dni', 'name' o 'last_name'. |
| status | false | Filtro utilizado para distinguir entre usuarios activos (true) o inactivos (false). |
| per_page | 10000 | Número de elementos presentes dentro de una página. |
| page | 1 | Posición de la página a visualizar. |
| from_date | 2020-03-24 | Rango inicial para filtrar por la fecha de creación de un usuario. |
| until_date | 2020-06-30 | Rango final para filtrar por la fecha de creación de un usuario. |
| rol | rol_1, rol_2 | Búsqueda por rol/roles asociada a los usuarios. |
| confirmed | true | Indica si se desea retornar los usuarios con cuenta confirmada (true) o no (false). |
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea
Code Examples
- Curl
- JavaScript
- Python
curl --location --request GET 'https://atenea.trust.lat/users?fields=email,%20name,%20last_name,%20dni&search=abeta@example.test&status=true&per_page=30&page=1' \
--header 'Authorization: Bearer *********' \
--data-raw ''
import requests
url = "https://atenea.trust.lat/users?fields=email, name, last_name, dni&search=abeta@example.test&status=true&per_page=30&page=1"
payload={}
headers = {
'Authorization': 'Bearer *********'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var data = '';
var config = {
method: 'get',
url: 'https://atenea.trust.lat/users?fields=email, name, last_name, dni&search=abeta@example.test&status=true&per_page=30&page=1',
headers: {
'Authorization': 'Bearer *********'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Responses
HTTP Code: 200 OK
Query successful, default query
{
"status": true,
"message": "ok",
"total": 1234,
"user": [
{
"id": 9133,
"email": "anger@live.clue",
"dni": "12345678-8",
"name": "Alfa",
"confirmed": true
},
{
"id": 9022,
"email": "fonlez10@example.lat",
"dni": "111111111-2",
"name": "Flip",
"confirmed": true
},
{
"id": 9255,
"email": "1sads@asdsa.com",
"dni": "123123123-1",
"name": "Exampler",
"confirmed": false
},
{
"id": 9917,
"email": "dapi53@pit.example",
"dni": "19999999-9",
"name": "Tester",
"confirmed": false
},
{
"id": 9233,
"email": "plippi1231@dasad.tal",
"dni": "434354365345_34534",
"name": "Beta",
"confirmed": true
}
],
"page": 1
}
All users with roles displayed example
{
"status": true,
"message": "ok",
"total": 37,
"user": [
{
"id": 9763,
"email": "daniloctavio234@gfakemailggg3.com",
"dni": "132696275-6",
"name": "Gamma",
"last_name": "Kappa",
"role": [
{
"id": 6,
"name": "roll_user",
"formal_name": "Roll User"
}
]
},
{
"id": 9850,
"email": "syddanilo234@gfakemailggg3.com",
"dni": "128105755-1",
"name": "Tester",
"last_name": "Kappa",
"role": [
{
"id": 6,
"name": "roll_user",
"formal_name": "Roll User"
}
]
},
{
"id": 9202,
"email": "63correofake@aasd.com",
"dni": "132696275-6",
"name": "Etha",
"last_name": "Omega",
"role": [
{
"id": 6,
"name": "roll_user",
"formal_name": "Roll User"
}
]
},
{
"id": 9343,
"email": "151correofake@aasd.com",
"dni": "128105755-1",
"name": "Delta",
"last_name": "Phi",
"role": [
{
"id": 6,
"name": "roll_user",
"formal_name": "Roll User"
}
]
},
{
"id": 9947,
"email": "dtap@example.test",
"dni": "918237990-5",
"name": "Exampler",
"last_name": "Kappa",
"role": [
{
"id": 1,
"name": "roll_admin",
"formal_name": "Roll Admin"
},
{
"id": 5,
"name": "roll_super_admin",
"formal_name": "Roll Super Admin"
},
{
"id": 6,
"name": "roll_user",
"formal_name": "Roll User"
},
{
"id": 7,
"name": "not_super_admin",
"formal_name": "Not Super Admin"
},
{
"id": 8,
"name": "not_admin",
"formal_name": "Not Admin"
},
{
"id": 3,
"name": "not_user",
"formal_name": "Not User"
},
{
"id": 2,
"name": "test_admin",
"formal_name": "Test Admin"
}
]
}
],
"page": "7"
}
HTTP Code: 404 Not Found
Query failed, no matching users with the query params
{
"status": false,
"message": "Users not found"
}