GetOauth2CredentialProvider
Retrieves information about an OAuth2 credential provider.
Request Syntax
POST /identities/GetOauth2CredentialProvider HTTP/1.1
Content-type: application/json
{
"name": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- name
-
The name of the OAuth2 credential provider to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9\-_]+Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"callbackUrl": "string",
"clientSecretArn": {
"secretArn": "string"
},
"createdTime": number,
"credentialProviderArn": "string",
"credentialProviderVendor": "string",
"lastUpdatedTime": number,
"name": "string",
"oauth2ProviderConfigOutput": { ... }
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- callbackUrl
-
Callback URL to register on the OAuth2 credential provider as an allowed callback URL. This URL is where the OAuth2 authorization server redirects users after they complete the authorization flow.
Type: String
- clientSecretArn
-
The Amazon Resource Name (ARN) of the client secret in AWS Secrets Manager.
Type: Secret object
- createdTime
-
The timestamp when the OAuth2 credential provider was created.
Type: Timestamp
- credentialProviderArn
-
ARN of the credential provider requested.
Type: String
Pattern:
arn:(aws|aws-us-gov):acps:[A-Za-z0-9-]{1,64}:[0-9]{12}:token-vault/[a-zA-Z0-9-.]+/oauth2credentialprovider/[a-zA-Z0-9-.]+ - credentialProviderVendor
-
The vendor of the OAuth2 credential provider.
Type: String
Valid Values:
GoogleOauth2 | GithubOauth2 | SlackOauth2 | SalesforceOauth2 | MicrosoftOauth2 | CustomOauth2 | AtlassianOauth2 | LinkedinOauth2 | XOauth2 | OktaOauth2 | OneLoginOauth2 | PingOneOauth2 | FacebookOauth2 | YandexOauth2 | RedditOauth2 | ZoomOauth2 | TwitchOauth2 | SpotifyOauth2 | DropboxOauth2 | NotionOauth2 | HubspotOauth2 | CyberArkOauth2 | FusionAuthOauth2 | Auth0Oauth2 | CognitoOauth2 - lastUpdatedTime
-
The timestamp when the OAuth2 credential provider was last updated.
Type: Timestamp
- name
-
The name of the OAuth2 credential provider.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9\-_]+ - oauth2ProviderConfigOutput
-
The configuration output for the OAuth2 provider.
Type: Oauth2ProviderConfigOutput object
Note: This object is a Union. Only one member of this object can be specified or returned.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
This exception is thrown when a request is denied per access permissions
HTTP Status Code: 403
- DecryptionFailure
-
Exception thrown when decryption of a secret fails.
HTTP Status Code: 400
- InternalServerException
-
This exception is thrown if there was an unexpected error during processing of request
HTTP Status Code: 500
- ResourceNotFoundException
-
This exception is thrown when a resource referenced by the operation does not exist
HTTP Status Code: 404
- ThrottlingException
-
This exception is thrown when the number of requests exceeds the limit
HTTP Status Code: 429
- UnauthorizedException
-
This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
