Sign up for FreeKnowledge Base

Role Management API

The Roles Management API provides a consistent way to assign and revoke access control roles across users and groups within your organization. Use these endpoints to manage key roles like viewer, manager, or owner for individuals or teams.

3KB
roles-settings-api.yaml
Open

Assign a role to a user

put
Authorizations
Path parameters
rolestring · enumRequiredPossible values:
emailstring · emailRequired
Body
anyOptional
Responses
204

Role assigned

No content
put
/{role}/bindings/users/{email}
PUT /o/demo-org/settings/roles/{role}/bindings/users/{email} HTTP/1.1
Host: api.p0.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

No content

Remove a user's role

delete
Authorizations
Path parameters
rolestring · enumRequiredPossible values:
emailstring · emailRequired
Responses
204

Role removed

No content
delete
/{role}/bindings/users/{email}
DELETE /o/demo-org/settings/roles/{role}/bindings/users/{email} HTTP/1.1
Host: api.p0.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Assign a role to a group

put
Authorizations
Path parameters
rolestring · enumRequiredPossible values:
groupstringRequired
Responses
201

Group role unchanged

No content
put
/{role}/bindings/groups/{group}
PUT /o/demo-org/settings/roles/{role}/bindings/groups/{group} HTTP/1.1
Host: api.p0.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove a group role

delete
Authorizations
Path parameters
rolestring · enumRequiredPossible values:
groupstringRequired
Responses
204

Group role removed

No content
delete
/{role}/bindings/groups/{group}
DELETE /o/demo-org/settings/roles/{role}/bindings/groups/{group} HTTP/1.1
Host: api.p0.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousManagement APINextJust-in-time settings API

Last updated