Modify User Properties

Modifies user properties directly. The logname, type, and uid are immutable.

To add, modify, or delete roles, exceptions, preferences, SSH keys, or login tokens, see the following sections:

• RESTful API Role Service
• User Service Properties

Example Request:

PUT /api/user/v1/users/test_user HTTP/1.1

{"fullname": "Test A. User", "require_annotation": true}

Example Result:

{
    "user": {
        "href": "/api/user/v1/users/test_user",
        "logname": "test_user",
        "type": "local",
        "uid": 2000000002,
        "fullname": "Test A. User",
        "initial_password": true,
        "require_annotation": true,
        "roles": ["basic"],
        "kiosk_mode": false,
        "kiosk_screen": "status/dashboard",
        "exceptions": [],
        "preferences": {
            "href": "/api/user/v2/users/test_user/preferences",
            "locale": "C",
            "login_screen": "status/dashboard",
            "session_timeout": 15,
            "cli_idle_timeout": -1,
            "advanced_analytics": false,
            "keys": [],
            "tokens": []
        }
    }
}