Deprecated: Add OIDC Identity Provider (IDP)

POST 
/idps/oidc

deprecated

Create a new identity provider configuration to enable your users to log in with social/enterprise login. The provider has to be OIDC compliant.

Request

application/json

Body

required

name stringrequired

Possible values: non-empty and <= 200 characters

stylingType string

Possible values: [STYLING_TYPE_UNSPECIFIED, STYLING_TYPE_GOOGLE]

Default value: STYLING_TYPE_UNSPECIFIED

some identity providers specify the styling of the button to their login

clientId stringrequired

Possible values: non-empty and <= 200 characters

client id generated by the identity provider

clientSecret stringrequired

Possible values: non-empty and <= 200 characters

client secret generated by the identity provider

issuer stringrequired

Possible values: <= 200 characters

the oidc issuer of the identity provider

scopes string[]

the scopes requested by ZITADEL during the request on the identity provider

displayNameMapping string

Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED, OIDC_MAPPING_FIELD_PREFERRED_USERNAME, OIDC_MAPPING_FIELD_EMAIL]

Default value: OIDC_MAPPING_FIELD_UNSPECIFIED

definition which field is mapped to the display name of the user

usernameMapping string

Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED, OIDC_MAPPING_FIELD_PREFERRED_USERNAME, OIDC_MAPPING_FIELD_EMAIL]

Default value: OIDC_MAPPING_FIELD_UNSPECIFIED

definition which field is mapped to the email of the user

autoRegister boolean

application/grpc

Body

required

name stringrequired

Possible values: non-empty and <= 200 characters

stylingType string

Possible values: [STYLING_TYPE_UNSPECIFIED, STYLING_TYPE_GOOGLE]

Default value: STYLING_TYPE_UNSPECIFIED

some identity providers specify the styling of the button to their login

clientId stringrequired

Possible values: non-empty and <= 200 characters

client id generated by the identity provider

clientSecret stringrequired

Possible values: non-empty and <= 200 characters

client secret generated by the identity provider

issuer stringrequired

Possible values: <= 200 characters

the oidc issuer of the identity provider

scopes string[]

the scopes requested by ZITADEL during the request on the identity provider

displayNameMapping string

Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED, OIDC_MAPPING_FIELD_PREFERRED_USERNAME, OIDC_MAPPING_FIELD_EMAIL]

Default value: OIDC_MAPPING_FIELD_UNSPECIFIED

definition which field is mapped to the display name of the user

usernameMapping string

Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED, OIDC_MAPPING_FIELD_PREFERRED_USERNAME, OIDC_MAPPING_FIELD_EMAIL]

Default value: OIDC_MAPPING_FIELD_UNSPECIFIED

definition which field is mapped to the email of the user

autoRegister boolean

application/grpc-web+proto

Body

required

name stringrequired

Possible values: non-empty and <= 200 characters

stylingType string

Possible values: [STYLING_TYPE_UNSPECIFIED, STYLING_TYPE_GOOGLE]

Default value: STYLING_TYPE_UNSPECIFIED

some identity providers specify the styling of the button to their login

clientId stringrequired

Possible values: non-empty and <= 200 characters

client id generated by the identity provider

clientSecret stringrequired

Possible values: non-empty and <= 200 characters

client secret generated by the identity provider

issuer stringrequired

Possible values: <= 200 characters

the oidc issuer of the identity provider

scopes string[]

the scopes requested by ZITADEL during the request on the identity provider

displayNameMapping string

Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED, OIDC_MAPPING_FIELD_PREFERRED_USERNAME, OIDC_MAPPING_FIELD_EMAIL]

Default value: OIDC_MAPPING_FIELD_UNSPECIFIED

definition which field is mapped to the display name of the user

usernameMapping string

Possible values: [OIDC_MAPPING_FIELD_UNSPECIFIED, OIDC_MAPPING_FIELD_PREFERRED_USERNAME, OIDC_MAPPING_FIELD_EMAIL]

Default value: OIDC_MAPPING_FIELD_UNSPECIFIED

definition which field is mapped to the email of the user

autoRegister boolean

Responses

200

idp created

application/json

Schema

Schema

details

object

sequence uint64

on 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-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
idpId string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-22T09:27:14.037Z",
    "changeDate": "2024-11-22T09:27:14.037Z",
    "resourceOwner": "69629023906488334"
  },
  "idpId": "53829026806489455"
}

application/grpc

Schema

Schema

details

object

sequence uint64

on 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-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
idpId string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-22T09:27:14.038Z",
    "changeDate": "2024-11-22T09:27:14.038Z",
    "resourceOwner": "69629023906488334"
  },
  "idpId": "53829026806489455"
}

application/grpc-web+proto

Schema

Schema

details

object

sequence uint64

on 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-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)
idpId string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-22T09:27:14.038Z",
    "changeDate": "2024-11-22T09:27:14.038Z",
    "resourceOwner": "69629023906488334"
  },
  "idpId": "53829026806489455"
}

400

invalid argument

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...