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

Create User

This command uses three forms:

In all three cases, a POST request to users with JSON-formatted properties in the body is sent.

Create a new local user has the following properties:

Table 14-5  Create New User Properties
Type
Property Name
Description
string
logname
New user’s login name (required)
string
fullname
New user's full name (required)
string
initial_password
Initial user password (required)
boolean
require_annotation
Optional flag to require session annotation

Clone an existing user has the following required properties:

Table 14-6  Clone User Properties
Type
Property Name
Description
string
user
Source user name
string
clonename
New clones login name
string
fullname
New clone user’s full name (local only)
boolean
password
New clone user password (local only)

Add an administrator has the following properties:

Table 14-7  Net User Properties
Type
Property Name
Description
string
netuser
Net user login name

Example creating a local user.

Example Request:

POST /api/user/v1/users HTTP/1.1
Authorization: Basic abcefgMWE=
Host: zfssa.example.com:215
Accept: application/json
Content-Type: application/json
Content-Length: 71

{"logname":"joe", "fullname":"Joe Admin", "initial_password":"letmein"}

Example Result:

HTTP/1.1 201 Created
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 386
Location: /api/user/v1/users/joe

{
    "user": {
        "href": "/api/user/v1/users",
        "logname": "joe",
        "fullname": "Joe Admin",
        "initial_password": "DummyPassword",
        "require_annotation": false,
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "roles": ["basic"],
        "exceptions": {},
        "preferences": {
            "locale": "C",
            "login_screen": "status/dashboard",
            "session_timeout": 15,
            "advanced_analytics": false,
            "keys": {}
        }
    }
}