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
- certificateConfigurations
-
The private certificate authority (CA) configurations for the identity provider. Use this to have AgentCore Identity trust a private CA when establishing TLS connections to identity provider endpoints. You can specify only one certificate authority configuration in this list. Provide the certificate by reference to an Amazon S3 object or an Amazon Secrets Manager secret. You can use this only together with
privateEndpoint.Type: Array of CertificateConfiguration objects
Array Members: Fixed number of 1 item.
Required: No
- 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_JWTRequired: 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: