/AWS1/CL_QQBSAMLCONFIGURATION¶
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_metadataxml TYPE /AWS1/QQBSAMLMETADATAXML /AWS1/QQBSAMLMETADATAXML¶
The metadata XML that your IdP generated.
iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN¶
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.
iv_useridattribute TYPE /AWS1/QQBSAMLATTRIBUTE /AWS1/QQBSAMLATTRIBUTE¶
The user attribute name in your IdP that maps to the user email.
Optional arguments:¶
iv_usergroupattribute TYPE /AWS1/QQBSAMLATTRIBUTE /AWS1/QQBSAMLATTRIBUTE¶
The group attribute name in your IdP that maps to user groups.
Queryable Attributes¶
metadataXML¶
The metadata XML that your IdP generated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METADATAXML() |
Getter for METADATAXML, with configurable default |
ASK_METADATAXML() |
Getter for METADATAXML w/ exceptions if field has no value |
HAS_METADATAXML() |
Determine if METADATAXML has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
userIdAttribute¶
The user attribute name in your IdP that maps to the user email.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERIDATTRIBUTE() |
Getter for USERIDATTRIBUTE, with configurable default |
ASK_USERIDATTRIBUTE() |
Getter for USERIDATTRIBUTE w/ exceptions if field has no val |
HAS_USERIDATTRIBUTE() |
Determine if USERIDATTRIBUTE has a value |
userGroupAttribute¶
The group attribute name in your IdP that maps to user groups.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERGROUPATTRIBUTE() |
Getter for USERGROUPATTRIBUTE, with configurable default |
ASK_USERGROUPATTRIBUTE() |
Getter for USERGROUPATTRIBUTE w/ exceptions if field has no |
HAS_USERGROUPATTRIBUTE() |
Determine if USERGROUPATTRIBUTE has a value |