Skip to content

/AWS1/CL_DOAMCPSRVOAUTH3LOCFG

OAuth 3-legged authorization configuration for MCP server.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_clientid TYPE /AWS1/DOACLIENTID /AWS1/DOACLIENTID

OAuth client ID for authenticating with the service.

iv_returntoendpoint TYPE /AWS1/DOASTRING /AWS1/DOASTRING

The endpoint to return to after OAuth flow completes (must be AWS console domain)

iv_authorizationurl TYPE /AWS1/DOASTRING /AWS1/DOASTRING

OAuth authorization URL for 3LO authentication.

iv_exchangeurl TYPE /AWS1/DOASTRING /AWS1/DOASTRING

OAuth token exchange URL.

Optional arguments:

iv_clientname TYPE /AWS1/DOASTRING /AWS1/DOASTRING

User friendly OAuth client name specified by end user.

it_exchangeparameters TYPE /AWS1/CL_DOAEXCHANGEPARAMS_W=>TT_EXCHANGEPARAMETERS TT_EXCHANGEPARAMETERS

OAuth token exchange parameters for authenticating with the service.

iv_clientsecret TYPE /AWS1/DOACLIENTSECRET /AWS1/DOACLIENTSECRET

OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.

iv_supportcodechallenge TYPE /AWS1/DOABOOLEAN /AWS1/DOABOOLEAN

Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.

it_scopes TYPE /AWS1/CL_DOASCOPES_W=>TT_SCOPES TT_SCOPES

OAuth scopes for 3LO authentication. The service will always request scope offline_access.


Queryable Attributes

clientName

User friendly OAuth client name specified by end user.

Accessible with the following methods

Method Description
GET_CLIENTNAME() Getter for CLIENTNAME, with configurable default
ASK_CLIENTNAME() Getter for CLIENTNAME w/ exceptions if field has no value
HAS_CLIENTNAME() Determine if CLIENTNAME has a value

clientId

OAuth client ID for authenticating with the service.

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

exchangeParameters

OAuth token exchange parameters for authenticating with the service.

Accessible with the following methods

Method Description
GET_EXCHANGEPARAMETERS() Getter for EXCHANGEPARAMETERS, with configurable default
ASK_EXCHANGEPARAMETERS() Getter for EXCHANGEPARAMETERS w/ exceptions if field has no
HAS_EXCHANGEPARAMETERS() Determine if EXCHANGEPARAMETERS has a value

returnToEndpoint

The endpoint to return to after OAuth flow completes (must be AWS console domain)

Accessible with the following methods

Method Description
GET_RETURNTOENDPOINT() Getter for RETURNTOENDPOINT, with configurable default
ASK_RETURNTOENDPOINT() Getter for RETURNTOENDPOINT w/ exceptions if field has no va
HAS_RETURNTOENDPOINT() Determine if RETURNTOENDPOINT has a value

authorizationUrl

OAuth authorization URL for 3LO authentication.

Accessible with the following methods

Method Description
GET_AUTHORIZATIONURL() Getter for AUTHORIZATIONURL, with configurable default
ASK_AUTHORIZATIONURL() Getter for AUTHORIZATIONURL w/ exceptions if field has no va
HAS_AUTHORIZATIONURL() Determine if AUTHORIZATIONURL has a value

exchangeUrl

OAuth token exchange URL.

Accessible with the following methods

Method Description
GET_EXCHANGEURL() Getter for EXCHANGEURL, with configurable default
ASK_EXCHANGEURL() Getter for EXCHANGEURL w/ exceptions if field has no value
HAS_EXCHANGEURL() Determine if EXCHANGEURL has a value

clientSecret

OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.

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

supportCodeChallenge

Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.

Accessible with the following methods

Method Description
GET_SUPPORTCODECHALLENGE() Getter for SUPPORTCODECHALLENGE

scopes

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

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