Skip to content

FederationParameters

Source code in docs_src/capo_finspace/types/federation_parameters.py
class FederationParameters(TypedDict, closed=True):
    saml_metadata_document: NotRequired[
        "capo_finspace.types.saml_metadata_document.SamlMetadataDocument"
    ]
    """<p>SAML 2.0 Metadata document from identity provider (IdP).</p>"""
    saml_metadata_url: NotRequired["capo_finspace.types.url.url"]
    """<p>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</p>"""
    application_call_back_url: NotRequired["capo_finspace.types.url.url"]
    """<p>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).</p>"""
    federation_urn: NotRequired["capo_finspace.types.urn.urn"]
    """<p>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.</p>"""
    federation_provider_name: NotRequired[
        "capo_finspace.types.federation_provider_name.FederationProviderName"
    ]
    """<p>Name of the identity provider (IdP).</p>"""
    attribute_map: NotRequired["capo_finspace.types.attribute_map.AttributeMap"]
    """<p>SAML attribute name and value. The name must always be <code>Email</code> and the value should be set to the attribute definition in which user email is set. For example, name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.</p>"""

application_call_back_url instance-attribute

application_call_back_url: NotRequired[url]

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

attribute_map instance-attribute

attribute_map: NotRequired[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.

federation_provider_name instance-attribute

federation_provider_name: NotRequired[FederationProviderName]

Name of the identity provider (IdP).

federation_urn instance-attribute

federation_urn: NotRequired[urn]

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

saml_metadata_document instance-attribute

saml_metadata_document: NotRequired[SamlMetadataDocument]

SAML 2.0 Metadata document from identity provider (IdP).

saml_metadata_url instance-attribute

saml_metadata_url: NotRequired[url]

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