Add Generic OAuth Identity Provider
Add Generic OAuth Identity Provider
- application/json
 - application/grpc
 - application/grpc-web+proto
 
Request Body required
- name string
 - clientId string
Client id generated by the identity provider
 - clientSecret string
Client secret generated by the identity provider
 - authorizationEndpoint string
The endpoint where ZITADEL send the user to authenticate
 - tokenEndpoint string
The endpoint where ZITADEL can get the token
 - userEndpoint string
The endpoint where ZITADEL can get the user information
 - scopes string[]
The scopes requested by ZITADEL during the request on the identity provider
 - idAttribute identifying attribute of the user in the response of the user_endpoint
Identifying attribute of the user in the response of the user_endpoint
 providerOptions object
isLinkingAllowed booleanEnable if users should be able to link an existing ZITADEL user with an external account.
isCreationAllowed booleanEnable if users should be able to create a new account in ZITADEL when using an external account.
isAutoCreation booleanEnable if a new account in ZITADEL should be created automatically when login with an external account.
isAutoUpdate booleanEnable if a the ZITADEL account fields should be updated automatically on each login.
Request Body required
- name string
 - clientId string
Client id generated by the identity provider
 - clientSecret string
Client secret generated by the identity provider
 - authorizationEndpoint string
The endpoint where ZITADEL send the user to authenticate
 - tokenEndpoint string
The endpoint where ZITADEL can get the token
 - userEndpoint string
The endpoint where ZITADEL can get the user information
 - scopes string[]
The scopes requested by ZITADEL during the request on the identity provider
 - idAttribute identifying attribute of the user in the response of the user_endpoint
Identifying attribute of the user in the response of the user_endpoint
 providerOptions object
isLinkingAllowed booleanEnable if users should be able to link an existing ZITADEL user with an external account.
isCreationAllowed booleanEnable if users should be able to create a new account in ZITADEL when using an external account.
isAutoCreation booleanEnable if a new account in ZITADEL should be created automatically when login with an external account.
isAutoUpdate booleanEnable if a the ZITADEL account fields should be updated automatically on each login.
Request Body required
- name string
 - clientId string
Client id generated by the identity provider
 - clientSecret string
Client secret generated by the identity provider
 - authorizationEndpoint string
The endpoint where ZITADEL send the user to authenticate
 - tokenEndpoint string
The endpoint where ZITADEL can get the token
 - userEndpoint string
The endpoint where ZITADEL can get the user information
 - scopes string[]
The scopes requested by ZITADEL during the request on the identity provider
 - idAttribute identifying attribute of the user in the response of the user_endpoint
Identifying attribute of the user in the response of the user_endpoint
 providerOptions object
isLinkingAllowed booleanEnable if users should be able to link an existing ZITADEL user with an external account.
isCreationAllowed booleanEnable if users should be able to create a new account in ZITADEL when using an external account.
isAutoCreation booleanEnable if a new account in ZITADEL should be created automatically when login with an external account.
isAutoUpdate booleanEnable if a the ZITADEL account fields should be updated automatically on each login.
- 200
 - default
 
A successful response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- id string
 
{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}
- Schema
 - Example (from schema)
 
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- id string
 
{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}
- Schema
 - Example (from schema)
 
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to- id string
 
{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}
An unexpected error response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}