JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance RESTful Application Programming Interface
Oracle Technology Network
Library
PDF
Print View
Feedback
search filter icon
search icon

Document Information

Using This Documentation

Chapter 1 Overview

Chapter 2 Working with the API

Chapter 3 Alert Service Commands

Chapter 4 Analytics Services

Chapter 5 Hardware Services

Chapter 6 Log Commands

Chapter 7 Network Commands

Chapter 8 Problem Service Commands

Chapter 9 Role Service

Chapter 10 SAN Services

Chapter 11 Service Commands

Chapter 12 Storage Services

Chapter 13 System Commands

Chapter 14 User Service

User Service Commands

List Users

Get User

Create User

Modify Users

Delete Users

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

List Users

Each user has the following summary properties available.

Table 14-2  User Properties
Type
Property Name
Description
string
logname
Username (immutable after creation)
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:

HTTP/1.1 200 OK
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 394

{
    "users": [{
        "fullname": "Joe Admin",
        "href": "/api/user/v1/users/joe",
        ...
    }, {
        "fullname": "Super-User",
        "href": "/api/user/v1/users/root",
        ...
    }]
}