Request Profile Password Change

Este endpoint permite solicitar un cambio una contraseña de un usuario. Si esta operación es exitosa, derivará en el envío de un correo al email registrado por el usuario con un token utilizado para la confirmación 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 request 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.

Example

Solicitud Por Email

{
  "operation": "request",
  "access_type": "email",
  "profile": "tlat@email.com"
}

Solicitud Por Username

{
  "operation": "request",
  "access_type": "username",
  "profile": "user_2022"
}

Code Examples

Curl

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": "request",
  "access_type": "email",
  "profile": "tlat@email.com"
}'

JavaScript

import requests
import json

url = "https://api.trust.lat/trust-idp/v1/companies/:company_id/profiles/password"

payload = json.dumps({
  "operation": "request",
  "access_type": "email",
  "profile": "tlat@email.com"
})
headers = {
  'Authorization': 'Bearer `{{access_token}}`',
  'Content-Type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

Python

var axios = require('axios');
var data = JSON.stringify({
  "operation": "request",
  "access_type": "email",
  "profile": "tlat@email.com"
});

var config = {
  method: 'patch',
  url: 'https://api.trust.lat/trust-idp/v1/companies/:company_id/profiles/password',
  headers: { 
    'Authorization': 'Bearer `{{access_token}}`', 
    '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

Request Password Change Successful

{
    "code": 200,
    "resource": "Password token",
    "data": "The token for password change was sent successfullly",
    "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"
}

HTTP Code: 404 Not Found

Profile Not Found

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