Skip to main content

IdentityProvider

An IdentityProvider defines the information returned about an external identity provider for use with user authentication or user verification.

Properties

NameTypeDescriptionNotes
authentication_enabledboolA flag indicating if the external identity provider can be used for user authentication.[optional]
button_imagestrThe URI of the logo to display on the login button for this external identity provider.[optional]
button_textstrThe unique text to display on the login button for this external identity provider.[optional]
create_userboolA flag indicating if the user should be created after authenticating to the external identity provider if it doesn't exist. The user attributes specified by the userAttributeMappings attribute are used to populate the user in IDaaS. This value is used if authenticationEnabled is true.[optional]
domainsstrThe space separated list of domains associated with the external identity provider for use with user authentication.[optional]
idstrThe UUID of the external identity provider.[optional]
issuerstrThe issuer URI for the external OIDC identity provider or the issuer, or IDP Entity ID, for the external SAML identity provider.[optional]
namestrThe unique name of the external identity provider.[optional]
protocolstrThe type of the external identity provider.[optional]
sp_idstrThe client identifier provided by the external OIDC identity provider or the SP entity ID provided to the external SAML identity provider.[optional]
typestrThe type of the external identity provider.[optional]
verification_certificate2_dnstrThe verification certificate2 DN used with the external identity provider.[optional]
verification_certificate2_expiry_datedatetimeThe verification certificate2 expiry date used with the external identity provider.[optional]
verification_certificate_dnstrThe verification certificate DN used with the external identity provider.[optional]
verification_certificate_expiry_datedatetimeThe verification certificate expiry date used with the external identity provider.[optional]
verification_enabledboolA flag indicating if the external identity provider can be used for user verification.[optional]

Example