OAuthCredentialProvider
An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.
Contents
- providerArn
-
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in AWS.
Type: String
Pattern:
arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)Required: Yes
- scopes
-
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- customParameters
-
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Value Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- defaultReturnUrl
-
The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
\w+:(\/?\/?)[^\s]+Required: No
- grantType
-
Specifies the kind of credentials to use for authorization:
-
CLIENT_CREDENTIALS- Authorization with a client ID and secret. -
AUTHORIZATION_CODE- Authorization with a token that is specific to an individual end user.
Type: String
Valid Values:
CLIENT_CREDENTIALS | AUTHORIZATION_CODERequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
