GET /users/{userid}

GET /users/{userid}

Get information for a specific REST API user.

User Privileges

Users with the following role privileges can perform this command:

• admin
• operator
• monitor

Note: Only admin-level users are allowed to access this resource for a userid other than themselves.

Parameters

userid

The identifier of a user. Can only contain alphanumeric characters, hyphens, and underscores.(No uppercase characters allowed)

Use: Required

JSON Schema:

    Object
    type: string
    minLength: 1
    maxLength: 32
    pattern: ^[a-zA-Z_][a-zA-Z0-9_.-]*$

Responses

200

Success

User info

JSON Schema: User

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

SERVERPLUGIN_INTERNAL_ERROR

Unexpected error

401

SERVERPLUGIN_USERID_NOT_AUTHORIZED

Loggedin user isn't allowed to perform this action for this userid.

404

SERVERPLUGIN_INVALID_USERID

User does not exist.

Example Request

   GET
   https://1.2.3.4:8443/users/admin
   { }

Example Result

{
    "actions": "/users/admin/actions",
    "accountLockTime": "2025-10-08 12:35:17 EDT",
    "accountUnlockTime": "2025-10-08 02:35:18 EDT",
    "certificates": "/users/admin/certificates",
    "changeable": false,
    "email": "",
    "files": "/users/admin/files",
    "lockedOut": false,
    "fullName": "Administrator",
    "passwordExpiryDaysRemaining": 4,
    "passwordLastChanged": "2022-08-29",
    "role": "admin",
    "status": "enabled",
    "userId": "admin"
}