View a markdown version of this page

CustomOauth2ProviderConfigOutput - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

CustomOauth2ProviderConfigOutput

Output configuration for a custom OAuth2 provider.

Contents

oauthDiscovery

The OAuth2 discovery information for the custom provider.

Type: Oauth2Discovery object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

clientAuthenticationMethod

The client authentication method used when authenticating with the token endpoint.

Type: String

Valid Values: CLIENT_SECRET_BASIC | CLIENT_SECRET_POST | AWS_IAM_ID_TOKEN_JWT | PRIVATE_KEY_JWT

Required: No

clientId

The client ID for the custom OAuth2 provider.

Type: String

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

Required: No

onBehalfOfTokenExchangeConfig

The configuration for on-behalf-of token exchange.

Type: OnBehalfOfTokenExchangeConfigType object

Required: No

privateEndpoint

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

Type: PrivateEndpoint object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

privateEndpointOverrides

The private endpoint overrides for the custom OAuth2 provider configuration.

Type: Array of PrivateEndpointOverride objects

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

Required: No

privateKeyJwtConfig

The configuration for private_key_jwt client authentication used by this OAuth2 credential provider.

Type: PrivateKeyJwtConfig object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: