Oracle^® ZFS Storage Appliance RESTful API Guide, Release OS8.8.0

Modify Users

Modifies user properties directly. User resources: exceptions, preferences, and ssh keys can be added, modified or removed. "UID" and "Type" are immutable once created.

Example Request:

PUT /api/user/v1/users/admin1 HTTP/1.1
Authorization: Basic abcefgMWE=
Host: zfs-storage.example.com:215
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/admin3",
        "logname": "admin3",
        "type": "local",
        "uid": 2000000000,
        "fullname": "Administrator",
        "initial_password": "password",
        "require_annotation": true,
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "roles": ["basic"]
    }
}