Update a Provider

Updates an existing Provider configuration.

PATCH /v1/providers/{id}

Error

A valid request URL is required to generate request examples

200

{
  "disableSsl": true,
  "templateCode": "templateCode",
  "title": "title",
  "type": "SendGrid",
  "content": "content",
  "createdAt": "2021-09-01T00:00:00.000Z",
  "intranetEndpoint": "intranetEndpoint",
  "endpoint": "endpoint",
  "appId": "appId",
  "host": "host",
  "customUserInfoUrl": "customUserInfoUrl",
  "id": "00000000-0000-0000-0000-000000000000",
  "clientId": "clientId",
  "signName": "signName",
  "method": "method",
  "receiver": "receiver",
  "issuerUrl": "issuerUrl",
  "customTokenUrl": "customTokenUrl",
  "clientId2": "clientId2",
  "customAuthUrl": "customAuthUrl",
  "providerUrl": "providerUrl",
  "port": 0,
  "regionId": "regionId",
  "domain": "domain",
  "name": "SMTP Corp",
  "subType": "subType",
  "scopes": "scopes",
  "category": "Email"
}

Autorizaciones

Authorization · string · header · requerido

Bearer authentication. Send Authorization: Bearer .

Parámetros de ruta

id · string · requerido

Provider ID

Cuerpo

application/json

Provider Update Input

ProviderUpdateInput payload

appId · string

clientId · string

clientId2 · string

clientSecret · string

#nosec G117 -- auth service, field must be in JSON response

clientSecret2 · string

#nosec G117 -- auth service, field must be in JSON response

content · string

customAuthUrl · string

customTokenUrl · string

customUserInfoUrl · string

disableSsl · boolean

domain · string

endpoint · string

host · string

intranetEndpoint · string

issuerUrl · string

method · string

name · string

port · integer

receiver · string

regionId · string

scopes · string

signName · string

subType · string

templateCode · string

title · string

Respuesta

200

application/json

OK

ProviderResponse payload

appId · string

category · string

Ejemplo:

"Email"

clientId · string

clientId2 · string

content · string

createdAt · string

Ejemplo:

"2021-09-01T00:00:00.000Z"

customAuthUrl · string

customTokenUrl · string

customUserInfoUrl · string

disableSsl · boolean

domain · string

endpoint · string

host · string

id · string

Ejemplo:

"00000000-0000-0000-0000-000000000000"

intranetEndpoint · string

issuerUrl · string

method · string

name · string

Ejemplo:

"SMTP Corp"

port · integer

providerUrl · string

receiver · string

regionId · string

scopes · string

signName · string

subType · string

templateCode · string

title · string

type · string

Type is the provider type exactly as stored in Casdoor. SMS providers created before the canonical "Twilio SMS" was adopted are still stored as "Twilio", so both values can appear here.

Ejemplo:

"SendGrid"