License API
Change Password

5min
Changes a license user's password
POST
Request
Header Parameters
Date
String
required
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
String
required
See "License API Authorization" article
Body Parameters
username
String
required
password
String
required
new_password
String
required
Curl
Node.js
JS
Python
Ruby
curl --location --request POST '/api/v4/change_password' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{"username":"String","password":"string","new_password":"string"}'
curl --location --request POST '/api/v4/change_password' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{"username":"String","password":"string","new_password":"string"}'
Responses
200
400
password_changed
password_changed
﻿
Schema
Request Body
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "username": { "type": "string" },
    "password": { "type": "string" },
    "new_password": { "type": "string" }
  },
  "required": ["username", "password", "new_password"],
  "additionalProperties": false
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "username": { "type": "string" },
    "password": { "type": "string" },
    "new_password": { "type": "string" }
  },
  "required": ["username", "password", "new_password"],
  "additionalProperties": false
}
﻿
Response Body
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
}
﻿
Errors
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
﻿
List of exceptions
change_password_not_allowed (400): Change password not allowed for the company
missing_headers (400): Some headers are missing
missing_parameters (400): Some parameters are missing in the request: { params }.
Updated 24 Jan 2025
Did this page help you?
Track Device Variables
Get Product Versions