Skip to content

SamlConfigOptions

Source code in docs_src/capo_opensearchserverless/types/saml_config_options.py
class SamlConfigOptions(TypedDict, closed=True):
    metadata: "capo_opensearchserverless.types.saml_metadata.samlMetadata"
    """<p>The XML IdP metadata file generated from your identity provider.</p>"""
    user_attribute: NotRequired[
        "capo_opensearchserverless.types.saml_user_attribute.samlUserAttribute"
    ]
    """<p>A user attribute for this SAML integration.</p>"""
    group_attribute: NotRequired[
        "capo_opensearchserverless.types.saml_group_attribute.samlGroupAttribute"
    ]
    """<p>The group attribute for this SAML integration.</p>"""
    open_search_serverless_entity_id: NotRequired[
        "capo_opensearchserverless.types.open_search_serverless_entity_id.openSearchServerlessEntityId"
    ]
    """<p>Custom entity ID attribute to override the default entity ID for this SAML integration.</p>"""
    session_timeout: NotRequired["int"]
    """<p>The session timeout, in minutes. Default is 60 minutes (12 hours).</p>"""

group_attribute instance-attribute

group_attribute: NotRequired[samlGroupAttribute]

The group attribute for this SAML integration.

metadata instance-attribute

metadata: samlMetadata

The XML IdP metadata file generated from your identity provider.

open_search_serverless_entity_id instance-attribute

open_search_serverless_entity_id: NotRequired[openSearchServerlessEntityId]

Custom entity ID attribute to override the default entity ID for this SAML integration.

session_timeout instance-attribute

session_timeout: NotRequired[int]

The session timeout, in minutes. Default is 60 minutes (12 hours).

user_attribute instance-attribute

user_attribute: NotRequired[samlUserAttribute]

A user attribute for this SAML integration.