Update User
Endpoint que permite actualizar uno o más campos de un usuario dentro del servicio. Dicho usuario es identificado utilizando la variable de ruta id.
Endpoint
Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Method: PUT
URL: https://atenea.trust.lat/users/:id
Path Variables:
Key | Value Example | Description |
---|---|---|
id | 9999 | Identificador único del usuario dentro del servicio. Sinónimo de user_id. Obligatorio. |
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea
Body
Fields
- email : Correo electrónico del usuario a incorporar. Opcional.
- name : Nombre del usuario a incorporar. Opcional.
- last_name : Apellido del usuario a incorporar. Opcional.
- dni : Número de identificación personal del usuario. Opcional.
- company_uid : Identificador de compañia provisto por empresa Trust. Opcional.
- role : Etiqueta que indica el nivel de acceso y privilegios que tiene el usuario dentro de los servicios de Trust. Opcional.
- nationality : Texto que indica el país de origen del usuario. Opcional.
- img : Dirección URL que apunta a la imagen que representa al usuario. Opcional.
- invitation : Valor booleando que indica si es necesario solicitar una confirmación por correo electrónico de la creación del usuario. Opcional.
- load_uuid : Identificador otorgado a grupo de usuarios creado por una carga masiva de datos. Opcional.
- phone_number : Número telefónico del usuario. Opcional.
Example
{
"email": "abeta@example.test",
"name": "Alfa",
"last_name": "Beta",
"dni": "12345678-9",
"company_uid": "99",
"role": "test_admin",
"nationality": "CHL",
"img": "https://robohash.org/12312312",
"invitation": false,
"load_uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"phone_number": "+56912345678"
}
Code Examples
- Curl
- JavaScript
- Python
curl --location --request PUT 'https://atenea.trust.lat/users/9999' \
--header 'Authorization: Bearer *********' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "abeta@example.test",
"name": "Alfa",
"last_name": "Beta",
"dni": "12345678-9",
"company_uid": "99",
"role": "test_admin",
"nationality": "CHL",
"img": "https://robohash.org/12312312",
"invitation": false,
"load_uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"phone_number": "+56912345678"
}'
import requests
url = "https://atenea.trust.lat/users/9999"
payload="{\n\t\"email\": \"abeta@example.test\",\n\t\"name\": \"Alfa\",\n\t\"last_name\": \"Beta\",\n\t\"dni\": \"12345678-9\",\n\t\"company_uid\": \"99\",\n\t\"role\": \"test_admin\",\n\t\"nationality\": \"CHL\",\n\t\"img\": \"https://robohash.org/12312312\",\n\t\"invitation\": false,\n\t\"load_uuid\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n\t\"phone_number\": \"+56912345678\"\n}"
headers = {
'Authorization': 'Bearer *********',
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var data = JSON.stringify({"email":"abeta@example.test","name":"Alfa","last_name":"Beta","dni":"12345678-9","company_uid":"99","role":"test_admin","nationality":"CHL","img":"https://robohash.org/12312312","invitation":false,"load_uuid":"ffffffff-ffff-ffff-ffff-ffffffffffff","phone_number":"+56912345678"});
var config = {
method: 'put',
url: 'https://atenea.trust.lat/users/9999',
headers: {
'Authorization': 'Bearer *********',
'Content-Type': 'application/json'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Responses
HTTP Code: 200 OK
Company not present in Trust Services
{
"status": true,
"message": "User updated",
"user": {
"id": 2878,
"name": "Alfa",
"last_name": "Beta",
"dni": "12345678-9",
"phone_number": "+56912345678",
"nationality": "CHL",
"img": "https://robohash.org/12312312",
"load_uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"email": "abeta@example.test",
"created_at": "2021-07-22T20:29:21.665Z",
"updated_at": "2021-07-22T20:29:21.668Z",
"company_uid": "99",
"status": true,
"confirmed": true
},
"roles": []
}
Updated role of a user
{
"status": true,
"message": "User with role updated",
"user": {
"id": 2878,
"email": "abeta@example.test",
"created_at": "2021-07-22T20:29:21.665Z",
"updated_at": "2021-07-22T20:30:39.179Z",
"dni": "12345678-9",
"phone_number": "+56912345678",
"name": "Alfa",
"last_name": "Beta",
"company_uid": null,
"status": true,
"img": "https://robohash.org/12312312",
"nationality": "CHL",
"load_uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"confirmed": true
},
"roles": [
{
"id": 2,
"name": "test_admin",
"formal_name": "Test Admin"
}
]
}