Properties

callbackURL

string

This is fixed and must always be the same as the OAuth redirect URL provisioned by Firebase Auth, https://project-id.firebaseapp.com/__/auth/handler unless a custom authDomain is used. The callback URL should also be provided to the SAML IdP during configuration.

displayName

unknown

The user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console.

Inherited from
admin.auth.AuthProviderConfig#displayName

enabled

unknown

Whether the current provider configuration is enabled or disabled. A user cannot sign in using a disabled provider.

Inherited from
admin.auth.AuthProviderConfig#enabled

idpEntityId

string

The SAML IdP entity identifier.

providerId

unknown

The provider ID defined by the developer. For a SAML provider, this is always prefixed by saml.. For an OIDC provider, this is always prefixed by oidc..

Inherited from
admin.auth.AuthProviderConfig#providerId

rpEntityId

string

The SAML relying party (service provider) entity ID. This is defined by the developer but needs to be provided to the SAML IdP.

ssoURL

string

The SAML IdP SSO URL. This must be a valid URL.

x509Certificates

non-null Array of string

The list of SAML IdP X.509 certificates issued by CA for this provider. Multiple certificates are accepted to prevent outages during IdP key rotation (for example ADFS rotates every 10 days). When the Auth server receives a SAML response, it will match the SAML response with the certificate on record. Otherwise the response is rejected. Developers are expected to manage the certificate updates as keys are rotated.