Reset password

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"
}
'

import requests

url = "https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset"

payload = { "username": "user101" }
headers = {
    "x-site-context": "<x-site-context>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-site-context': '<x-site-context>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({username: 'user101'})
};

fetch('https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'user101'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset"

	payload := strings.NewReader("{\n  \"username\": \"user101\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset")
  .header("x-site-context", "<x-site-context>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"user101\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-site-context"] = '<x-site-context>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"user101\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "error": "USER_ACCOUNT_INACTIVE",
  "code": "401",
  "message": "User account is inactive"
}

{
  "error": "USER_NOT_FOUND",
  "code": "404",
  "message": "User not found"
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "code": "500",
  "message": "Internal server error"
}

PATCH

api-commerceIdentity

auth

local

reset

Reset password

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"
}
'

import requests

url = "https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset"

payload = { "username": "user101" }
headers = {
    "x-site-context": "<x-site-context>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-site-context': '<x-site-context>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({username: 'user101'})
};

fetch('https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'username' => 'user101'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-site-context: <x-site-context>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset"

	payload := strings.NewReader("{\n  \"username\": \"user101\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-site-context", "<x-site-context>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset")
  .header("x-site-context", "<x-site-context>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"user101\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/local/reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-site-context"] = '<x-site-context>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"user101\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "error": "USER_ACCOUNT_INACTIVE",
  "code": "401",
  "message": "User account is inactive"
}

{
  "error": "USER_NOT_FOUND",
  "code": "404",
  "message": "User not found"
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "code": "500",
  "message": "Internal server error"
}

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

token

string

required

Reset-password token

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

kind

enum<string>

required

Token type

Available options:

RESET_PASSWORD

Example:

"RESET_PASSWORD"

expiresAt

string<date-time>

required

Time password token expires

Example:

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

isRedeemed

boolean

required

true: Password token has been redeemed
false: Password token has not been redeemed

Example:

true

userId

string

required

User ID

Example:

"6169b2d892a5f30009d76480"

name

object

User's full name

Show child attributes

string

User's email address

Example:

"test@mail.com"

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Reset password

Authorizations

Headers

Body

Response