Interface FederationParameters.Builder

    • Method Detail

      • samlMetadataDocument

        FederationParameters.Builder samlMetadataDocument​(String samlMetadataDocument)

        SAML 2.0 Metadata document from identity provider (IdP).

        Parameters:
        samlMetadataDocument - SAML 2.0 Metadata document from identity provider (IdP).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • samlMetadataURL

        FederationParameters.Builder samlMetadataURL​(String samlMetadataURL)

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

        Parameters:
        samlMetadataURL - Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • applicationCallBackURL

        FederationParameters.Builder applicationCallBackURL​(String applicationCallBackURL)

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

        Parameters:
        applicationCallBackURL - The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • federationURN

        FederationParameters.Builder federationURN​(String federationURN)

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

        Parameters:
        federationURN - The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • federationProviderName

        FederationParameters.Builder federationProviderName​(String federationProviderName)

        Name of the identity provider (IdP).

        Parameters:
        federationProviderName - Name of the identity provider (IdP).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • attributeMap

        FederationParameters.Builder attributeMap​(Map<String,​String> attributeMap)

        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.

        Parameters:
        attributeMap - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.