Saltar al contenido principal
GET
/
v1
/
providers
Listar proveedores
curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/providers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b",
    "name": "sendgrid-primary",
    "category": "Email",
    "type": "SendGrid",
    "host": "smtp.sendgrid.net",
    "port": 587,
    "disableSsl": false,
    "createdAt": "2025-04-08T08:01:30.000Z"
  },
  {
    "id": "019c96a0-1b20-7bcd-e1f2-9d0e1f2a3b4c",
    "name": "twilio-sms",
    "category": "SMS",
    "type": "Twilio",
    "disableSsl": false,
    "createdAt": "2025-04-07T18:57:57.312Z"
  }
]

Autorizaciones

​
Authorization
string
header
requerido

El token de autorización en formato 'Bearer '.

Respuesta

La lista de todos los proveedores configurados en el sistema.

​
id
string

Identificador único del proveedor.

​
name
string

Nombre del proveedor.

​
category
enum<string>

Categoría del proveedor.

Opciones disponibles:
Email,
SMS
​
type
enum<string>

Tipo de implementación del proveedor.

Opciones disponibles:
SendGrid,
Twilio
​
subType
string

Subtipo del proveedor, si corresponde.

​
method
string

Método de autenticación o entrega.

​
clientId
string

Identificador de cliente o clave API (el secreto nunca se devuelve).

​
clientId2
string

Identificador de cliente secundario, si corresponde.

​
host
string

Dirección del host SMTP o de la API.

​
port
integer

Puerto SMTP.

​
disableSsl
boolean

Indica si SSL/TLS está deshabilitado.

​
title
string

Título o asunto predeterminado del correo electrónico o SMS.

​
content
string

Plantilla de contenido de mensaje predeterminada.

​
receiver
string

Dirección del receptor predeterminada para pruebas.

​
regionId
string

ID de región en la nube (específico del proveedor).

​
signName
string

Nombre de firma SMS (específico del proveedor).

​
templateCode
string

Código de plantilla SMS (específico del proveedor).

​
appId
string

Identificador de la aplicación (específico del proveedor).

​
endpoint
string

URL del endpoint de la API del proveedor.

​
intranetEndpoint
string

Endpoint de intranet para el acceso a la red privada.

​
domain
string

Dominio del proveedor.

​
providerUrl
string

URL específica del proveedor.

​
createdAt
string<date-time>

Marca de tiempo que indica cuándo se creó el proveedor.