Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

Retrieves information about an OAuth2 credential provider.

post/identities/GetOauth2CredentialProvider

Request body

namestring required

The name of the OAuth2 credential provider to retrieve.

Response

Success

clientSecretJsonKeystring

The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.

clientSecretSource'MANAGED' | 'EXTERNAL'

The source type of the client secret. Either <code>MANAGED</code> if the secret is managed by the service, or <code>EXTERNAL</code> if managed by the user in Amazon Web Services Secrets Manager.

namestring required

The name of the OAuth2 credential provider.

credentialProviderArnstring required

ARN of the credential provider requested.

credentialProviderVendor'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' required

The vendor of the OAuth2 credential provider.

callbackUrlstring

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.

createdTimestring date-time required

The timestamp when the OAuth2 credential provider was created.

lastUpdatedTimestring date-time required

The timestamp when the OAuth2 credential provider was last updated.

status'CREATING' | 'CREATE_FAILED' | 'UPDATING' | 'UPDATE_FAILED' | 'READY' | 'DELETING' | 'DELETE_FAILED'

The current status of the OAuth2 credential provider.

failureReasonstring

The reason for failure if the OAuth2 credential provider is in a failed state.