Remove Users

Deletes the specified users.

HTTP Request

DELETE /api/sonar/users
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     -X DELETE \
     "https://HOSTNAME/api/sonar/users?guids=6ba6031e-9d03-4a2b-8372-20ceee8f2a76"
Request Parameter
KeyRequiredTypeDescriptionNote
guidsOStringUser identifier listComma-separated list

Success Response

{
    "failures": []
}

Error Responses

Required argument is missing

HTTP status code 400

{
    "error_code": "null-argument",
    "error_msg": "guids should be not null"
}
User Identifier is not in valid GUID format

HTTP status code 400

{
    "error_code": "invalid-param-type",
    "error_msg": "guids should be guid type."
}
Delete a user with higher privileges

HTTP status code 200

{
    "failures": [
        {
            "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
            "login": "xeraph"
            "name": "Yang BongYeol",
            "reason": "no-permission",
        }
    ]
}
Delete own account

HTTP status code 200

{
    "failures": [
        {
            "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
            "login": "xeraph"
            "name": "Yang BongYeol",
            "reason": "cannnot-remove-yourself",
        }
    ]
}
User is not found

HTTP status code 200. The same error response is returned when a non-cluster administrator attempts to delete an account that belongs to another company (tenant).

{
    "failures": [
        {
            "guid": "6ba6031e-9d03-4a2b-8372-20ceee8f2a75"
            "reason": "user-not-found",
        }
    ]
}