Go to main content
Oracle® ZFS Storage Appliance RESTful API Guide, Release OS8.7.0

Exit Print View

Updated: July 2017
 
 

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 116  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 117  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": "John Doe",
        "href": "/api/user/v1/users/john",
        "initial_password": "DummyPassword",
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "logname": "john",
        "require_annotation": false,
        "roles": ["basic"]
    }
}