Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAdmin.Auth.Providers.SamlProviderConfig
Represents a SAML auth provider configuration.
Summary
See SAML technical overview.
Inheritance
Inherits from:
FirebaseAdmin.Auth.Providers.AuthProviderConfig
Properties
|
CallbackUrl
|
string
Gets the SAML callback URL.
|
IdpEntityId
|
string
Gets the SAML IdP entity identifier.
|
RpEntityId
|
string
Gets the SAML relying party (service provider) entity ID.
|
SsoUrl
|
string
Gets the SAML IdP SSO URL.
|
X509Certificates
|
IEnumerable< string >
Gets the collection of SAML IdP X.509 certificates issued by CA for this provider.
|
Properties
CallbackUrl
string CallbackUrl
Gets the SAML callback URL.
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.
IdpEntityId
string IdpEntityId
Gets the SAML IdP entity identifier.
RpEntityId
string RpEntityId
Gets 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 SsoUrl
Gets the SAML IdP SSO URL.
X509Certificates
IEnumerable< string > X509Certificates
Gets the collection 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-03-24 UTC.
[null,null,["Last updated 2022-03-24 UTC."],[],[],null,["# FirebaseAdmin.Auth.Providers.SamlProviderConfig Class Reference\n\nFirebaseAdmin.Auth.Providers.SamlProviderConfig\n===============================================\n\nRepresents a SAML auth provider configuration.\n\nSummary\n-------\n\nSee [SAML technical overview](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html).\n\n### Inheritance\n\nInherits from: [FirebaseAdmin.Auth.Providers.AuthProviderConfig](/docs/reference/admin/dotnet/class/firebase-admin/auth/providers/auth-provider-config)\n\n| ### Properties ||\n|------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|\n| [CallbackUrl](#class_firebase_admin_1_1_auth_1_1_providers_1_1_saml_provider_config_1a4e39323a2fabf1d22715579049cf2ecb) | `string` Gets the SAML callback URL. |\n| [IdpEntityId](#class_firebase_admin_1_1_auth_1_1_providers_1_1_saml_provider_config_1a5a209a86301d25c9af73ec62ae327b43) | `string` Gets the SAML IdP entity identifier. |\n| [RpEntityId](#class_firebase_admin_1_1_auth_1_1_providers_1_1_saml_provider_config_1ab0abeea01218a1230cfeafe65b0d4e8b) | `string` Gets the SAML relying party (service provider) entity ID. |\n| [SsoUrl](#class_firebase_admin_1_1_auth_1_1_providers_1_1_saml_provider_config_1ada67de37620a6a57af58463ff75297c6) | `string` Gets the SAML IdP SSO URL. |\n| [X509Certificates](#class_firebase_admin_1_1_auth_1_1_providers_1_1_saml_provider_config_1a86d2978f0904bf1afe43b956aad50997) | `IEnumerable\u003c string \u003e` Gets the collection of SAML IdP X.509 certificates issued by CA for this provider. |\n\nProperties\n----------\n\n### CallbackUrl\n\n```text\nstring CallbackUrl\n``` \nGets the SAML callback URL.\n\nThis is fixed and must always be the same as the OAuth redirect URL provisioned by Firebase [Auth](/docs/reference/admin/dotnet/namespace/firebase-admin/auth#namespace_firebase_admin_1_1_auth), \u003chttps://project-id.firebaseapp.com/__/auth/handler\u003e unless a custom `authDomain` is used. The callback URL should also be provided to the SAML IdP during configuration. \n\n### IdpEntityId\n\n```text\nstring IdpEntityId\n``` \nGets the SAML IdP entity identifier. \n\n### RpEntityId\n\n```text\nstring RpEntityId\n``` \nGets the SAML relying party (service provider) entity ID.\n\nThis is defined by the developer but needs to be provided to the SAML IdP. \n\n### SsoUrl\n\n```text\nstring SsoUrl\n``` \nGets the SAML IdP SSO URL. \n\n### X509Certificates\n\n```text\nIEnumerable\u003c string \u003e X509Certificates\n``` \nGets the collection of SAML IdP X.509 certificates issued by CA for this provider.\n\nMultiple certificates are accepted to prevent outages during IdP key rotation (for example ADFS rotates every 10 days). When the [Auth](/docs/reference/admin/dotnet/namespace/firebase-admin/auth#namespace_firebase_admin_1_1_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."]]
