Skip to main content
Browse Documentation
HTTP - Management

Add many child groups to a group

Created by c.neale, last modified by r.saunders on 12 Feb 2021

Multiple child-groups can be added to a group in bulk by sending a POST request to the group's group collection with the would-be child-group ids as an array in the body.

POST/api/security/groups/{groupIdentifier}/groups

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
groupIdsbodystring[...]uuidarray of group UUIDs"11b1b360-0420-4af9-babf-eb87fccb1ad5", "bab8f5ae-e204-47e1-bd2c-6898f2db429e", "1bb3fbdb-8255-4fd4-accc-750ff87665e3", "06e80ae8-dba3-47cb-b2d7-32ebc6b9fbe0"true

Examples

Add many child-groups to a group in a single request

POST: /api/security/groups/6254736c-70e1-43b0-b769-f8e0f6359862/groups/
[
    "11b1b360-0420-4af9-babf-eb87fccb1ad5",
    "bab8f5ae-e204-47e1-bd2c-6898f2db429e",
    "1bb3fbdb-8255-4fd4-accc-750ff87665e3",
    "06e80ae8-dba3-47cb-b2d7-32ebc6b9fbe0"
]
POST: /api/security/groups/Paper%20Street%20Soap%20Company/groups/
[
    "11b1b360-0420-4af9-babf-eb87fccb1ad5",
    "bab8f5ae-e204-47e1-bd2c-6898f2db429e",
    "1bb3fbdb-8255-4fd4-accc-750ff87665e3",
    "06e80ae8-dba3-47cb-b2d7-32ebc6b9fbe0"
]

Responses

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