oauth2_credential_providers

Creates, updates, deletes, gets or lists an oauth2_credential_providers resource.

Overview

Name	oauth2_credential_providers
Type	Resource
Id	aws.bedrock_agentcore_control.oauth2_credential_providers

Fields

The following fields are returned by SELECT queries:

get_oauth2_credential_provider

Name	Datatype	Description
name	string	The name of the OAuth2 credential provider. (pattern: <code>[a-zA-Z0-9-_]+</code>)
callback_url	string	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.
client_secret_arn	object	Contains information about a secret in Amazon Web Services Secrets Manager.
client_secret_json_key	string	The JSON key used to extract the client secret value from the Amazon Web Services Secrets Manager secret.
client_secret_source	string	The source type of the client secret. Either MANAGED if the secret is managed by the service, or EXTERNAL if managed by the user in Amazon Web Services Secrets Manager. (MANAGED, EXTERNAL)
created_time	string (date-time)	The timestamp when the OAuth2 credential provider was created.
credential_provider_arn	string	ARN of the credential provider requested. (pattern: <code>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-.]+</code>)
credential_provider_vendor	string	The vendor of the OAuth2 credential provider. (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)
failure_reason	string	The reason for failure if the OAuth2 credential provider is in a failed state.
last_updated_time	string (date-time)	The timestamp when the OAuth2 credential provider was last updated.
oauth_2_provider_config_output	object	Contains the output configuration for an OAuth2 provider.
status	string	The current status of the OAuth2 credential provider. (CREATING, CREATE_FAILED, UPDATING, UPDATE_FAILED, READY, DELETING, DELETE_FAILED)

list_oauth2_credential_providers

Name	Datatype	Description
name	string	The name of the OAuth2 credential provider. (pattern: <code>[a-zA-Z0-9-_]+</code>)
created_time	string (date-time)	The timestamp when the OAuth2 credential provider was created.
credential_provider_arn	string	The Amazon Resource Name (ARN) of the OAuth2 credential provider. (pattern: <code>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-.]+</code>)
credential_provider_vendor	string	The vendor of the OAuth2 credential provider. (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)
last_updated_time	string (date-time)	The timestamp when the OAuth2 credential provider was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_oauth2_credential_provider	select	region		Retrieves information about an OAuth2 credential provider.
list_oauth2_credential_providers	select	region		Lists all OAuth2 credential providers in your account.
create_oauth2_credential_provider	insert	region, name, credentialProviderVendor, oauth2ProviderConfigInput		Creates a new OAuth2 credential provider.
update_oauth2_credential_provider	update	region, name, credentialProviderVendor, oauth2ProviderConfigInput		Updates an existing OAuth2 credential provider.
delete_oauth2_credential_provider	delete	region		Deletes an OAuth2 credential provider.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_oauth2_credential_provider

Retrieves information about an OAuth2 credential provider.

SELECT
name,
callback_url,
client_secret_arn,
client_secret_json_key,
client_secret_source,
created_time,
credential_provider_arn,
credential_provider_vendor,
failure_reason,
last_updated_time,
oauth_2_provider_config_output,
status
FROM aws.bedrock_agentcore_control.oauth2_credential_providers
WHERE region = '{{ region }}' -- required
;

list_oauth2_credential_providers

Lists all OAuth2 credential providers in your account.

SELECT
name,
created_time,
credential_provider_arn,
credential_provider_vendor,
last_updated_time
FROM aws.bedrock_agentcore_control.oauth2_credential_providers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_oauth2_credential_provider

Creates a new OAuth2 credential provider.

INSERT INTO aws.bedrock_agentcore_control.oauth2_credential_providers (
name,
credentialProviderVendor,
oauth2ProviderConfigInput,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ credentialProviderVendor }}' /* required */,
'{{ oauth2ProviderConfigInput }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
name,
callback_url,
client_secret_arn,
client_secret_json_key,
client_secret_source,
credential_provider_arn,
oauth_2_provider_config_output,
status
;

Manifest

# Description fields are for documentation purposes
- name: oauth2_credential_providers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the oauth2_credential_providers resource.
  - name: name
    value: "{{ name }}"
  - name: credentialProviderVendor
    value: "{{ credentialProviderVendor }}"
    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']
  - name: oauth2ProviderConfigInput
    description: |
      Contains the input configuration for an OAuth2 provider.
    value:
      customOauth2ProviderConfig:
        oauthDiscovery:
          discoveryUrl: "{{ discoveryUrl }}"
          authorizationServerMetadata:
            issuer: "{{ issuer }}"
            authorizationEndpoint: "{{ authorizationEndpoint }}"
            tokenEndpoint: "{{ tokenEndpoint }}"
            responseTypes:
              - "{{ responseTypes }}"
            tokenEndpointAuthMethods:
              - "{{ tokenEndpointAuthMethods }}"
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
        onBehalfOfTokenExchangeConfig:
          grantType: "{{ grantType }}"
          tokenExchangeGrantTypeConfig:
            actorTokenContent: "{{ actorTokenContent }}"
            actorTokenScopes:
              - "{{ actorTokenScopes }}"
        clientAuthenticationMethod: "{{ clientAuthenticationMethod }}"
        privateKeyJwtConfig:
          privateKeySource:
            kmsKeySource:
              kmsKeyArn: "{{ kmsKeyArn }}"
          signingAlgorithm: "{{ signingAlgorithm }}"
          additionalHeaderClaims: "{{ additionalHeaderClaims }}"
          additionalPayloadClaims: "{{ additionalPayloadClaims }}"
        privateEndpoint:
          selfManagedLatticeResource:
            resourceConfigurationIdentifier: "{{ resourceConfigurationIdentifier }}"
          managedVpcResource:
            vpcIdentifier: "{{ vpcIdentifier }}"
            subnetIds:
              - "{{ subnetIds }}"
            endpointIpAddressType: "{{ endpointIpAddressType }}"
            securityGroupIds:
              - "{{ securityGroupIds }}"
            tags: "{{ tags }}"
            routingDomain: "{{ routingDomain }}"
        privateEndpointOverrides:
          - domain: "{{ domain }}"
            privateEndpoint:
              selfManagedLatticeResource:
                resourceConfigurationIdentifier: "{{ resourceConfigurationIdentifier }}"
              managedVpcResource:
                vpcIdentifier: "{{ vpcIdentifier }}"
                subnetIds: "{{ subnetIds }}"
                endpointIpAddressType: "{{ endpointIpAddressType }}"
                securityGroupIds: "{{ securityGroupIds }}"
                tags: "{{ tags }}"
                routingDomain: "{{ routingDomain }}"
      googleOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
      githubOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
      slackOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
      salesforceOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
      microsoftOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
        tenantId: "{{ tenantId }}"
      atlassianOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
      linkedinOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
      includedOauth2ProviderConfig:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        clientSecretConfig:
          secretId: "{{ secretId }}"
          jsonKey: "{{ jsonKey }}"
        clientSecretSource: "{{ clientSecretSource }}"
        issuer: "{{ issuer }}"
        authorizationEndpoint: "{{ authorizationEndpoint }}"
        tokenEndpoint: "{{ tokenEndpoint }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_oauth2_credential_provider

Updates an existing OAuth2 credential provider.

UPDATE aws.bedrock_agentcore_control.oauth2_credential_providers
SET 
name = '{{ name }}',
credentialProviderVendor = '{{ credentialProviderVendor }}',
oauth2ProviderConfigInput = '{{ oauth2ProviderConfigInput }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND credentialProviderVendor = '{{ credentialProviderVendor }}' --required
AND oauth2ProviderConfigInput = '{{ oauth2ProviderConfigInput }}' --required
RETURNING
name,
callback_url,
client_secret_arn,
client_secret_json_key,
client_secret_source,
created_time,
credential_provider_arn,
credential_provider_vendor,
last_updated_time,
oauth_2_provider_config_output,
status;

DELETE examples

delete_oauth2_credential_provider

Deletes an OAuth2 credential provider.

DELETE FROM aws.bedrock_agentcore_control.oauth2_credential_providers
WHERE region = '{{ region }}' --required
;