Set Provider as Default

Makes one linked provider the application’s default for its category — the one its messages go through when nothing more specific applies.

An application can have several providers of a category linked but only one default, so this call also DEMOTES whichever was default before. That demotion is silent and is the part worth knowing: promoting a provider is how delivery moves off the previous 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 /v1/applications/{id}/providers/{providerId}/default

Set Provider as Default

cURL

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/applications/{id}/providers/{providerId}/default \
  --header 'Authorization: Bearer <token>'

200

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

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id · string · obrigatório

Application ID.

Exemplo:

"plugin-identity"

providerId · string · obrigatório

Provider ID.

Exemplo:

"smtp-primary"

Resposta

200

application/json

OK

alertType · string

canSignIn · boolean

canSignUp · boolean

canUnlink · boolean

category · string

prompted · boolean

providerId · string

rule · string

type · string