/AWS1/CL_BDOOAUTHCREDPROVIDER¶
An OAuth credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using OAuth.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_providerarn TYPE /AWS1/BDOOAUTHCREDPROVIDERARN /AWS1/BDOOAUTHCREDPROVIDERARN¶
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
it_scopes TYPE /AWS1/CL_BDOOAUTHSCOPES_W=>TT_OAUTHSCOPES TT_OAUTHSCOPES¶
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
Optional arguments:¶
it_customparameters TYPE /AWS1/CL_BDOOAUTHCUSTPARAMS_W=>TT_OAUTHCUSTOMPARAMETERS TT_OAUTHCUSTOMPARAMETERS¶
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
iv_granttype TYPE /AWS1/BDOOAUTHGRANTTYPE /AWS1/BDOOAUTHGRANTTYPE¶
Specifies the kind of credentials to use for authorization:
CLIENT_CREDENTIALS- Authorization with a client ID and secret.
AUTHORIZATION_CODE- Authorization with a token that is specific to an individual end user.
iv_defaultreturnurl TYPE /AWS1/BDOOAUTHDEFAULTRETURNURL /AWS1/BDOOAUTHDEFAULTRETURNURL¶
The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.
Queryable Attributes¶
providerArn¶
The Amazon Resource Name (ARN) of the OAuth credential provider. This ARN identifies the provider in Amazon Web Services.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROVIDERARN() |
Getter for PROVIDERARN, with configurable default |
ASK_PROVIDERARN() |
Getter for PROVIDERARN w/ exceptions if field has no value |
HAS_PROVIDERARN() |
Determine if PROVIDERARN has a value |
scopes¶
The OAuth scopes for the credential provider. These scopes define the level of access requested from the OAuth provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCOPES() |
Getter for SCOPES, with configurable default |
ASK_SCOPES() |
Getter for SCOPES w/ exceptions if field has no value |
HAS_SCOPES() |
Determine if SCOPES has a value |
customParameters¶
The custom parameters for the OAuth credential provider. These parameters provide additional configuration for the OAuth authentication process.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMPARAMETERS() |
Getter for CUSTOMPARAMETERS, with configurable default |
ASK_CUSTOMPARAMETERS() |
Getter for CUSTOMPARAMETERS w/ exceptions if field has no va |
HAS_CUSTOMPARAMETERS() |
Determine if CUSTOMPARAMETERS has a value |
grantType¶
Specifies the kind of credentials to use for authorization:
CLIENT_CREDENTIALS- Authorization with a client ID and secret.
AUTHORIZATION_CODE- Authorization with a token that is specific to an individual end user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GRANTTYPE() |
Getter for GRANTTYPE, with configurable default |
ASK_GRANTTYPE() |
Getter for GRANTTYPE w/ exceptions if field has no value |
HAS_GRANTTYPE() |
Determine if GRANTTYPE has a value |
defaultReturnUrl¶
The URL where the end user's browser is redirected after obtaining the authorization code. Generally points to the customer's application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTRETURNURL() |
Getter for DEFAULTRETURNURL, with configurable default |
ASK_DEFAULTRETURNURL() |
Getter for DEFAULTRETURNURL w/ exceptions if field has no va |
HAS_DEFAULTRETURNURL() |
Determine if DEFAULTRETURNURL has a value |