Get User

Language:

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 90 User Preferences

Property	Type	Description
`locale`	string	Locality
`login_screen`	string	Initial login screen
`session_timeout`	string	Session timeout in minutes
`advanced_analytics`	string	Make available advanced analytics statistics

Each user can have ssh keys specified as part of the defined preferences.

Table 91 SSH Key Properties

Property	Type	Description
`type`	string	The type of SSH key: either RSA or DSA
`key`	string	The contents of the SSH key
`comment`	string	A comment associated with this SSH key

Example Request:

GET /api/user/v1/users/admin1 HTTP/1.1
Authorization: Basic abcefgMWE=
Host: zfs-storage.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": "Administrator",
        "href": "/api/user/v1/users/admin3",
        "initial_password": "password",
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "logname": "admin3",
        "require_annotation": false,
        "roles": ["basic"]
    }
}