Show Company Configuration

Este endpoint permite recuperar la configuración de la compañia, indicada por la variable de ruta company_id, en el servicio Trust IDP.

Como respuesta, se entrega información sobre los campos utilizados para identificar los usuarios (unique_fields), la relación entre estos campos (unique_fields_relation), el nombre de la compañia (company_name), un arreglo con los registros permitidos, en una tupla de nombre de registro y provedor de información (allowed_registers) y un arreglo con los nombres de los login permitidos por la compañia (allowed_logins).

Endpoint

Headers

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

Method: GET
URL: https://api.trust.lat/trust-idp/v1/companies/:company_id

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

Code Examples

Curl

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

JavaScript

import requests

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

payload={}
headers = {
  'Authorization': 'Bearer `{{access_token}}`'
}

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

print(response.text)

Python

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.trust.lat/trust-idp/v1/companies/:company_id',
  headers: { 
    'Authorization': 'Bearer `{{access_token}}`'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Responses

HTTP Code: 200 OK

Company Found

{
    "code": 200,
    "resource": "Company Config",
    "data": {
        "company_id": "-1",
        "unique_fields": [
            "nin",
            "email",
            "username"
        ],
        "unique_fields_relation": "or",
        "company_name": "Test Company",
        "allowed_registers": [
          "bio_register:trust",
          "email_register:trust",
          "user_register:trust"
        ],
        "allowed_logins": [
          "nin_userid_login",
          "email_pass_login",
          "user_pass_login"
        ]
    },
    "message": "Found"
}

HTTP Code: 401 Unauthorized

Invalid Token

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

HTTP Code: 403 Forbidden

Forbidden

{
    "code": 403,
    "message": "Forbidden"
}

HTTP Code: 404 Not Found

Company Not Found

{
    "code": 404,
    "resource": "Company Config",
    "message": "Not found"
}