Skip to content

SamlConfiguration

Source code in docs_src/capo_qbusiness/types/saml_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
class SamlConfiguration(TypedDict, closed=True):
    metadata_xml: "capo_qbusiness.types.saml_metadata_xml.SamlMetadataXML"
    """<p>The metadata XML that your IdP generated.</p>"""
    role_arn: "capo_qbusiness.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.</p>"""
    user_id_attribute: "capo_qbusiness.types.saml_attribute.SamlAttribute"
    """<p>The user attribute name in your IdP that maps to the user email.</p>"""
    user_group_attribute: NotRequired[
        "capo_qbusiness.types.saml_attribute.SamlAttribute"
    ]
    """<p>The group attribute name in your IdP that maps to user groups.</p>"""

metadata_xml instance-attribute 

metadata_xml: SamlMetadataXML

The metadata XML that your IdP generated.

role_arn instance-attribute 

role_arn: RoleArn

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

user_group_attribute instance-attribute 

user_group_attribute: NotRequired[SamlAttribute]

The group attribute name in your IdP that maps to user groups.

user_id_attribute instance-attribute 

user_id_attribute: SamlAttribute

The user attribute name in your IdP that maps to the user email.