Change Password

Changes a license user's password.

Endpoint

Method: POST
Path: /api/v4/change_password
Description: Changes a license user's password.

Authentication

See License API Authorization.

Required headers

Date (string) — RFC7231 GMT date string
Authorization (string)

Recommended headers

Accept: application/json
Content-Type: application/json

Request

Body parameters

username (string) — required
password (string) — required
new_password (string) — required

Examples

curl --location --request POST '/api/v4/change_password' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{
  "username": "String",
  "password": "string",
  "new_password": "string"
}'

var request = require('request');
var options = {
  method: 'POST',
  url: '/api/v4/change_password',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  },
  body: JSON.stringify({
    username: 'String',
    password: 'string',
    new_password: 'string'
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = JSON.stringify({
  username: "String",
  password: "string",
  new_password: "string"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("/api/v4/change_password", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests

url = "/api/v4/change_password"

payload = {
  "username": "String",
  "password": "string",
  "new_password": "string"
}

headers = {
  "Accept": "application/json",
  "Content-Type": "application/json",
  "Date": "string",
  "Authorization": "string"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

require "uri"
require "net/http"
require "json"

url = URI("/api/v4/change_password")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"
request.body = JSON.dump({
  username: "String",
  password: "string",
  new_password: "string"
})

response = http.request(request)
puts response.read_body

Schema

Request + response schema (TypeScript + JSON Schema)

Request Body

type ChangePasswordRequestBody = {
  username: string,
  password: string,
  new_password: string,
}

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
}

Response Body

type ChangePasswordResponseBody = 'password_changed'

JSON Schema

{
  "$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:

{
  status: number,
  code: string,
  message: string
}

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
}

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 }

PreviousTrack Device Variables NextGet Product Versions

Last updated 1 month ago

Was this helpful?

Good afternoon

hashtagEndpoint

hashtagAuthentication

hashtagRequired headers

hashtagRecommended headers

hashtagRequest

hashtagBody parameters

hashtagExamples

hashtagSchema

hashtagRequest Body

hashtagResponse Body

hashtagErrors

hashtagList of exceptions

Endpoint

Authentication

Required headers

Recommended headers

Request

Body parameters

Examples

Schema

Request Body

Response Body

Errors

List of exceptions