ZITADEL Docs
APIsCore ResourcesV1Instance Objects

AddGenericOAuthProvider

Add a new OAuth2 identity provider on the instance

POST
/idps/oauth

Request Body

application/json

name?string
clientId?string
clientSecret?string
authorizationEndpoint?string
tokenEndpoint?string
userEndpoint?string
scopes?scopes
idAttribute?string

identifying attribute of the user in the response of the user_endpoint

providerOptions?
usePkce?boolean

Enable the use of Proof Key for Code Exchange (PKCE) for the OAuth2 flow.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/idps/oauth" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "sequence": 0,
    "creationDate": "1s",
    "changeDate": "1s",
    "resourceOwner": "string"
  },
  "id": "string"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?