Reference Guide

Attribute Description

is_password_change_r

equired

Indicates whether the password must be changed in order to use this session created for the

built-in admin account.

The values are:

● true - Password must be changed.

● false - Password does not need to be changed.

For information about changing the password for a local user, see the Help topic for the

local_user resource type in the Reference content on page 43.

is_built_in_user

Indicates whether the user is a system-defined user, such as admin.

Example login session information

[

{

"id":"85d0dbfc-d364-47b9-ad90-0fe03efdf860",

"user"1",

"role_ids":["1"],

"idle_timeout":36000,

"is_password_change_required":false,

"is_built_in_user":true

}

]

Logging out of the REST API session

Use the following request components to log out of an existing REST API session:

Header

Accept: application/json

Content-Type: application/json

Authorization: <auth_cookie>

Operation

POST

URI

pattern

https://1.2.3.4/api/rest/logout

The server returns a 204 No Content HTTP status code and an empty response body in response to a successful logout.

Managing a REST API session