Create a Provider - Lerian

Create a Provider

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
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://identity.sandbox.lerian.net/v1/providers"

	payload := strings.NewReader("{\n  \"name\": \"sendgrid-primary\",\n  \"category\": \"Email\",\n  \"type\": \"SendGrid\",\n  \"clientId\": \"SG.your_api_key_here\",\n  \"clientSecret\": \"your_secret\",\n  \"host\": \"smtp.sendgrid.net\",\n  \"port\": 587,\n  \"disableSsl\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'sendgrid-primary',
    category: 'Email',
    type: 'SendGrid',
    clientId: 'SG.your_api_key_here',
    clientSecret: 'your_secret',
    host: 'smtp.sendgrid.net',
    port: 587,
    disableSsl: false
  })
};

fetch('https://identity.sandbox.lerian.net/v1/providers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://identity.sandbox.lerian.net/v1/providers"

payload = {
    "name": "sendgrid-primary",
    "category": "Email",
    "type": "SendGrid",
    "clientId": "SG.your_api_key_here",
    "clientSecret": "your_secret",
    "host": "smtp.sendgrid.net",
    "port": 587,
    "disableSsl": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

POST

/

v1

/

providers

Create a Provider

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
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://identity.sandbox.lerian.net/v1/providers"

	payload := strings.NewReader("{\n  \"name\": \"sendgrid-primary\",\n  \"category\": \"Email\",\n  \"type\": \"SendGrid\",\n  \"clientId\": \"SG.your_api_key_here\",\n  \"clientSecret\": \"your_secret\",\n  \"host\": \"smtp.sendgrid.net\",\n  \"port\": 587,\n  \"disableSsl\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'sendgrid-primary',
    category: 'Email',
    type: 'SendGrid',
    clientId: 'SG.your_api_key_here',
    clientSecret: 'your_secret',
    host: 'smtp.sendgrid.net',
    port: 587,
    disableSsl: false
  })
};

fetch('https://identity.sandbox.lerian.net/v1/providers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://identity.sandbox.lerian.net/v1/providers"

payload = {
    "name": "sendgrid-primary",
    "category": "Email",
    "type": "SendGrid",
    "clientId": "SG.your_api_key_here",
    "clientSecret": "your_secret",
    "host": "smtp.sendgrid.net",
    "port": 587,
    "disableSsl": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

The authorization token in the 'Bearer ' format.

Cuerpo

application/json

Information required to create a new communication provider.

name

string

requerido

A unique name to identify the provider.

category

enum<string>

requerido

The provider category.

Opciones disponibles:

Email,

SMS

type

enum<string>

requerido

The provider implementation type.

Opciones disponibles:

SendGrid,

Twilio

subType

string

Provider sub-type, if applicable.

method

string

Authentication or delivery method.

clientId

string

Client ID or API key for authenticating with the provider.

clientSecret

string

Client secret or API secret for authenticating with the provider.

clientId2

string

Secondary client ID, if applicable.

clientSecret2

string

Secondary client secret, if applicable.

host

string

SMTP or API host address (Email providers).

port

integer

SMTP port (Email providers).

disableSsl

boolean

predeterminado:false

Set to true to disable SSL/TLS (not recommended for production).

title

string

Default email or SMS title/subject.

content

string

Default message content template.

receiver

string

Default receiver address for testing.

regionId

string

Cloud region ID (provider-specific).

signName

string

SMS signature name (provider-specific).

templateCode

string

SMS template code (provider-specific).

appId

string

Application ID (provider-specific).

endpoint

string

Provider API endpoint URL.

intranetEndpoint

string

Intranet endpoint for private network access.

domain

string

Provider domain.

Respuesta

Indicates that the provider was successfully created and the operation was completed as expected.

Information about a communication provider.

id

string

Unique identifier of the provider.

name

string

Name of the provider.

category

enum<string>

Provider category.

Opciones disponibles:

Email,

SMS

type

enum<string>

Provider implementation type.

Opciones disponibles:

SendGrid,

Twilio

subType

string

Provider sub-type, if applicable.

method

string

Authentication or delivery method.

clientId

string

Client ID or API key (secret is never returned).

clientId2

string

Secondary client ID, if applicable.

host

string

SMTP or API host address.

port

integer

SMTP port.

disableSsl

boolean

Indicates whether SSL/TLS is disabled.

title

string

Default email or SMS title/subject.

content

string

Default message content template.

receiver

string

Default receiver address for testing.

regionId

string

Cloud region ID (provider-specific).

signName

string

SMS signature name (provider-specific).

templateCode

string

SMS template code (provider-specific).

appId

string

Application ID (provider-specific).

endpoint

string

Provider API endpoint URL.

intranetEndpoint

string

Intranet endpoint for private network access.

domain

string

Provider domain.

providerUrl

string

Provider-specific URL.

createdAt

string<date-time>

Timestamp marking when the provider was created.