user

The user command lets Admin users manage user accounts in DisplayNet.

info

All user subcommands require the Admin role, except invalidatemylogintoken, which is available to any authenticated user.

Command Type	DisplayNet
Minimum Version	2.x.x

Usage

user add -username <username> -password <password> [-role <role>] [-fullname <fullname>]
user update -username <username> [-password <password>] [-role <role>] [-fullname <fullname>]
user delete -username <username>
user password <username> <newpassword>
user list
user invalidatelogintoken -username <username>
user invalidatemylogintoken
user invalidatealllogintokens

Subcommands

Subcommand	Description
add (alias create)	Adds a new user. Usernames must be 5 to 15 characters and are stored lowercase.
update	Updates an existing user. Only the provided parameters are changed.
delete	Deletes an existing user.
password	Changes another user's password and invalidates all of their login tokens.
list	Returns all user accounts.
invalidatelogintoken	Invalidates a specific user's login token, forcing re-authentication with credentials.
invalidatemylogintoken	Invalidates the current user's own login token. Does not require Admin.
invalidatealllogintokens	Invalidates all active login tokens for all users.

Protected accounts

The DisplayNet account password cannot be changed. The DNAdmin role cannot be changed, and the DNAdmin and DisplayNet accounts cannot be deleted. Users cannot change their own role or delete their own account.

Arguments

Argument	Required	Description
-username	add, update, delete, invalidatelogintoken	The target username.
-password	add	The password for the user.
-role	No	The user's role: Admin or User. Defaults to User.
-fullname	No	The user's full name. Supports spaces, e.g. -fullname John Smith.

Examples

Add an operator account
user add -username frontdesk -password s3cret -role User -fullname Front Desk

Promote a user to Admin
user update -username frontdesk -role Admin

Reset a user's password (Admin)
user password frontdesk newpass123

Return value

user list

user list
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "AuthorizedUsers": [
      {
        "UserName": "DisplayNet",
        "UserRole": "User",
        "FullName": "DisplayNet"
      },
      {
        "UserName": "DNAdmin",
        "UserRole": "Admin",
        "FullName": "DNAdmin"
      }
    ]
  },
  "error": null
}

Other subcommands

user delete -username someuser
{
  "status": "SUCCESS",
  "request_id": null,
  "result": null,
  "error": null
}

REST API

Endpoint type	DisplayNet API command
Address	POST /api/displaynet/<operation>, or name the operation in the body of a POST /api/displaynet. See Sending commands.
Role	Admin

Subcommand	Operation	Parameters
add	user_add	[args]*
delete	user_delete	[args]*
invalidatealllogintokens	user_invalidatealllogintokens	—
invalidatelogintoken	user_invalidatelogintoken	[args]*
list	user_list	—
password	user_password	username new_password
update	user_update	[args]*

A parameter in brackets is optional. A parameter marked * takes the remainder of the command line as one string. Pass the text exactly as you would type it on the TCI interface.

See also

• login / logintoken: authenticate a session
• password: change your own password