Go to main content

Oracle® ZFS Storage Appliance RESTful API Guide, Release OS8.8.0

Exit Print View

Updated: November 2018
 
 

List Users

Each user has the following summary properties available.

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

Example Request:

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

Example Response:

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