Retrieve a reset password token

Retrieves a reset password token with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Reset password token retrieved.

Response Schema: application/json
username
required
string

Username associated with the token.

token
string

Token identifier string.

credentialId
string

Credential ID associated with the token.

expiredTime
string <date-time>

Date and time at which the password expires.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/password-tokens/{id}
Request samples
const token = await api.customerAuthentication.getResetPasswordToken({id: 'my-first-id'});
console.log(token.fields.credential);
Response samples
application/json
{
  • "token": "string",
  • "username": "string",
  • "credentialId": "string",
  • "expiredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}