Create User

This command uses three forms:

• Create a new local user - creates a new local user

• Clone an existing user - clones a new user from an existing user

• Add an administrator - requires the netuser property set with the name of the network user

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": {}
        }
    }
}