Get user accounts

Edit online

Retrieves the local user accounts that are configured on this library.

Request syntax

GET /v1/authentication/userAccounts
Retrieves the local user accounts that are configured on this library.

GET /v1/authenticati/userAccounts/{name}
Retrieves the user account of specified name.

Path parameters

name (string)

The unique name of the user account.

Example

> GET /v1/authentication/userAccounts 
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992
[
   {
      "name": "admin_bob", 
      "state": "disconnected", 
      "role": "Administrator", 
      "email": "bob@company.com", 
      "lastConnected": "2022-04-03T09:33:37-0700"
   }, {
        ....
      }
]

Attributes

name (string)

The unique name of the user account.

state (string)
The state of the user account. Values include the following in priority order:
State Description
locked Locked after too many unsuccessful login attempts. Administrator must unlock.
disconnected No sessions connected.
connected One or more session connected.
role (string)

The role that defines which commands the user account is allowed to execute.

email (string)

The optional email address for the user account. This email address is used for sending email notifications to this user.

lastConnected (string)

The time and date the user account was last connected to the library.