Class OAuthAccessTokenResponse
dw.customer.oauth
Class OAuthAccessTokenResponse
Object
dw.customer.oauth.OAuthAccessTokenResponse
Contains OAuth-related artifacts from the HTTP response from the third-party OAuth server when requesting an access token
Properties
accessToken  :  String  (Read Only)
The access token
accessTokenExpiry  :  Number  (Read Only)
The access token expiration
errorStatus  :  String  (Read Only)
The error status. In cases of errors - more detailed error information can be seen in the error log files (specifity of error details vary by OAuth provider).
extraTokens  :  Map  (Read Only)
A map of additional tokens found in the response.
IDToken  :  String  (Read Only)
The ID token, if available
oauthProviderId  :  String  (Read Only)
The OAuth provider id
refreshToken  :  String  (Read Only)
The refresh token
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAccessToken() : String
Returns the access token
getAccessTokenExpiry() : Number
Returns the access token expiration
getErrorStatus() : String
Returns the error status.
getExtraTokens() : Map
Returns a map of additional tokens found in the response.
getIDToken() : String
Returns the ID token, if available
getOauthProviderId() : String
Returns the OAuth provider id
getRefreshToken() : String
Returns the refresh token
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getAccessToken
getAccessToken() : String
Returns the access token
Returns:
the access token, if available, null otherwise
getAccessTokenExpiry
getAccessTokenExpiry() : Number
Returns the access token expiration
Returns:
the access token expiration
getErrorStatus
getErrorStatus() : String
Returns the error status. In cases of errors - more detailed error information can be seen in the error log files (specifity of error details vary by OAuth provider).
Returns:
the error status, if available, null otherwise
getExtraTokens
getExtraTokens() : Map
Returns a map of additional tokens found in the response.
Returns:
Additional tokens provided by the token end-point. May be null or empty.
getIDToken
getIDToken() : String
Returns the ID token, if available
Returns:
the ID token, if available, null otherwise
getOauthProviderId
getOauthProviderId() : String
Returns the OAuth provider id
Returns:
the OAuth provider id
getRefreshToken
getRefreshToken() : String
Returns the refresh token
Returns:
the refresh token, if available, null otherwise