Get Password Expiration Time

Returns the information about password expiration of the user who sent this request.

This information contains the time left before the user needs to change their password and whether a system should notify them about it.

Request

HTTP Request

GET /node/api/users/password/expire-in

Request body

The request body is empty.

Response

This request returns an array of two items.

The first item is the number of milliseconds before user’s password expires. If this value is positive, the password is still valid. If it’s negative — the password expired and the user will be prompted to change it the next time they log in. If the value is 0, that means that the password lifetime isn’t set.

The second item in the array is a boolean value that signifies whether to notify the user if the password is about to expire. Notification time is set in the Password Policy’s passwordExpiredNotificationPeriod field.

[
   10000,
   false
]

Examples

Request

Bash
JavaScript
NodeJS
Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/users/password/expire-in

curl -X GET $url -u $login:$password

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/users/password/expire-in";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));

const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/users/password/expire-in";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.end();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/users/password/expire-in"

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response

[
   10000,
   false
]