OAuthCredentialProvider

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

providerArn

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

Type: String

Pattern: arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)

Required: Yes

scopes

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

customParameters

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

Type: String to string map

Map Entries: Maximum number of 10 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Value Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

defaultReturnUrl

The default return URL for the OAuth 2.0 authorization flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: \w+:(\/?\/?)[^\s]+

Required: No

grantType

The OAuth 2.0 grant type to use for authentication.

Type: String

Valid Values: CLIENT_CREDENTIALS | AUTHORIZATION_CODE

Required: No

Contents