/AWS1/CL_BDOINCLDO2PVDRCFGINP¶
Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_clientid TYPE /AWS1/BDOCLIENTIDTYPE /AWS1/BDOCLIENTIDTYPE¶
The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.
Optional arguments:¶
iv_clientsecret TYPE /AWS1/BDODEFCLIENTSECRETTYPE /AWS1/BDODEFCLIENTSECRETTYPE¶
The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.
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.
iv_issuer TYPE /AWS1/BDOISSUERURLTYPE /AWS1/BDOISSUERURLTYPE¶
Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.
iv_authorizationendpoint TYPE /AWS1/BDOAUTHENDPOINTTYPE /AWS1/BDOAUTHENDPOINTTYPE¶
OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.
iv_tokenendpoint TYPE /AWS1/BDOTOKENENDPOINTTYPE /AWS1/BDOTOKENENDPOINTTYPE¶
OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.
Queryable Attributes¶
clientId¶
The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.
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 supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.
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 |
issuer¶
Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISSUER() |
Getter for ISSUER, with configurable default |
ASK_ISSUER() |
Getter for ISSUER w/ exceptions if field has no value |
HAS_ISSUER() |
Determine if ISSUER has a value |
authorizationEndpoint¶
OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHORIZATIONENDPOINT() |
Getter for AUTHORIZATIONENDPOINT, with configurable default |
ASK_AUTHORIZATIONENDPOINT() |
Getter for AUTHORIZATIONENDPOINT w/ exceptions if field has |
HAS_AUTHORIZATIONENDPOINT() |
Determine if AUTHORIZATIONENDPOINT has a value |
tokenEndpoint¶
OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOKENENDPOINT() |
Getter for TOKENENDPOINT, with configurable default |
ASK_TOKENENDPOINT() |
Getter for TOKENENDPOINT w/ exceptions if field has no value |
HAS_TOKENENDPOINT() |
Determine if TOKENENDPOINT has a value |