Add

[POST] .../v1/usergroup/add

Creates a new group users. Use this method to create a user group in the RBAC group tree before assigning users or group roles. The method validates name, checks user-group add permission 6, creates the group through the persistent layer and returns new_id. The request body is required, name must be provided and must not exceed 50 characters and parent_id defaults to 0 for a root group. Missing body, missing or too long name, denied permission, duplicate or invalid parent data and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
name String Required Group name.
parent_id Int64 Optional Parent group ID. Default is 0.

Request Example

{
  "parent_id": 0,
  "name": "Managers"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 3
  }
}