Skip to content

Bedrock Agentcore Control  >  Structures  >  OAuthCredentialProvider

OAuthCredentialProvider

Structure Class

OAuthCredentialProvider dataclass

An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.

Attributes

custom_parameters class-attribute instance-attribute 
custom_parameters: dict[str, str] | None = None

The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.

default_return_url class-attribute instance-attribute 
default_return_url: str | None = None

The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.

grant_type class-attribute instance-attribute 
grant_type: OAuthGrantType = OAuthGrantType('CLIENT_CREDENTIALS')

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.

  • TOKEN_EXCHANGE - Authorization using on-behalf-of token exchange. An inbound user token is exchanged for a downstream access token scoped to the target audience.

provider_arn instance-attribute 
provider_arn: str

The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.

scopes instance-attribute 
scopes: list[str]

The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.