v1

latestOpenAPI 3.0.02026-07-26492143.5 KB

Organization

Manage custom role users

This endpoint allows organization administrators to add or remove users from a custom role (formerly "permission group"). Adding a user to a role does not remove them from any other role they belong to.

post/manage_permission_group_users

Request body

organization_idstring required

The ID of the organization that the custom role belongs to.

user_idstring required

Your user id -- you must be an organization admin to manage custom role users.

group_idstring required

The ID of the custom role to manage users for.

action'add' | 'remove' required

The action to perform - either 'add' or 'remove' a user.

user_emailstring required

The email address of the target user to add or remove.

Response

User successfully added to or removed from the custom role

successboolean

messagestring

A success message describing the action performed.