The identity provider object

A comprehensive list of the identity provider resource's attributes and relationships

An identity provider object is returned as part of the response body of each successful create, list, retrieve or update API call to the /api/identity_providers endpoint.

Fields

Field	Type	Description
type	string	identity_providers
id	string	The identity provider unique identifier.
links.self	string	The identity provider endpoint URL.
attributes.name	string	The name of the Identity provider.
attributes.client_id	string	The client ID used for the auth workflow.
attributes.client_secret	string	The client secret used for the auth workflow.
attributes.issuer	string	The issuer used for the auth workflow.
attributes.status	string	The identity provider status. One of pending (default), verified or error.
attributes.domains	string	The list of domains in scope (comma-separated).
attributes.token_url	string	The token URL used for the auth workflow.
attributes.authorize_url	string	The authorize URL used for the auth workflow.
attributes.jwks_url	string	The JWKS key store URL used for the auth workflow.
attributes.txt_record	string	The TXT record value used to check the domain.
attributes.organization	string	The organization identifier for authorize params.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes._disable	boolean	Send this attribute if you want to mark this resource as disabled.
attributes._enable	boolean	Send this attribute if you want to mark this resource as enabled.
attributes.disabled_at	datetime	Time at which this resource was disabled.
relationships.user	object	The user associated to the identity provider.