OAuth2Properties
A structure containing properties for OAuth2 authentication.
Contents
- OAuth2ClientApplication
-
The client application type. For example, AWS_MANAGED or USER_MANAGED.
Type: OAuth2ClientApplication object
Required: No
- OAuth2GrantType
-
The OAuth2 grant type. For example,
AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
.Type: String
Valid Values:
AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER
Required: No
- TokenUrl
-
The URL of the provider's authentication server, to exchange an authorization code for an access token.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
Required: No
- TokenUrlParametersMap
-
A map of parameters that are added to the token
GET
request.Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 512.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: