Changing a user group

Note

The body must include the attributes id and modified to identify the corresponding entry.

Note

The ID of the entry in the path of the request must match the value of the attribute id in the body.

Note

Only the settings of subgroups can be changed. The root user group cannot be changed.

Send a PUT request to the endpoint /user/groups/{id}.

Description

The Change-User-Group request allows the user to change the settings of a user group of the organisation.

Requirements

Values of the request: Group-ID {id}d}

Objects: GroupVO

Request

To change the settings of a user group, add the Group-ID {id} to the path of the request.

For a detailed specification of the information required to change a user group's settings, the GroupVO object must be defined in the body with the following attributes:

Attributes	Description	Values
name	The name of the sub user group.	string
parent	The id of the parent user group.	integer
id	The ID of the entry.	integer
modified	The last modification date in ISO 8601 format.	string($date-time)

The following attributes are optional:

Attributes	Description	Values
children	An array with sub user groups of the parent user group, each presented as object GroupVO and possible other children as sub user group.	array

The system returns the GroupVO object with the updated information.

Example

Example request body:

{
  "name": "string",
  "parent": 0,
  "children": []
}

Responses

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.