/AWS1/CL_IOXOAUTHCONFIG¶
Configuration details for OAuth authentication with a third-party service.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_authurl TYPE /AWS1/IOXAUTHURL /AWS1/IOXAUTHURL¶
The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
iv_tokenurl TYPE /AWS1/IOXTOKENURL /AWS1/IOXTOKENURL¶
The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
iv_tokenendptauthntctnscheme TYPE /AWS1/IOXTOKENENDPTAUTHNSCHEME /AWS1/IOXTOKENENDPTAUTHNSCHEME¶
The authentication scheme used when requesting tokens from the token endpoint.
Optional arguments:¶
iv_scope TYPE /AWS1/IOXSTRING /AWS1/IOXSTRING¶
The OAuth scopes requested during authorization, which define the permissions granted to the application.
iv_oauthcompleteredirecturl TYPE /AWS1/IOXSTRING /AWS1/IOXSTRING¶
The URL where users are redirected after completing the OAuth authorization process.
io_proactrefreshtokenrenewal TYPE REF TO /AWS1/CL_IOXPROACTREFRESHTOK00 /AWS1/CL_IOXPROACTREFRESHTOK00¶
Configuration for proactively refreshing OAuth tokens before they expire.
Queryable Attributes¶
authUrl¶
The authorization URL for the OAuth service, where users are directed to authenticate and authorize access.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHURL() |
Getter for AUTHURL, with configurable default |
ASK_AUTHURL() |
Getter for AUTHURL w/ exceptions if field has no value |
HAS_AUTHURL() |
Determine if AUTHURL has a value |
tokenUrl¶
The token URL for the OAuth service, where authorization codes are exchanged for access tokens.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOKENURL() |
Getter for TOKENURL, with configurable default |
ASK_TOKENURL() |
Getter for TOKENURL w/ exceptions if field has no value |
HAS_TOKENURL() |
Determine if TOKENURL has a value |
scope¶
The OAuth scopes requested during authorization, which define the permissions granted to the application.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCOPE() |
Getter for SCOPE, with configurable default |
ASK_SCOPE() |
Getter for SCOPE w/ exceptions if field has no value |
HAS_SCOPE() |
Determine if SCOPE has a value |
tokenEndpointAuthenticationScheme¶
The authentication scheme used when requesting tokens from the token endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOKENDPTAUTHNTCTNSCHEME() |
Getter for TOKENENDPOINTAUTHNTCTNSCHEME, with configurable d |
ASK_TOKENDPTAUTHNTCTNSCHEME() |
Getter for TOKENENDPOINTAUTHNTCTNSCHEME w/ exceptions if fie |
HAS_TOKENDPTAUTHNTCTNSCHEME() |
Determine if TOKENENDPOINTAUTHNTCTNSCHEME has a value |
oAuthCompleteRedirectUrl¶
The URL where users are redirected after completing the OAuth authorization process.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OAUTHCOMPLETEREDIRECTURL() |
Getter for OAUTHCOMPLETEREDIRECTURL, with configurable defau |
ASK_OAUTHCOMPLETEREDIRECTURL() |
Getter for OAUTHCOMPLETEREDIRECTURL w/ exceptions if field h |
HAS_OAUTHCOMPLETEREDIRECTURL() |
Determine if OAUTHCOMPLETEREDIRECTURL has a value |
proactiveRefreshTokenRenewal¶
Configuration for proactively refreshing OAuth tokens before they expire.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROACTREFRESHTOKRENEWAL() |
Getter for PROACTIVEREFRESHTOKENRENEWAL |