Update Provider Link

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alertType": "<string>",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": true,
  "prompted": true,
  "rule": "<string>"
}
'

package main

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

func main() {

	url := "https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId}"

	payload := strings.NewReader("{\n  \"alertType\": \"<string>\",\n  \"canSignIn\": true,\n  \"canSignUp\": true,\n  \"canUnlink\": true,\n  \"prompted\": true,\n  \"rule\": \"<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({
    alertType: '<string>',
    canSignIn: true,
    canSignUp: true,
    canUnlink: true,
    prompted: true,
    rule: '<string>'
  })
};

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

import requests

url = "https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId}"

payload = {
    "alertType": "<string>",
    "canSignIn": True,
    "canSignUp": True,
    "canUnlink": True,
    "prompted": True,
    "rule": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "alertType": "<string>",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": true,
  "category": "<string>",
  "prompted": true,
  "providerId": "<string>",
  "rule": "<string>",
  "type": "<string>"
}

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

Changes how one provider is used by one application. Anything you omit is left alone.

This edits the LINK, not the provider: the provider’s own credentials are changed with PATCH /v1/providers/{id}, and a change there affects every application linked to it, while a change here affects only this one.

Failures:

404 — no such application, or that provider is not linked to it.
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

applications

{id}

providers

{providerId}

Update Provider Link

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alertType": "<string>",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": true,
  "prompted": true,
  "rule": "<string>"
}
'

package main

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

func main() {

	url := "https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId}"

	payload := strings.NewReader("{\n  \"alertType\": \"<string>\",\n  \"canSignIn\": true,\n  \"canSignUp\": true,\n  \"canUnlink\": true,\n  \"prompted\": true,\n  \"rule\": \"<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({
    alertType: '<string>',
    canSignIn: true,
    canSignUp: true,
    canUnlink: true,
    prompted: true,
    rule: '<string>'
  })
};

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

import requests

url = "https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId}"

payload = {
    "alertType": "<string>",
    "canSignIn": True,
    "canSignUp": True,
    "canUnlink": True,
    "prompted": True,
    "rule": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "alertType": "<string>",
  "canSignIn": true,
  "canSignUp": true,
  "canUnlink": true,
  "category": "<string>",
  "prompted": true,
  "providerId": "<string>",
  "rule": "<string>",
  "type": "<string>"
}

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

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

Application ID.

Ejemplo:

"plugin-identity"

providerId

string

requerido

Provider ID.

Ejemplo:

"smtp-primary"

Cuerpo

application/json

The link members to update.

alertType

string

canUnlink

boolean

prompted

boolean

rule

string

Respuesta

alertType

string

canUnlink

boolean

Resumen

Autenticación

Inicio de sesión único

Autorización

Información del usuario

MFA de inicio de sesión

Passkey de inicio de sesión

Resumen de identidad

Grupos

Aplicaciones

Socios

Usuarios

MFA de cuenta

Passkey de cuenta

Proveedores de identidad

Proveedores de aplicaciones

Permisos

Roles

Políticas de seguridad

Declaraciones de plugins

Manejo de errores

Update Provider Link

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta