Skip to main content

Add user to a group

Log in to add to favourites
PUT/api/security/groups/{groupIdentifier}/users/{userIdentifier}

Parameters

NameParameter typeTypeFormatDescription
UserIdentifier(required)pathstringuser identifier For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id.
groupIdentifier(required)pathstringgroup identifier For convenience, Group resources can be referenced by using either the group name or id

Responses

HTTP status codeReasonModel
204Success
401UnauthorizedError
403ForbiddenError
404Group not foundError
404User not foundError
500Internal server errorError

Examples

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

Remarks

Permissions

Member of System Administrators.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request