Adding a user account to a user group¶

Note

The body does not contain the attributes id, created, and modified. The system sets the values of these attributes after the entry is created.

Send a POST request to the endpoint /user/group/{id}/users.

Description¶

The Add-User-Group-Account request allows the user to add a user account to a user group of the organisation.

Requirements¶

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

Objects: GroupRoleVO

Request¶

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

For a detailed specification of the information required to add a user account to a user group, the GroupRoleVO object must be defined in the body with the following attributes:

Attributes	Description	Values
`email`	The email address of the user account.	`string`
`login`	The user name of the user account. This should match the email address.	`string`
`role`	The permission role for the user account.	`ADMINISTRATOR` `USER`
`userId`	The id of the user account.	`integer`

The system returns the GroupRoleVO object with the updated information.

Example¶

Example request body:

{
  "email": "string",
  "login": "string",
  "role": "ADMINISTRATOR",
  "userId": 0
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
201	The request has succeeded and a new object has been created.
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.