IncludedOauth2ProviderConfigInput
Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.
Contents
- clientId
-
The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
-
OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.
Type: String
Required: No
- clientSecret
-
The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- clientSecretConfig
-
A reference to the AWS Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when
clientSecretSourceis set toEXTERNAL.Type: SecretReference object
Required: No
- clientSecretSource
-
The source type of the client secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in AWS Secrets Manager.Type: String
Valid Values:
MANAGED | EXTERNALRequired: No
- issuer
-
Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.
Type: String
Required: No
- tokenEndpoint
-
OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: