PATCH
/
api-commerceIdentity
/
auth
/
local
/
reset
curl --request PATCH \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "username": "user101"
}'
{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
  "kind": "RESET_PASSWORD",
  "expiresAt": "2020-04-15T10:08:04.246Z",
  "isRedeemed": true,
  "userId": "6169b2d892a5f30009d76480",
  "name": {
    "first": "Pat",
    "middle": "E",
    "last": "Kake"
  },
  "email": "test@mail.com"
}

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
​
username
string
required

User name

Example:

"user101"

Response

200
application/json
OK
​
token
string
required

Reset-password token

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

​
kind
enum<string>
required

Token type

Available options:
RESET_PASSWORD
Example:

"RESET_PASSWORD"

​
expiresAt
string
required

Time password token expires

Example:

"2020-04-15T10:08:04.246Z"

​
isRedeemed
boolean
required

true: Password token has been redeemed<br />false: Password token has not been redeemed

Example:

true

​
userId
string
required

User ID

Example:

"6169b2d892a5f30009d76480"

​
name
object

User's full name

​
email
string

User's email address

Example:

"test@mail.com"

Was this page helpful?