Skip to content
This documentation is currently in preview, therefore subject to change.

Roles and Permissions

Overview

The Build a Doc portal uses role-based access control (RBAC) to manage what users can do within your organisation’s subscription.


Available Roles

Admin

Full administrative access to all portal features.

PermissionAllowed
View subscription detailsYes
Change subscription planYes
Create API keysYes
Revoke API keysYes
View usage reportsYes
Export reportsYes
Invite usersYes
Remove usersYes
Change user rolesYes
View audit logsYes

Member

Standard access for team members who manage integrations.

PermissionAllowed
View subscription detailsYes
Change subscription planNo
Create API keysYes
Revoke API keysYes (own keys only)
View usage reportsYes
Export reportsYes
Invite usersNo
Remove usersNo
Change user rolesNo
View audit logsLimited

Viewer

Read-only access for monitoring and oversight.

PermissionAllowed
View subscription detailsYes
Change subscription planNo
Create API keysNo
Revoke API keysNo
View usage reportsYes
Export reportsNo
Invite usersNo
Remove usersNo
Change user rolesNo
View audit logsNo

Role Assignment

Initial Admin

The user who activates the subscription is automatically assigned the Admin role.

Assigning Roles

Admins can assign roles when:

  • Inviting new users
  • Modifying existing user permissions

Best Practices

Minimum Privilege

Assign the lowest role that enables users to perform their duties:

  • Developers viewing metrics → Viewer
  • Developers managing keys → Member
  • IT administrators → Admin

Admin Redundancy

  • Maintain at least 2 Admin users
  • Prevents lockout if one admin is unavailable

Regular Reviews

  • Periodically review user access
  • Remove users who no longer need access
  • Downgrade roles when full access is no longer needed