Skip to content

Bedrock AgentCore  >  Structures  >  OAuthCredentialProvider

OAuthCredentialProvider

Structure Class

OAuthCredentialProvider dataclass

Configuration for an OAuth 2.0 credential provider used to authenticate tool calls.

Attributes

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

Additional custom parameters to include in the OAuth 2.0 token request.

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

The default return URL for the OAuth 2.0 authorization flow.

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

The OAuth 2.0 grant type to use for authentication.

provider_arn instance-attribute 
provider_arn: str

The ARN of the OAuth 2.0 credential provider in AgentCore Identity.

scopes instance-attribute 
scopes: list[str]

The OAuth 2.0 scopes to request when obtaining an access token.