Skip to main content

Show Profile

Este endpoint permite recuperar la información de un perfil, señalado indicada por la variable de ruta uuid, en el servicio Trust IDP.

En la respuesta, se entrega toda la información que conforma un perfil: uuid, nin, username, phone_number, email, origin, name, lastname, birthday, nationality, timezone, two_factor_authentication, active, identification_provider. Para mayor información sobre estos campos, revisar endpoint de creación de perfil de usuario.

Endpoint#

Headers

KeyValueDescription
Content-Typeapplication/json
AuthorizationBearer {{access_token}}access_token obtained in Atenea
Method: GET
URL: https://api.trust.lat/trust-idp/v1/companies/:company_id/profiles/:uuid

Query Params

Los filtros disponibles son los siguientes:

FieldDescription
disabled_profileCampo booleano que indica si la busqueda debe incluir perfiles deshabilitados. Sólo puede tomar el valor true

Path Variables:

KeyValue ExampleDescription
company_id-1Identificador de la compañia, provisto por la empresa Trust. Obligatorio
uuidffffffff-ffff-ffff-ffff-ffffffffffffIdentificador único del perfil de usuario. Obligatorio.
caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea.

Como obtener un access token

Code Examples#

curl --location --request GET 'https://api.trust.lat/trust-idp/v1/companies/:company_id/profiles/:uuid' \
--header 'Authorization: Bearer {{access_token}}'

Responses#

HTTP Code: 200 OK#

Profile Found#

{
"code": 200,
"resource": "Profile",
"data": {
"uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"nin": "123456789",
"username": null,
"phone_number": null,
"email": null,
"origin": "test_idp",
"name": "trust",
"lastname": "latin",
"birthday": null,
"nationality": null,
"timezone": null,
"two_factor_authentication": [],
"active": true,
"identification_provider": "trust"
},
"message": "Found"
}

Profile Disabled Found#

{
"code": 200,
"resource": "Profile",
"data": {
"uuid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"nin": "123456789",
"username": null,
"phone_number": null,
"email": null,
"name": "trust",
"origin": "test_idp",
"lastname": "latin",
"birthday": null,
"nationality": null,
"timezone": null,
"two_factor_authentication": [],
"active": false,
"identification_provider": "trust"
},
"message": "Found"
}

HTTP Code: 401 Unauthorized#

Missing Access Token#

{
"status": 401,
"error": "Invalid or expired token"
}

HTTP Code: 404 Not Found#

Profile Not Present/Not Available In Service#

{
"code": 404,
"resource": "Profile",
"message": "Not found"
}
Last updated on by Jesus Marquez