# Class OAuthAccessTokenResponse

- [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - [dw.customer.oauth.OAuthAccessTokenResponse](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md)

Contains OAuth-related artifacts from the HTTP response from the third-party
OAuth server when requesting an access token

## Property Summary

| Property                                                                                                                                  | Description                                               |
| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [IDToken](#idtoken): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`                     | Returns the ID token, if available                        |
| [accessToken](#accesstoken): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`             | Returns the access token                                  |
| [accessTokenExpiry](#accesstokenexpiry): [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md) `(read-only)` | Returns the access token expiration                       |
| [errorStatus](#errorstatus): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`             | Returns the error status.                                 |
| [extraTokens](#extratokens): [Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md) `(read-only)`                    | Returns a map of additional tokens found in the response. |
| [oauthProviderId](#oauthproviderid): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`     | Returns the OAuth provider id                             |
| [refreshToken](#refreshtoken): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`           | Returns the refresh token                                 |

## Constructor Summary

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

## Method Summary

| Method                                                                                                                                             | Description                                               |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [getAccessToken](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#getaccesstoken)()             | Returns the access token                                  |
| [getAccessTokenExpiry](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#getaccesstokenexpiry)() | Returns the access token expiration                       |
| [getErrorStatus](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#geterrorstatus)()             | Returns the error status.                                 |
| [getExtraTokens](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#getextratokens)()             | Returns a map of additional tokens found in the response. |
| [getIDToken](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#getidtoken)()                     | Returns the ID token, if available                        |
| [getOauthProviderId](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#getoauthproviderid)()     | Returns the OAuth provider id                             |
| [getRefreshToken](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.customer.oauth.OAuthAccessTokenResponse.md#getrefreshtoken)()           | Returns the refresh token                                 |

### Methods inherited from class Object

[assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject)

## Property Details

### IDToken

- IDToken: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`
  - : Returns the ID token, if available

***

### accessToken

- accessToken: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`
  - : Returns the access token

***

### accessTokenExpiry

- accessTokenExpiry: [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md) `(read-only)`
  - : Returns the access token expiration

***

### errorStatus

- errorStatus: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`
  - : 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).

***

### extraTokens

- extraTokens: [Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md) `(read-only)`
  - : Returns a map of additional tokens found in the response.

***

### oauthProviderId

- oauthProviderId: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`
  - : Returns the OAuth provider id

***

### refreshToken

- refreshToken: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`
  - : Returns the refresh token

***

## Method Details

### getAccessToken()

- getAccessToken(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns the access token

    **Returns:**

    - the access token, if available, null otherwise

***

### getAccessTokenExpiry()

- getAccessTokenExpiry(): [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md)
  - : Returns the access token expiration

    **Returns:**

    - the access token expiration

***

### getErrorStatus()

- getErrorStatus(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : 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](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md)
  - : 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](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns the ID token, if available

    **Returns:**

    - the ID token, if available, null otherwise

***

### getOauthProviderId()

- getOauthProviderId(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns the OAuth provider id

    **Returns:**

    - the OAuth provider id

***

### getRefreshToken()

- getRefreshToken(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns the refresh token

    **Returns:**

    - the refresh token, if available, null otherwise

***