Skip to content

Qbusiness  >  Structures  >  SamlConfiguration

SamlConfiguration

Structure Class

SamlConfiguration dataclass

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

Attributes

metadata_xml instance-attribute
metadata_xml: str

The metadata XML that your IdP generated.

role_arn instance-attribute
role_arn: str

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 class-attribute instance-attribute
user_group_attribute: str | None = None

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

user_id_attribute instance-attribute
user_id_attribute: str

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