User groups

Create group

Return Group object

• POST
• /orgstruct/groups

Request body:

Attribute	Type	Description	Nullable
externalId	String	Group external id	true
name	String	Name of group	false
description	String	Description	false
blockWebAccess	Boolean	Blocks access to the web interface for all users of the group	false
active	Boolean	Group availability for users	true
userIds	List of Integer (comma-separated)	Addition users in group by specified ids (comma-separated)	true
roles	List of role object	Addition roles in group by specified name	true

Update group

Return updated Group object

• PUT
• /orgstruct/groups/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Group external id	true
name	String	Name of group	false
description	String	Description	false
blockWebAccess	Boolean	Blocks access to the web interface for all users of the group	false
active	Boolean	Group availability for users	true
userIds	List of Integer (comma-separated)	Addition users in group by specified ids (comma-separated)	true
roles	List of role object	Addition roles in group by specified name	true

List groups

Return list of Group objects

• GET
• /orgstruct/groups/

Request parameters:

Request Parameter	Type	Description	Required
name	String	Find group by name	false
ids	List of integer	Find group by ids	false
fields	List of string	Fields to add to response object	false
userId	Integer	Find groups by user id	false
skipUserId	Integer	Find groups by skip user id	false
businessDirIds	List of Integer (comma-separated)	Find groups by businessDirIds	false
onlyActive	Boolean	<>Get only active groups. Default <code>true</code></>	false

List user groups

Return list of Group objects

• GET
• /orgstruct/users/{id}/groups

Add user to groups

Add user to selected groups

• POST
• /orgstruct/users/{id}/groups/{groupIds}

Remove groups from user

Remove groups from user

• DELETE
• /orgstruct/users/{id}/groups/{groupIds}