Skip to main content

show a identity provider

Identity providers provide means of authentication. Providing authentication and identity management for the end-users, the configuration of the identity provider resource help managing the interfaces and the enabled features customizing the end-users authentication flow. The field descriptions are available in the main documentation page.

GET /api/identity-providers/:identity_provider_id shows the identified identity provider resource

Required scope: identity-providers:manage:all

Path Parameters
identity_provider_id string — REQUIRED
Responses
200
Schema — OPTIONAL
data object — OPTIONAL
id string
name string — OPTIONAL
backend object — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
type string — OPTIONAL
is_default boolean — OPTIONAL
create_default_organization boolean — OPTIONAL
roles object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
scopes object[] — OPTIONAL
id string — OPTIONAL
name string — OPTIONAL
public boolean — OPTIONAL
metadata_fields object[] — OPTIONAL
federated_servers object[] — OPTIONAL
verifiable_credentials object[] — OPTIONAL
verifiable_presentations object[] — OPTIONAL
password_hashing_alg string — OPTIONAL
password_hashing_opts object — OPTIONAL
ldap_pool_size int32 — OPTIONAL
ldap_host string — OPTIONAL
ldap_user_rdn_attribute string — OPTIONAL
ldap_base_dn string — OPTIONAL
ldap_ou string — OPTIONAL
ldap_master_dn string — OPTIONAL
ldap_master_password string — OPTIONAL
smtp_from string — OPTIONAL
smtp_relay string — OPTIONAL
smtp_username string — OPTIONAL
smtp_password string — OPTIONAL
smtp_ssl boolean — OPTIONAL
smtp_tls boolean — OPTIONAL
smtp_port int32 — OPTIONAL
features string[] — OPTIONAL
backend_id string — OPTIONAL
check_password boolean — OPTIONAL
choose_session boolean — OPTIONAL
totpable boolean — OPTIONAL
enforce_totp boolean — OPTIONAL
webauthnable boolean — OPTIONAL
enforce_webauthn boolean — OPTIONAL
registrable boolean — OPTIONAL
user_editable boolean — OPTIONAL
consentable boolean — OPTIONAL
confirmable boolean — OPTIONAL
401

The client is unauthorized to access this resource.

Schema — OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema — OPTIONAL
code string
message string