Update User

Updates a specified user.

Required Permissions

Requires the ADMIN role or higher. Users can update their own information except for the role.

HTTP Request

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -d login=jsmith \
     -d role_id=2 \
     -d name="John Smith" \
     -d idle_behavior=lock \
     -d idle_timeout=600 \
     -d email="john.smith@example.com" \
     -X PUT \
     https://HOSTNAME/api/sonar/users/bfd00bb0-be99-4fd5-8380-166f544975fa

Request Parameters

Role ID

• (1) Cluster administrator: User with all privileges including cluster administrator privileges.
• (2) Company administrator: User with tenant privileges.
• (3) User: User with privileges to manage user objects such as dashboards, widgets, datasets, and tickets.

Password Policy

• Minimum 9 characters.
• Alphanumeric characters and special characters must be included.
• Any three identical consecutive characters are not allowed.

Success Response

{}

Error Responses

Required argument is missing

HTTP status code 400

{
    "error_code": "null-argument",
    "error_msg": "login should be not null"
}

Invalid argument length

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "'login' must be shorter than or equal to 255 characters."
}

User identifier is not in valid GUID format

HTTP status code 400

{
    "error_code": "invalid-param-type",
    "error_msg": "guid should be guid type."
}

Duplicate login user name

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "duplicate-login"
}

Invalid email format

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "'email' parameter is not a valid email address: foo"
}

No password specified for password authentication mode

HTTP status code 400. Password must be entered if auth_mode is not specified or set to 0.

{
    "error_code": "null-argument",
    "error_msg": "password should be not null"
}

Insufficient password complexity

HTTP status code 400. Password should not contain login user name.

{
    "error_code": "invalid-argument",
    "error_msg": "password contains login name"
}

HTTP status code 400. The password does not consist of a combination of alphanumeric characters and special characters.

{
    "error_code": "invalid-argument",
    "error_msg": "password should contain digits, alphabets, and special characters"
}

HTTP status code 400. The password contains three consecutive identical characters.

{
    "error_code": "invalid-argument",
    "error_msg": "password should not repeat same characters"
}

Locale is not supported

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "unsupported locale: ru"
}

Role ID is not found

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "unknown role id: 5"
}

Menu ID is not found

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "unknown menu id: 0"
}

Invalid authentication mode

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "auth_mode should be 0 or 1. input is 2."
}

Update a user with higher privileges

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "no-permission"
}

Update own role

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "cannot update role by yourself."
}

User group is not found or available

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "user group not found: 28c1251b-2f7c-4c58-95a1-fc4a1ead877e"
}