Add user to a group

Created by c.neale, last modified by zengenti on 17 Jun 2022

A user can be added to a group by sending a PUT request specifying the group and user identifiers.

PUT/api/security/groups/{groupIdentifier}/users/{userIdentifier}

Parameters

Name	Parameter type	Type	Format	Description	Example	Required
UserIdentifier	path	string	user identifier	For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id.	"82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com"	true
groupIdentifier	path	string	group identifier	For convenience, Group resources can be referenced by using either the group name or id	"Paper Street Soap Company" or "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c"	true

Add a user to a group by Ids

HTTP

PUT: /api/security/groups/6254736c-70e1-43b0-b769-f8e0f6359862/users/3d063773-2ca9-4baf-90e1-ed674fa68640

Add a user to a named group

HTTP

PUT: /api/security/groups/Paper%20Street%20Soap%20Company/users/3d063773-2ca9-4baf-90e1-ed674fa68640

Add a user to a group by username

HTTP

PUT: /api/security/groups/6254736c-70e1-43b0-b769-f8e0f6359862/users/tdurden

Add a user to a group by email

HTTP

PUT: /api/security/groups/6254736c-70e1-43b0-b769-f8e0f6359862/users/t.durden@fightclub.com

Permissions

Member of System Administrators.