Create User Group

Creates a new user group.

HTTP Request

POST /api/sonar/user-groups
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     -d name="Cyber Security" \
     -X POST \
Request Parameters
nameOStringUser group nameMinimum 1 to maximum 200 characters
guidXStringUser group GUID36 characters
company_guidXStringCompany GUID36 characters. Option only available for a cluster administrator
descriptionXStringDescriptionMaximum 2,000 characters
user_guidsXArrayUser identifier groupInvalid user identifier is ignored.

Success Response


Error Responses

Required argument is missing
    "error_code": "null-argument",
    "error_msg": "name should be not null"
Invalid argument length
    "error_code": "invalid-argument",
    "error_msg": "'name' must be shorter than or equal to 200 characters."
User identifier is not in valid GUID format
    "error_code": "invalid-param-type",
    "error_msg": "user_guids should be guid type."