DataAccessorAuthenticationDetail - Amazon Q Business

DataAccessorAuthenticationDetail

Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.

Contents

authenticationType

The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

  • AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.

  • AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

Type: String

Valid Values: AWS_IAM_IDC_TTI | AWS_IAM_IDC_AUTH_CODE

Required: Yes

authenticationConfiguration

The specific authentication configuration based on the authentication type.

Type: DataAccessorAuthenticationConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

externalIds

A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.

Type: Array of strings

Array Members: Fixed number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: