Skip to content
Build a Doc
Home Documentation Support
This documentation is currently in preview, therefore subject to change.

Manage Portal Users

Overview

Control who can access your Build a Doc portal and what they can do with role-based permissions.

User Roles

PermissionAdminMemberViewer
View subscription details✅✅✅
Change subscription plan✅❌❌
Create API keys✅✅❌
Revoke API keys✅⚠️*❌
View usage reports✅✅✅
Export reports✅✅❌
Invite users✅❌❌
Remove users✅❌❌
Change user roles✅❌❌
View audit logs✅⚠️**❌
Access documentation✅✅✅

*Member can revoke only their own API keys **Member has limited audit log access

Inviting Users

  1. Sign in to the portal as an Admin
  2. Navigate to Users
  3. Click Add User
  4. Enter the user’s email address
  5. Select the role to assign
  6. Click Send Invitation

The user will be invited to join.

Changing User Roles

  1. Go to Users in the portal
  2. Find the user to modify
  3. Update the role
  4. Save changes

Removing Users

  1. Go to Users in the portal
  2. Find the user to remove
  3. Click Deactivate
  4. Confirm the action

What happens:

  • User immediately loses portal access
  • API keys created by the user remain active
  • Consider revoking their API keys as well

Best Practices

Minimum Privilege

Assign the lowest role that allows users to do their job:

  • Developers who only view reports → Viewer
  • Developers who manage integrations → Member
  • IT administrators → Admin

Regular Review

Periodically review user access:

  • Remove inactive users
  • Verify roles are still appropriate
  • Check for users who have left the organisation

Admin Redundancy

Ensure multiple admins exist to:

  • Avoid single point of failure
  • Coverage during absences