/AWS1/CL_BDOGWAPIKEYCREDPVDR¶
An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_providerarn TYPE /AWS1/BDOAPIKEYCREDPROVIDERARN /AWS1/BDOAPIKEYCREDPROVIDERARN¶
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
Optional arguments:¶
iv_credentialparametername TYPE /AWS1/BDOAPIKEYCREDPARAMNAME /AWS1/BDOAPIKEYCREDPARAMNAME¶
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
iv_credentialprefix TYPE /AWS1/BDOAPIKEYCREDPREFIX /AWS1/BDOAPIKEYCREDPREFIX¶
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
iv_credentiallocation TYPE /AWS1/BDOAPIKEYCREDENTIALLOC /AWS1/BDOAPIKEYCREDENTIALLOC¶
The location of the API key credential. This field specifies where in the request the API key should be placed.
Queryable Attributes¶
providerArn¶
The Amazon Resource Name (ARN) of the API key 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 |
credentialParameterName¶
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALPARAMETERNAME() |
Getter for CREDENTIALPARAMETERNAME, with configurable defaul |
ASK_CREDENTIALPARAMETERNAME() |
Getter for CREDENTIALPARAMETERNAME w/ exceptions if field ha |
HAS_CREDENTIALPARAMETERNAME() |
Determine if CREDENTIALPARAMETERNAME has a value |
credentialPrefix¶
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALPREFIX() |
Getter for CREDENTIALPREFIX, with configurable default |
ASK_CREDENTIALPREFIX() |
Getter for CREDENTIALPREFIX w/ exceptions if field has no va |
HAS_CREDENTIALPREFIX() |
Determine if CREDENTIALPREFIX has a value |
credentialLocation¶
The location of the API key credential. This field specifies where in the request the API key should be placed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDENTIALLOCATION() |
Getter for CREDENTIALLOCATION, with configurable default |
ASK_CREDENTIALLOCATION() |
Getter for CREDENTIALLOCATION w/ exceptions if field has no |
HAS_CREDENTIALLOCATION() |
Determine if CREDENTIALLOCATION has a value |