/AWS1/CL_BDCOAUTHCREDPROVIDER¶
Configuration for an OAuth 2.0 credential provider used to authenticate tool calls.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_providerarn TYPE /AWS1/BDCOAUTHCREDPROVIDERARN /AWS1/BDCOAUTHCREDPROVIDERARN¶
The ARN of the OAuth 2.0 credential provider in AgentCore Identity.
it_scopes TYPE /AWS1/CL_BDCOAUTHSCOPES_W=>TT_OAUTHSCOPES TT_OAUTHSCOPES¶
The OAuth 2.0 scopes to request when obtaining an access token.
Optional arguments:¶
it_customparameters TYPE /AWS1/CL_BDCOAUTHCUSTPARAMS_W=>TT_OAUTHCUSTOMPARAMETERS TT_OAUTHCUSTOMPARAMETERS¶
Additional custom parameters to include in the OAuth 2.0 token request.
iv_granttype TYPE /AWS1/BDCOAUTHGRANTTYPE /AWS1/BDCOAUTHGRANTTYPE¶
The OAuth 2.0 grant type to use for authentication.
iv_defaultreturnurl TYPE /AWS1/BDCOAUTHDEFAULTRETURNURL /AWS1/BDCOAUTHDEFAULTRETURNURL¶
The default return URL for the OAuth 2.0 authorization flow.
Queryable Attributes¶
providerArn¶
The ARN of the OAuth 2.0 credential provider in AgentCore Identity.
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 2.0 scopes to request when obtaining an access token.
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¶
Additional custom parameters to include in the OAuth 2.0 token request.
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¶
The OAuth 2.0 grant type to use for authentication.
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 default return URL for the OAuth 2.0 authorization flow.
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 |