List Users

Each user has the following summary properties available.

Table 115  User Properties

Type Property Name Description string logname Username (immutable after creation) number uid User ID, not enabled for Directory users string fullname Full Name string initial_password Password boolean require_annotation Flag to require session annotation string roles This user’s roles boolean kiosk_mode Kiosk user string kiosk_screen Kiosk screen

Example Request:

GET /api/user/v1/users HTTP/1.1
Authorization: Basic abcefgMWE=
Host: zfssa.example.com:215
Accept: application/json

Example Response:

 
{
    "user":
    {
        "href": "/api/user/v1/users/john",
        "logname": "john",
        "type": "local",
        "uid": 2000000000,
        "fullname": "John Doe",
        "initial_password": "DummyPassword",
        "require_annotation": false,
        "roles": [
            "basic"
        ],
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "exceptions": [
        ],
        "preferences": {
            "href": "/api/user/v1/users/john/preferences",
            "locale": "C",
            "login_screen": "status/dashboard",
            "session_timeout": 15,
            "advanced_analytics": false,
            "keys": [
            ]
        }
    }
}