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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
rolestring · enumRequiredPossible values:
emailstring · emailRequired
Body
anyOptional
Responses
put
/{role}/bindings/users/{email}
No content

Remove a user's role

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
rolestring · enumRequiredPossible values:
emailstring · emailRequired
Responses
delete
/{role}/bindings/users/{email}
No content

Assign a role to a group

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
rolestring · enumRequiredPossible values:
groupstringRequired
Responses
put
/{role}/bindings/groups/{group}
No content

Remove a group role

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
rolestring · enumRequiredPossible values:
groupstringRequired
Responses
delete
/{role}/bindings/groups/{group}
No content
PreviousManagement APINextJust-in-time settings API

Last updated