OAuthConfig
Configuration details for OAuth authentication with a third-party service.
Contents
- authUrl
-
The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}([-a-zA-Z0-9()@:%_\+.~#?&\/=]*)Required: Yes
- tokenEndpointAuthenticationScheme
-
The authentication scheme used when requesting tokens from the token endpoint.
Type: String
Valid Values:
HTTP_BASIC | REQUEST_BODY_CREDENTIALSRequired: Yes
- tokenUrl
-
The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}([-a-zA-Z0-9()@:%_\+.~#?&\/=]*)Required: Yes
- oAuthCompleteRedirectUrl
-
The URL where users are redirected after completing the OAuth authorization process.
Type: String
Required: No
- proactiveRefreshTokenRenewal
-
Configuration for proactively refreshing OAuth tokens before they expire.
Type: ProactiveRefreshTokenRenewal object
Required: No
- scope
-
The OAuth scopes requested during authorization, which define the permissions granted to the application.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
