Groups

Groups are used to create permissions for different groups, roles, and personas within your organization. Groups isolate permissions on project users. Groups are synonymous with roles in the API. Example groups may include administrators, developers, content editors, and reviewers.

Permissions are attached to groups. A group can have multiple permissions and multiple members (project users). Project users can be members of multiple groups.


get

List groups

Lists all groups within a project

Required attributes

projectId
string
Your projectId

Optional attributes

None
Request
get
/api/projects/:projectId/roles
Response

get

Retrieve a group

Fetches a single group based on a provided role ID.

Required attributes

projectId
string
Your project ID
roleId
string
The ID of the role (group) to retrieve

Optional attributes

None
Request
get
/api/projects/:projectId/roles/:roleId
Response

post

Create a group

Creates a new group in a project

Required attributes

projectId
string
Your projectId
title
string
Name for your group

Optional attributes

policy
policyObject[]
An array of policy objects to attach to your group. Policies define group permissions within a project.
Request
post
/api/projects/:projectId/roles
Response

patch

Update a group

Update attributes for an existing group

Required attributes

projectId
string
Your projectId
roleId
string
The ID of the role (group) to update

Optional attributes

title
string
Name for your token
description
string
Description for your token
policy
policyObject[]
An array of policy objects to attach to your group. Policies define group permissions within a project.
Request
patch
/api/projects/:projectid/roles/:roleId
Response

delete

Delete a group

Deletes a group from your project. Deleting a group will not remove the group members from your project, it will simply remove the group and dissociates itself from any members currently a part of the group.

Required attributes

projectId
string
Your projectId
roleId
string
The ID of the role (group) to delete

Optional attributes

None
Request
delete
/api/projects/:projectId/roles/:roleId
Response

get

List group members

Fetches all project users in a specified group

Required attributes

projectId
string
Your projectId
roleId
string
The ID of the role (group) to fetch members from

Optional attributes

None
Request
get
/api/projects/:projectId/roles/:roleId/members
Response

post

Add group members

Add project users to a group

Required attributes

projectId
string
Your projectId
roleId
string
The ID of the role (group) to fetch members from
userIds
string[]
An array of project user IDs to add to the group

Optional attributes

None
Request
post
/api/projects/:projectId/roles/:roleId/members
Response

delete

Remove group member

Removes a project user / member from a group

Required attributes

projectId
string
Your projectId
roleId
string
The ID of the role (group) to fetch members from
projectUserId
string
The project user ID of the member you are removing from the group

Optional attributes

None
Request
delete
/api/projects/:projectId/roles/:roleId/members/:projectUserId
Response
Last modified 7/6/2024, 5:26:05 PM