Reset password

Reset password for specified user

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.

Body

application/json

username

string

required

User name

Response

200 - application/json

expiresAt

string

required

Time password token expires

isRedeemed

boolean

required

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

kind

enum<string>

required

Token type

Available options:

RESET_PASSWORD

token

string

required

Reset-password token

userId

string

required

User ID

email

string

User's email address

name

object

User's full name

Show child attributes

name.first

string

User's first name

name.last

string

User's last name

name.middle

string

User's middle name