Change password

POST

/v1/auth/password/change

const url = 'https://example.com/v1/auth/password/change';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"current_password":"example","new_password":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/auth/password/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "current_password": "example", "new_password": "example" }'

Changes the password of the authenticated user.

Authorizations

bearerAuth

Request Body^required

application/json

object

current_password

required

string

new_password

required

string

>= 8 characters

Example^generated

{
  "current_password": "example",
  "new_password": "example"
}

Responses

204

No content

400

Invalid request body or parameters

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

401

Missing or invalid credentials

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

422

Semantic validation failure

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

500

Internal server error

application/json

object

error

required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string

code

required

string

message

required

string

data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object

topic

string

errors

Validation errors keyed by entity

object

scenario

Array<object>

object

code

SCN1xx constructor validation code

string

message

string

summary

string

tree_id

string

node_id

string

output_type

string

duplicate_tree_index

string

duplicate_node_index

string

property

string

invalid_value

string

agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}

Change password

Authorizations

Request Bodyrequired

Examplegenerated

Responses

204

400

Examplegenerated

401

Examplegenerated

422

Examplegenerated

500

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated