Group Management API Methods
Rest API methods to manage groups, including creating, updating, listing, deleting groups.
Create a Group
A POST method to create a new user group.
Request
POST /api/v1/groups/
Sample Request Body
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Response
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
Update a Group
A PUT method to update a user group.
Request
PUT /api/v1/groups/<groupId>
Sample Request Body
{
"name" : <string>,
"description" : <string_may_be_null>,
}
Response
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
List Groups
A GET method to list user groups.
Request
GET /api/v1/groups/
Response
[
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}, ...
]
Delete a Group
A DELETE method to delete a user group and remove all members from that group.
Request
DELETE /api/v1/groups/<groupId>
Returns 204 No Content if successful. In case of conflict returns 409 Conflict.
Delete Groups in Bulk
A DELETE method to delete multiple groups in bulk and remove all members from that group.
Request
DELETE /api/v1/groups/bulk-delete
Returns 204 No Content if successful. In case of conflict returns 409 Conflict.
List All Permissions for a Group
A GET method to list the permission objects on a group.
Request
GET /api/v1/groups/{groupId}/permissions
Response
[{
"objectId" : 34,
"objectType": "SEGMENT",
"permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
},
{
"objectId" : "234",
"objectType": "TRAIT",
"permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
},
{
"objectId" : 277,
"objectType": "SEGMENT",
"permissions": ["READ", "WRITE", "MAP_TO_MODELS"]
}
]
Returns 400 Bad Request if the group is inaccessible.
Set Permissions for a Group
A PUT method to update group permissions. This method overwrites the old permissions with the new permissions.
Request
PUT /api/v1/groups/{groupId}/permissions/
Response
[
{ "objectType" : "SEGMENT",
"objectId" : 563,
"permissions" : [ "READ", "WRITE"]
},
{ "objectType" : "SEGMENT",
"objectId" : 2363,
"permissions" : [ "CREATE", "WRITE"]
},
{ "objectType" : "TRAIT",
"objectId" : 83498,
"permissions" : [ "READ", "MAP_TO_SEGMENTS"]
},
{ "objectType" : "DESTINATION",
"objectId" : 304,
"permissions" : [ "READ", "WRITE", "CREATE"]
}
]
The sample response represents the updated list of permission objects.
Returns 200 OK if successful. Returns 400 if any given permission is invalid. Can also return 403 if the object is not accessible by the logged-in user.