Class OAuthUserInfoResponse

• Object
  • dw.customer.oauth.OAuthUserInfoResponse

Contains the response from the third-party OAuth server when requesting user info. Refer to the corresponding OAuth provider documentation regarding what the format might be (in most cases it would be JSON). The data returned would also vary depending on the scope.

Properties

errorStatus : String Read Only

The error status In cases of errors - more detailed error information can be seen in the error log files (specificity of error details vary by OAuth provider).

userInfo : String Read Only

The user info as a String. Refer to the corresponding OAuth provider documentation regarding what the format might be (in most cases it would be JSON). The data returned would also vary depending on the configured 'scope'.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getErrorStatus() : String

Returns the error status In cases of errors - more detailed error information can be seen in the error log files (specificity of error details vary by OAuth provider).

getUserInfo() : String

Returns the user info as a String.

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

getErrorStatus

getErrorStatus() : String

Returns the error status In cases of errors - more detailed error information can be seen in the error log files (specificity of error details vary by OAuth provider).

Returns:

the error status

getUserInfo

getUserInfo() : String

Returns the user info as a String. Refer to the corresponding OAuth provider documentation regarding what the format might be (in most cases it would be JSON). The data returned would also vary depending on the configured 'scope'.

Returns:

the user info