/AWS1/CL_BDOCUSTO2PVDRCFGINPUT¶
Input configuration for a custom OAuth2 provider.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
io_oauthdiscovery TYPE REF TO /AWS1/CL_BDOOAUTH2DISCOVERY /AWS1/CL_BDOOAUTH2DISCOVERY¶
The OAuth2 discovery information for the custom provider.
Optional arguments:¶
iv_clientid TYPE /AWS1/BDODEFAULTCLIENTIDTYPE /AWS1/BDODEFAULTCLIENTIDTYPE¶
The client ID for the custom OAuth2 provider.
iv_clientsecret TYPE /AWS1/BDODEFCLIENTSECRETTYPE /AWS1/BDODEFCLIENTSECRETTYPE¶
The client secret for the custom OAuth2 provider.
io_clientsecretconfig TYPE REF TO /AWS1/CL_BDOSECRETREFERENCE /AWS1/CL_BDOSECRETREFERENCE¶
A reference to the AWS Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when
clientSecretSourceis set toEXTERNAL.
iv_clientsecretsource TYPE /AWS1/BDOSECRETSOURCETYPE /AWS1/BDOSECRETSOURCETYPE¶
The source type of the client secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in AWS Secrets Manager.
io_onbehalfoftokenexchngcfg TYPE REF TO /AWS1/CL_BDOONBHLFOFTOKXCHCF00 /AWS1/CL_BDOONBHLFOFTOKXCHCF00¶
The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.
iv_clientauthntctnmethod TYPE /AWS1/BDOCLIAUTHNTCTNMETHTYPE /AWS1/BDOCLIAUTHNTCTNMETHTYPE¶
The client authentication method to use when authenticating with the token endpoint.
io_privateendpoint TYPE REF TO /AWS1/CL_BDOPRIVATEENDPOINT /AWS1/CL_BDOPRIVATEENDPOINT¶
The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.
it_privateendpointoverrides TYPE /AWS1/CL_BDOPRIVATEENDPTOVRD=>TT_PRIVATEENDPOINTOVERRIDES TT_PRIVATEENDPOINTOVERRIDES¶
The private endpoint overrides for the custom OAuth2 provider configuration.
Queryable Attributes¶
oauthDiscovery¶
The OAuth2 discovery information for the custom provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OAUTHDISCOVERY() |
Getter for OAUTHDISCOVERY |
clientId¶
The client ID for the custom OAuth2 provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTID() |
Getter for CLIENTID, with configurable default |
ASK_CLIENTID() |
Getter for CLIENTID w/ exceptions if field has no value |
HAS_CLIENTID() |
Determine if CLIENTID has a value |
clientSecret¶
The client secret for the custom OAuth2 provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRET() |
Getter for CLIENTSECRET, with configurable default |
ASK_CLIENTSECRET() |
Getter for CLIENTSECRET w/ exceptions if field has no value |
HAS_CLIENTSECRET() |
Determine if CLIENTSECRET has a value |
clientSecretConfig¶
A reference to the AWS Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when
clientSecretSourceis set toEXTERNAL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRETCONFIG() |
Getter for CLIENTSECRETCONFIG |
clientSecretSource¶
The source type of the client secret. Use
MANAGEDif the secret is managed by the service, orEXTERNALif you manage the secret yourself in AWS Secrets Manager.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTSECRETSOURCE() |
Getter for CLIENTSECRETSOURCE, with configurable default |
ASK_CLIENTSECRETSOURCE() |
Getter for CLIENTSECRETSOURCE w/ exceptions if field has no |
HAS_CLIENTSECRETSOURCE() |
Determine if CLIENTSECRETSOURCE has a value |
onBehalfOfTokenExchangeConfig¶
The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ONBEHALFOFTOKENEXCHNGCFG() |
Getter for ONBEHALFOFTOKENEXCHNGCONFIG |
clientAuthenticationMethod¶
The client authentication method to use when authenticating with the token endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTAUTHNTCTNMETHOD() |
Getter for CLIENTAUTHENTICATIONMETHOD, with configurable def |
ASK_CLIENTAUTHNTCTNMETHOD() |
Getter for CLIENTAUTHENTICATIONMETHOD w/ exceptions if field |
HAS_CLIENTAUTHNTCTNMETHOD() |
Determine if CLIENTAUTHENTICATIONMETHOD has a value |
privateEndpoint¶
The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVATEENDPOINT() |
Getter for PRIVATEENDPOINT |
privateEndpointOverrides¶
The private endpoint overrides for the custom OAuth2 provider configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVATEENDPOINTOVERRIDES() |
Getter for PRIVATEENDPOINTOVERRIDES, with configurable defau |
ASK_PRIVATEENDPOINTOVERRIDES() |
Getter for PRIVATEENDPOINTOVERRIDES w/ exceptions if field h |
HAS_PRIVATEENDPOINTOVERRIDES() |
Determine if PRIVATEENDPOINTOVERRIDES has a value |