Error

A valid request URL is required to generate request examples

{
  "configured": true,
  "provider": {
    "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"
  },
  "passwordEnabled": true
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

Upsert SSO provider configuration

Creates or replaces the caller tenant’s single active OAuth SSO provider. Upserting with the SAME type as the currently-active provider rotates its credentials/endpoints in place; a different (or absent) type replaces it, demoting and pruning the old one. Unless disablePasswordLogin is explicitly false, local password login is also disabled. The tenant is resolved from the authenticated identity, never from the payload.

PUT

sso

provider

Error

A valid request URL is required to generate request examples

{
  "configured": true,
  "provider": {
    "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"
  },
  "passwordEnabled": true
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

Bearer authentication. Send Authorization: Bearer .

Cuerpo

application/json

SSO Provider Input

SSOProviderConfigInput payload

clientId

string

requerido

clientSecret

string

requerido

#nosec G117 -- write-only credential, never echoed back in any response

type

enum<string>

requerido

Opciones disponibles:

Google,

AzureAD,

Okta,

Custom

Ejemplo:

"Google"

customAuthUrl

string

customTokenUrl

string

customUserInfoUrl

string

Ejemplo:

true

domain

string

Domain is REQUIRED for Type=Okta and ignored otherwise: Casdoor derives an Okta provider's authorize, token and userinfo endpoints from it, and no constant can stand in because they are per-org. Either the org URL (https://.okta.com) or an authorization server base (https://.okta.com/oauth2/default) is accepted; the org URL is completed to its authorization server on write.

Ejemplo:

"https://your-org.okta.com"

issuerUrl

string

name

string

scopes

string

Respuesta

SSOProviderConfigResponse payload

configured

boolean

passwordEnabled

boolean

provider

object

ProviderResponse payload

Show child attributes

Ejemplo:

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

Resumen

Autenticación

Autorización

Información del usuario

MFA de inicio de sesión

Resumen de identidad

Grupos

Aplicaciones

Usuarios

MFA de cuenta

Proveedores de identidad

Proveedores de aplicaciones

Permisos

Roles

Políticas de seguridad

Manejo de errores

Upsert SSO provider configuration

Autorizaciones

Cuerpo

Respuesta