JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance RESTful Application Programming Interface
Oracle Technology Network
Print View
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

Modify Users

Modifies user properties directly. User resources: exceptions, preferences, and ssh keys can be added, modified or removed.

Example Request:

PUT /api/user/v1/users/joe HTTP/1.1
Authorization: Basic abcefgMWE=
Accept: application/json
Content-Type: application/json
Content-Length: 24

{"require_annotation": true}

Example Result:

HTTP/1.1 202 Accepted
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 236

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