Crear un proveedor

Utiliza este endpoint para registrar un nuevo proveedor de comunicación (correo electrónico o SMS) para usar en los flujos de autenticación y notificación.

POST /v1/providers

Crear un proveedor

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "sendgrid-primary",
  "category": "Email",
  "type": "SendGrid",
  "clientId": "SG.your_api_key_here",
  "clientSecret": "your_secret",
  "host": "smtp.sendgrid.net",
  "port": 587,
  "disableSsl": false
}
'

201

Example

{
  "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"
}

Autorizaciones

Authorization · string · header · requerido

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

Cuerpo

application/json

Información necesaria para crear un nuevo proveedor de comunicación.

name · string · requerido

Nombre único para identificar al proveedor.

category · enum<string> · requerido

Categoría del proveedor.

Opciones disponibles: Email, SMS

type · enum<string> · requerido

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 para autenticarse con el proveedor.

clientSecret · string

Secreto de cliente o secreto de API para autenticarse con el proveedor.

clientId2 · string

Identificador de cliente secundario, si corresponde.

clientSecret2 · string

Secreto de cliente secundario, si corresponde.

host · string

Dirección del host SMTP o de la API (proveedores de correo electrónico).

port · integer

Puerto SMTP (proveedores de correo electrónico).

disableSsl · boolean · predeterminado: false

Establece en true para deshabilitar SSL/TLS (no recomendado en producción).

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.

Respuesta

201

application/json

Indica que el proveedor se creó correctamente y que la operación se completó según lo esperado.

Información sobre un proveedor de comunicación.

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.