Skip to content

SAMLOptionsInput

Source code in docs_src/capo_opensearch/types/saml_options_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class SAMLOptionsInput(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to enable SAML authentication for a domain.</p>"""
    idp: NotRequired["capo_opensearch.types.saml_idp.SAMLIdp"]
    """<p>The SAML Identity Provider's information.</p>"""
    master_user_name: NotRequired["capo_opensearch.types.username.Username"]
    """<p>The SAML master user name, which is stored in the domain's internal user database.</p>"""
    master_backend_role: NotRequired["capo_opensearch.types.backend_role.BackendRole"]
    """<p>The backend role that the SAML master user is mapped to.</p>"""
    subject_key: NotRequired["capo_opensearch.types.string.String"]
    """<p>Element of the SAML assertion to use for the user name. Default is <code>NameID</code>.</p>"""
    roles_key: NotRequired["capo_opensearch.types.string.String"]
    """<p>Element of the SAML assertion to use for backend roles. Default is <code>roles</code>.</p>"""
    session_timeout_minutes: NotRequired[
        "capo_opensearch.types.integer_class.IntegerClass"
    ]
    """<p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

True to enable SAML authentication for a domain.

idp instance-attribute 

idp: NotRequired[SAMLIdp]

The SAML Identity Provider's information.

master_backend_role instance-attribute 

master_backend_role: NotRequired[BackendRole]

The backend role that the SAML master user is mapped to.

master_user_name instance-attribute 

master_user_name: NotRequired[Username]

The SAML master user name, which is stored in the domain's internal user database.

roles_key instance-attribute 

roles_key: NotRequired[String]

Element of the SAML assertion to use for backend roles. Default is roles.

session_timeout_minutes instance-attribute 

session_timeout_minutes: NotRequired[IntegerClass]

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

subject_key instance-attribute 

subject_key: NotRequired[String]

Element of the SAML assertion to use for the user name. Default is NameID.