HTTP - Management
Removed from your favourites
Add many users to a group
Created by c.neale, last modified by r.saunders on 12 Feb 2021
Multiple users can be added to a group in bulk by sending a POST request to the group's users collection with the user ids as an array in the body.
POST/api/security/groups/{groupIdentifier}/users/
Parameters
| Name | Parameter type | Type | Format | Description | Example | Required |
|---|---|---|---|---|---|---|
| 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 |
| userIds | body | string[...] | uuid | array of user UUIDs | "75490b0f-56f7-4690-a20a-6f2a822f1d3f", "20b5e923-beb8-44ab-8bb4-34467582230f", "13f8cd48-7765-47b7-9fa3-2ad9c935a4be", "3c3d98a1-c80a-49d1-b602-f38ad2b01af8", "11f5ce76-ca86-45d8-9928-d7fd56863ec7" | true |
Examples
Add many users to a group in a single request
POST: /api/security/groups/6254736c-70e1-43b0-b769-f8e0f6359862/users/
[
"75490b0f-56f7-4690-a20a-6f2a822f1d3f",
"20b5e923-beb8-44ab-8bb4-34467582230f",
"13f8cd48-7765-47b7-9fa3-2ad9c935a4be",
"3c3d98a1-c80a-49d1-b602-f38ad2b01af8",
"11f5ce76-ca86-45d8-9928-d7fd56863ec7"
]POST: /api/security/groups/Paper%20Street%20Soap%20Company/users/
[
"75490b0f-56f7-4690-a20a-6f2a822f1d3f",
"20b5e923-beb8-44ab-8bb4-34467582230f",
"13f8cd48-7765-47b7-9fa3-2ad9c935a4be",
"3c3d98a1-c80a-49d1-b602-f38ad2b01af8",
"11f5ce76-ca86-45d8-9928-d7fd56863ec7"
]