SAMLAuthProviderConfig class

The SAML Auth provider configuration interface. A SAML provider can be created via _BaseAuth.createProviderConfig.

Inheritance
Implemented types

Constructors

SAMLAuthProviderConfig({required String idpEntityId, required String ssoURL, required List<String> x509Certificates, required String rpEntityId, String? callbackURL, required String providerId, String? displayName, required bool enabled, String? issuer, bool? enableRequestSigning})

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.
final
displayName → String?
The user-friendly display name to the current configuration. This name is also used as the provider label in the Cloud Console.
finalinherited
enabled → bool
Whether the provider configuration is enabled or disabled. A user cannot sign in using a disabled provider.
finalinherited
enableRequestSigning → bool?
final
hashCode → int
The hash code for this object.
no setterinherited
idpEntityId → String
The SAML IdP entity identifier.
final
issuer → String?
final
providerId → String
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..
finalinherited
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
ssoURL → String
The SAML IdP SSO URL. This must be a valid URL.
final
x509Certificates → List<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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited