Update a Provider
curl --request PATCH \
--url https://identity.sandbox.lerian.net/v1/providers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"appId": "<string>",
"clientId": "<string>",
"clientId2": "<string>",
"clientSecret": "<string>",
"clientSecret2": "<string>",
"content": "<string>",
"customAuthUrl": "<string>",
"customTokenUrl": "<string>",
"customUserInfoUrl": "<string>",
"disableSsl": true,
"domain": "<string>",
"endpoint": "<string>",
"host": "<string>",
"intranetEndpoint": "<string>",
"issuerUrl": "<string>",
"method": "<string>",
"name": "<string>",
"port": 123,
"receiver": "<string>",
"regionId": "<string>",
"scopes": "<string>",
"signName": "<string>",
"subType": "<string>",
"templateCode": "<string>",
"title": "<string>"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://identity.sandbox.lerian.net/v1/providers/{id}"
payload := strings.NewReader("{\n \"appId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientId2\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"clientSecret2\": \"<string>\",\n \"content\": \"<string>\",\n \"customAuthUrl\": \"<string>\",\n \"customTokenUrl\": \"<string>\",\n \"customUserInfoUrl\": \"<string>\",\n \"disableSsl\": true,\n \"domain\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"host\": \"<string>\",\n \"intranetEndpoint\": \"<string>\",\n \"issuerUrl\": \"<string>\",\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"port\": 123,\n \"receiver\": \"<string>\",\n \"regionId\": \"<string>\",\n \"scopes\": \"<string>\",\n \"signName\": \"<string>\",\n \"subType\": \"<string>\",\n \"templateCode\": \"<string>\",\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
appId: '<string>',
clientId: '<string>',
clientId2: '<string>',
clientSecret: '<string>',
clientSecret2: '<string>',
content: '<string>',
customAuthUrl: '<string>',
customTokenUrl: '<string>',
customUserInfoUrl: '<string>',
disableSsl: true,
domain: '<string>',
endpoint: '<string>',
host: '<string>',
intranetEndpoint: '<string>',
issuerUrl: '<string>',
method: '<string>',
name: '<string>',
port: 123,
receiver: '<string>',
regionId: '<string>',
scopes: '<string>',
signName: '<string>',
subType: '<string>',
templateCode: '<string>',
title: '<string>'
})
};
fetch('https://identity.sandbox.lerian.net/v1/providers/{id}', 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/{id}"
payload = {
"appId": "<string>",
"clientId": "<string>",
"clientId2": "<string>",
"clientSecret": "<string>",
"clientSecret2": "<string>",
"content": "<string>",
"customAuthUrl": "<string>",
"customTokenUrl": "<string>",
"customUserInfoUrl": "<string>",
"disableSsl": True,
"domain": "<string>",
"endpoint": "<string>",
"host": "<string>",
"intranetEndpoint": "<string>",
"issuerUrl": "<string>",
"method": "<string>",
"name": "<string>",
"port": 123,
"receiver": "<string>",
"regionId": "<string>",
"scopes": "<string>",
"signName": "<string>",
"subType": "<string>",
"templateCode": "<string>",
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"appId": "<string>",
"category": "Email",
"clientId": "<string>",
"clientId2": "<string>",
"content": "<string>",
"createdAt": "2021-09-01T00:00:00Z",
"customAuthUrl": "<string>",
"customTokenUrl": "<string>",
"customUserInfoUrl": "<string>",
"disableSsl": true,
"domain": "<string>",
"endpoint": "<string>",
"host": "<string>",
"id": "00000000-0000-0000-0000-000000000000",
"intranetEndpoint": "<string>",
"issuerUrl": "<string>",
"method": "<string>",
"name": "SMTP Corp",
"port": 123,
"providerUrl": "<string>",
"receiver": "<string>",
"regionId": "<string>",
"scopes": "<string>",
"signName": "<string>",
"subType": "<string>",
"templateCode": "<string>",
"title": "<string>",
"type": "SendGrid"
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}{
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}Update a Provider
Changes a provider’s configuration or credentials. Anything you omit is left alone.
⚠️ A provider that is LINKED to an application is live: changing its credentials here takes effect on the next message it carries, with no confirmation step. If that provider carries SMS MFA codes, a wrong credential stops second factors from arriving and locks people out — verify with POST /v1/providers/{id}/test-send after changing it.
Failures:
400— a supplied member is malformed.404— no such provider in your organization.503 IDE-0066— the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.
PATCH
/
v1
/
providers
/
{id}
Update a Provider
curl --request PATCH \
--url https://identity.sandbox.lerian.net/v1/providers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"appId": "<string>",
"clientId": "<string>",
"clientId2": "<string>",
"clientSecret": "<string>",
"clientSecret2": "<string>",
"content": "<string>",
"customAuthUrl": "<string>",
"customTokenUrl": "<string>",
"customUserInfoUrl": "<string>",
"disableSsl": true,
"domain": "<string>",
"endpoint": "<string>",
"host": "<string>",
"intranetEndpoint": "<string>",
"issuerUrl": "<string>",
"method": "<string>",
"name": "<string>",
"port": 123,
"receiver": "<string>",
"regionId": "<string>",
"scopes": "<string>",
"signName": "<string>",
"subType": "<string>",
"templateCode": "<string>",
"title": "<string>"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://identity.sandbox.lerian.net/v1/providers/{id}"
payload := strings.NewReader("{\n \"appId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"clientId2\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"clientSecret2\": \"<string>\",\n \"content\": \"<string>\",\n \"customAuthUrl\": \"<string>\",\n \"customTokenUrl\": \"<string>\",\n \"customUserInfoUrl\": \"<string>\",\n \"disableSsl\": true,\n \"domain\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"host\": \"<string>\",\n \"intranetEndpoint\": \"<string>\",\n \"issuerUrl\": \"<string>\",\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"port\": 123,\n \"receiver\": \"<string>\",\n \"regionId\": \"<string>\",\n \"scopes\": \"<string>\",\n \"signName\": \"<string>\",\n \"subType\": \"<string>\",\n \"templateCode\": \"<string>\",\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
appId: '<string>',
clientId: '<string>',
clientId2: '<string>',
clientSecret: '<string>',
clientSecret2: '<string>',
content: '<string>',
customAuthUrl: '<string>',
customTokenUrl: '<string>',
customUserInfoUrl: '<string>',
disableSsl: true,
domain: '<string>',
endpoint: '<string>',
host: '<string>',
intranetEndpoint: '<string>',
issuerUrl: '<string>',
method: '<string>',
name: '<string>',
port: 123,
receiver: '<string>',
regionId: '<string>',
scopes: '<string>',
signName: '<string>',
subType: '<string>',
templateCode: '<string>',
title: '<string>'
})
};
fetch('https://identity.sandbox.lerian.net/v1/providers/{id}', 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/{id}"
payload = {
"appId": "<string>",
"clientId": "<string>",
"clientId2": "<string>",
"clientSecret": "<string>",
"clientSecret2": "<string>",
"content": "<string>",
"customAuthUrl": "<string>",
"customTokenUrl": "<string>",
"customUserInfoUrl": "<string>",
"disableSsl": True,
"domain": "<string>",
"endpoint": "<string>",
"host": "<string>",
"intranetEndpoint": "<string>",
"issuerUrl": "<string>",
"method": "<string>",
"name": "<string>",
"port": 123,
"receiver": "<string>",
"regionId": "<string>",
"scopes": "<string>",
"signName": "<string>",
"subType": "<string>",
"templateCode": "<string>",
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"appId": "<string>",
"category": "Email",
"clientId": "<string>",
"clientId2": "<string>",
"content": "<string>",
"createdAt": "2021-09-01T00:00:00Z",
"customAuthUrl": "<string>",
"customTokenUrl": "<string>",
"customUserInfoUrl": "<string>",
"disableSsl": true,
"domain": "<string>",
"endpoint": "<string>",
"host": "<string>",
"id": "00000000-0000-0000-0000-000000000000",
"intranetEndpoint": "<string>",
"issuerUrl": "<string>",
"method": "<string>",
"name": "SMTP Corp",
"port": 123,
"providerUrl": "<string>",
"receiver": "<string>",
"regionId": "<string>",
"scopes": "<string>",
"signName": "<string>",
"subType": "<string>",
"templateCode": "<string>",
"title": "<string>",
"type": "SendGrid"
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}{
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}{
"code": "<string>",
"entityType": "<string>",
"err": "<unknown>",
"message": "<string>",
"title": "<string>"
}Autorizaciones
JWT bearer token issued by the identity provider.
Parámetros de ruta
Provider ID.
Ejemplo:
"smtp-primary"
Cuerpo
application/json
The provider members to update.
Respuesta
OK
Opciones disponibles:
Email, SMS, OAuth Ejemplo:
"Email"
Ejemplo:
"2021-09-01T00:00:00Z"
Ejemplo:
"00000000-0000-0000-0000-000000000000"
Ejemplo:
"SMTP Corp"
Opciones disponibles:
SendGrid, Twilio SMS, Twilio, Google, Microsoft, Okta, Custom Ejemplo:
"SendGrid"
¿Esta página le ayudó?