OAuth2ClientCredentialConfiguration¶
Structure Class¶
OAuth2ClientCredentialConfiguration
dataclass
¶
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
Attributes¶
authorization_url
class-attribute
instance-attribute
¶
authorization_url: str | None = None
The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
role_arn
instance-attribute
¶
role_arn: str
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
secret_arn
instance-attribute
¶
secret_arn: str
The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
token_url
class-attribute
instance-attribute
¶
token_url: str | None = None
The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.