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

Get User

Gets detailed information about a user and includes user preferences and authorization exceptions. Each authorization exception type defines its own properties. The user preferences properties are shown.

Table 14-3  User Preferences
Type
Property Name
Description
string
locale
Locality
string
login_screen
Initial login screen
string
session_timeout
Session timeout in minutes
string
advanced_analytics
Make available advanced analytics statistics

Each user can have ssh keys specified as part of the defined preferences.

Table 14-4  SSH Key Properties
Type
Property Name
Description
string
type
The type of SSH key: either RSA or DSA
string
key
The contents of the SSH key
string
comment
A comment associated with this SSH key

Example Request:

GET /api/user/v1/users/joe 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: 390

{
    "user": {
        "fullname": "Joe Admin",
        "href": "/api/user/v1/users/joe",
        "initial_password": "DummyPassword",
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "logname": "joe",
        "require_annotation": false,
        "roles": ["basic"]
    }
}