• Public
  • Public/Protected
  • All

Interface FederationParameters

Configuration information when authentication mode is FEDERATED.


  • FederationParameters



Optional applicationCallBackURL

applicationCallBackURL: undefined | string

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

Optional attributeMap

attributeMap: Record<string, string>

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Optional federationProviderName

federationProviderName: undefined | string

Name of the identity provider (IdP).

Optional federationURN

federationURN: undefined | string

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

Optional samlMetadataDocument

samlMetadataDocument: undefined | string

SAML 2.0 Metadata document from identity provider (IdP).

Optional samlMetadataURL

samlMetadataURL: undefined | string

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).