Confirm Profile Password Change

Este endpoint permite confirmar un cambio una contraseña de un usuario. Si esta operación es exitosa, el usuario podrá utilizar la contraseña nueva para hacer uso de las distintas operaciones del servicio. Para ejecutar este endpoint, se debe contar con un token generado por el endpoint solicitud del cambio de contraseña.

Este endpoint se encuentra operativo sólo para compañias que identifican a sus usuarios con los campos email o username.

Endpoint#

Headers

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {{access_token}}	access_token obtained in Atenea

Method: PATCH
URL: https://api.trust.lat/trust-idp/v1/companies/:company_id/profiles/password

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.

Como obtener un access token

Body#

Fields#

operation: Parámetro utilizado para específicar la operación a ejecutar. Debe tener por valor confirm para este endpoint. Obligatorio.
access_type: Llave utilizada indicar que campo se debe utilizar para buscar al usuario que solicita el cambio de clave. Sólo puede tomar los valores email o username. Obligatorio.
profile: Llave que contiene el valor del usuario para el campo indicado en la llave access_type. Obligatorio.
token: String alfanúmerico recibido en correo de solicitud de cambio de contraseña. Obligatorio.
password: Nuevo string de carácteres únicos creados por el usuario para utilizar como medio de autenticación.

Example#

Solicitud Por Email#

{
    "operation": "confirm",
    "access_type": "email",
    "profile": "tlat@email.com",
    "token": "ffffffffffffffffffff",
    "password": "********"
}

Solicitud Por Username#

{
  "operation": "confirm",
  "access_type": "username",
  "profile": "user_2022",
  "token": "ffffffffffffffffffff",
  "password": "********"
}

Code Examples#

Curl
JavaScript
Python

curl --location --request PATCH 'https://api.trust.lat/trust-idp/v1/companies/:company_id/profiles/password' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation": "confirm",
    "access_type": "email",
    "profile": "tlat@email.com",
    "token": "ffffffffffffffffffff",
    "password": "********"
}'

Responses#

HTTP Code: 200 OK#

Confirm Password Change Successful#

{
    "code": 200,
    "resource": "Confirm Change Password",
    "data": "The password was changed successfully",
    "message": "Ok"
}

HTTP Code: 400 Bad Request#

Invalid Operation#

{
    "code": 400,
    "resource": "Change Password",
    "message": "Bad request",
    "errors": "Operation field is null or not supported"
}

Invalid Access Type#

{
    "code": 400,
    "resource": "Change Password",
    "message": "Bad request",
    "errors": "access_type field is null or not supported"
}

Invalid Password Change's Token#

{
    "code": 400,
    "resource": "Confirm Change Password",
    "message": "Bad request",
    "errors": "The token is not valid"
}

HTTP Code: 404 Not Found#

Profile Not Found#

{
    "code": 404,
    "resource": "Profile",
    "message": "Not found"
}