/AWS1/CL_WKROIDCTOKENINFO¶
Contains OAuth token information returned from the identity provider, including access tokens, ID tokens, and PKCE parameters used for secure authentication.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_codeverifier TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.
iv_codechallenge TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.
iv_accesstoken TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The OAuth access token that can be used to access protected resources on behalf of the authenticated user.
iv_idtoken TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.
iv_refreshtoken TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.
iv_tokentype TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING¶
The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.
iv_expiresin TYPE /AWS1/WKRLONG /AWS1/WKRLONG¶
The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.
Queryable Attributes¶
codeVerifier¶
The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CODEVERIFIER() |
Getter for CODEVERIFIER, with configurable default |
ASK_CODEVERIFIER() |
Getter for CODEVERIFIER w/ exceptions if field has no value |
HAS_CODEVERIFIER() |
Determine if CODEVERIFIER has a value |
codeChallenge¶
The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CODECHALLENGE() |
Getter for CODECHALLENGE, with configurable default |
ASK_CODECHALLENGE() |
Getter for CODECHALLENGE w/ exceptions if field has no value |
HAS_CODECHALLENGE() |
Determine if CODECHALLENGE has a value |
accessToken¶
The OAuth access token that can be used to access protected resources on behalf of the authenticated user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSTOKEN() |
Getter for ACCESSTOKEN, with configurable default |
ASK_ACCESSTOKEN() |
Getter for ACCESSTOKEN w/ exceptions if field has no value |
HAS_ACCESSTOKEN() |
Determine if ACCESSTOKEN has a value |
idToken¶
The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDTOKEN() |
Getter for IDTOKEN, with configurable default |
ASK_IDTOKEN() |
Getter for IDTOKEN w/ exceptions if field has no value |
HAS_IDTOKEN() |
Determine if IDTOKEN has a value |
refreshToken¶
The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REFRESHTOKEN() |
Getter for REFRESHTOKEN, with configurable default |
ASK_REFRESHTOKEN() |
Getter for REFRESHTOKEN w/ exceptions if field has no value |
HAS_REFRESHTOKEN() |
Determine if REFRESHTOKEN has a value |
tokenType¶
The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOKENTYPE() |
Getter for TOKENTYPE, with configurable default |
ASK_TOKENTYPE() |
Getter for TOKENTYPE w/ exceptions if field has no value |
HAS_TOKENTYPE() |
Determine if TOKENTYPE has a value |
expiresIn¶
The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRESIN() |
Getter for EXPIRESIN, with configurable default |
ASK_EXPIRESIN() |
Getter for EXPIRESIN w/ exceptions if field has no value |
HAS_EXPIRESIN() |
Determine if EXPIRESIN has a value |