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

Assign a role to a user

put

Authorizations

Path parameters

rolestring · enumRequiredPossible values:

emailstring · emailRequired

Body

anyOptional

Responses

204

Role assigned

400

Bad request

401

Unauthorized

put

HTTPcURLJavaScriptPython

PUT /o/demo-org/settings/roles/{role}/bindings/users/{email} HTTP/1.1
Host: api.p0.app
Authorization: Bearer API Key
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

400

Bad request

401

Unauthorized

delete

HTTPcURLJavaScriptPython

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

No content

Assign a role to a group

put

Authorizations

Path parameters

rolestring · enumRequiredPossible values:

groupstringRequired

Responses

201

Group role unchanged

204

Role assigned to group

400

Bad request

401

Unauthorized

put

HTTPcURLJavaScriptPython

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

No content

Remove a group role

delete

Authorizations

Path parameters

rolestring · enumRequiredPossible values:

groupstringRequired

Responses

204

Group role removed

400

Bad request

401

Unauthorized

delete

HTTPcURLJavaScriptPython

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

No content