Skip to main content
Browse Documentation
HTTP - Management

Add child group to a group

Created by c.neale, last modified by s.yearsley on 24 Sep 2020

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

PUT/api/security/groups/{groupIdentifier}/groups/{childGroupIdentifier}

Parameters

NameParameter typeTypeFormatDescriptionExampleRequired
groupIdentifierpathstringgroup identifierFor 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
ChildGroupIdentifierpathobjectgroup identifierFor 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

Examples

Add a child group to a group by Id

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

Add a child group to a group by name

PUT: /api/security/groups/Paper%20Street%20Soap%20Company/groups/Liposuction%20Technicians

Add a child group to a group using a mixture of Id and name

PUT: /api/security/groups/6254736c-70e1-43b0-b769-f8e0f6359862/groups/Liposuction%20Technicians

Remarks

A group cannot be added as a child group of itself.

Responses

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