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
AuthenticationEnabledbool?A flag indicating if the external identity provider can be used for user authentication.[optional]
ButtonImagestringThe URI of the logo to display on the login button for this external identity provider.[optional]
ButtonTextstringThe unique text to display on the login button for this external identity provider.[optional]
CreateUserbool?A 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]
DomainsstringThe space separated list of domains associated with the external identity provider for use with user authentication.[optional]
IdstringThe UUID of the external identity provider.[optional]
IssuerstringThe issuer URI for the external OIDC identity provider or the issuer, or IDP Entity ID, for the external SAML identity provider.[optional]
NamestringThe unique name of the external identity provider.[optional]
ProtocolstringThe type of the external identity provider.[optional]
SpIdstringThe client identifier provided by the external OIDC identity provider or the SP entity ID provided to the external SAML identity provider.[optional]
TypestringThe type of the external identity provider.[optional]
VerificationCertificate2DNstringThe verification certificate2 DN used with the external identity provider.[optional]
VerificationCertificate2ExpiryDateDateTime?The verification certificate2 expiry date used with the external identity provider.[optional]
VerificationCertificateDNstringThe verification certificate DN used with the external identity provider.[optional]
VerificationCertificateExpiryDateDateTime?The verification certificate expiry date used with the external identity provider.[optional]
VerificationEnabledbool?A flag indicating if the external identity provider can be used for user verification.[optional]