Passwords

Use these methods to change client passwords as well as get a password change history.

POST[host]/api/v2/my/password/change

Change a client password

GET[host]/api/v2/my/password/changes

Get a password change history

GET[host]/api/v2/my/password/changes/{changeId}

Get password change details

Change a client password

Use this method to change a client password.

Request

Header parameters:

  • Authorization: Bearer <access_token>

  • successToken: <token> – the success token obtained after a 2FA procedure (the one initiated for a password change operation) has been successfully completed.

Body:

password string required

The new password.

POST[host]/api/v2/my/password/change

curl --location --request POST 'https://host.name/api/v2/my/password/change' \
--header 'Authorization: Bearer <token>' \
--header 'successToken: <token>' \
--data-raw '{
  "password": "Qwerty123"
}'

Response

In case of success, no response body is returned.

Get a password change history

Use this method to get a password change history.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

The following sorting parameter is available for this method:

createTime (default)

The date and time when a password was changed or restored.

GET[host]/api/v2/my/password/changes

curl --location --request GET 'https://host.name/api/v2/my/password/changes?limit=10&offset=0&sort_order=desc&sort_by=createTime' \
--header 'Authorization: Bearer <token>'

Response

A response includes the following data about each password change record:

id integer

The identifier of a password change record.

type string

The password change type. Possible values:

  • changed – a client’s password was updated by a Back Office user.

  • restored – a password was updated by a client.

createTime string

The date and time when a password was changed or restored.

RESPONSE EXAMPLE
{
  "total": 2,
  "data": [
    {
      "id": 1,
      "type": "changed",
      "createTime": "2022-01-01T00:00:00+00:00"
    },
    {
      "id": 2,
      "type": "changed",
      "createTime": "2022-01-01T00:00:00+00:00"
    }
  ]
}

Get password change details

Use this method to obtain detailed information about a specified password change record.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

changeId required

The identifier of a password change record.

GET[host]/api/v2/my/password/changes/{changeId}

curl --location --request GET 'https://host.name/api/v2/my/password/changes/1' \
--header 'Authorization: Bearer <token>'

Response

A response includes the following data about a specified password change record:

id integer

The identifier of a password change record.

type string

The password change type. Possible values:

  • changed – a client’s password was updated by a Back Office user.

  • restored – a password was updated by a client.

createTime string

The date and time when a password was changed or restored.

RESPONSE EXAMPLE
{
  "id": 1,
  "type": "changed",
  "createTime": "2022-01-01T00:00:00+00:00"
}