POST
/
api-commerceIdentity
/
auth
/
local
/
refresh
curl --request POST \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/refresh \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}'
{
  "_id": "596f7557696e2d4d617a616c546f7621",
  "userId": "6169b2d892a5f30009d76480",
  "roles": "customer",
  "name": "Pat E Kake",
  "account": "xxxxxcxxxxxxxxxxxxxx",
  "userType": "customer",
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
  "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
refreshToken
string
required

Refresh token

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

Response

200
application/json
Sign-in response

Sign-in response body

​
_id
string

Response ID

Example:

"596f7557696e2d4d617a616c546f7621"

​
userId
string

User ID

Example:

"6169b2d892a5f30009d76480"

​
roles
string[]

User roles

Example:

"customer"

​
name
object

User's full name

Example:

"Pat E Kake"

​
account
string

Merchant account ID

Example:

"xxxxxcxxxxxxxxxxxxxx"

​
userType
string

Type of user

Example:

"customer"

​
accessToken
string

Access token

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

​
refreshToken
string

Refresh token

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

Was this page helpful?