OIDC Claim Mappings

object

Defines the mappings between OpenID Connect (OIDC) claims and local claims used by your application for
authentication.

namestring

The claim mapping for the user’s name.

Default:name

Example:name

emailstring

The claim mapping for the user’s email address.

Default:email

Example:email

groupsstring

The claim mapping for the user’s group membership information.

Default:groups

Example:groups

Example

SAML Identity Provider Metadata URL

string

The identity provider’s metadata URL where the identity provider’s metadata can be obtained.

Example

SAML Identity Provider Metadata

string

The identity provider’s SAML metadata. If the identity provider supports a metadata URL, you can use the idp_metadata_url field instead.

Example

Create Identity Provider

object

The identity provider that contains configuration data for creating an authentication integration.

typestring

Specifies the type of identity provider.

Allowed values:oidcsaml

Example:oidc

enabledboolean

Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.

Default:false

Example:true

login_pathstring

The path used for initiating login requests with the identity provider.

Example:myapp

configOne Of
object
OIDC Identity Provider Configobject

The identity provider that contains configuration data for the OIDC authentication integration.

* Additional properties are NOT allowed.
Show Child Parameters
Example

Update Identity Provider

object

The identity provider that contains configuration data for updating an authentication integration.

enabledboolean

Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.

Default:false

Example:true

login_pathstring

The path used for initiating login requests with the identity provider.

Example:myapp

configOne Of
object
OIDC Identity Provider Configobject

The identity provider that contains configuration data for the OIDC authentication integration.

* Additional properties are NOT allowed.
Show Child Parameters
Example