Sessions
Companies & Users
API Keys & Permissions
Blocks
Server-to-Server (Auth Key)
OAuth 2.0
Analytics
Billing
Powered by DocStar
  1. API reference
  2. API Keys, Roles & Permissions
  3. Roles & Permissions

Roles & Permissions

Roles and permissions are scoped per company: a user's role in one company has no bearing on their role in another. Permissions attach to roles, not directly to users.

#

Default roles

Every company gets two default roles: Owner and User, each with a predefined set of permissions.

#

Creating custom roles

You can create custom roles for a Block, picking from existing permissions or creating new ones as needed. Use the List Company Roles, Create Company Role, Update Company Role and Delete Company Role endpoints in this module, or the Roles endpoints in Server-to-Server (Auth Key) from your backend.

#

Hiding the default roles

To hide the Owner or User role from the assignable list, go to the Manage Members tab, then the Settings section, then the Hidden roles dropdown. Only Owner and User are selectable here.

Hiding a role removes it from the assignable list going forward. It does not change or hide the role for users who already have it.

#

Hiding a custom role

To hide a custom role, go to the Manage Members tab, open the Roles section and toggle it off.

On this page

  • Default roles
  • Creating custom roles
  • Hiding the default roles
  • Hiding a custom role
336Blocks User API · API documentation

Build with 36Blocks User. Let AI do the rest.

Copy the instructions, paste them into your AI, and tell it what you want to build.

Paste into your AI and tell it what you want to build.

·
Published with DocStar