Skip to content

Permissions and roles reference

This reference guide helps you understand the access levels and capabilities associated with different user roles in DocuBot. Use this information to manage your workspace effectively and ensure your team has the appropriate level of access.

Overview of access control

DocuBot uses a secure access model to protect your documentation projects and repository data. You sign in to the dashboard using Google Sign-In, which serves as your primary authentication method.

To manage documentation for private repositories, you must authorize DocuBot via GitHub OAuth. This connection allows the system to securely access your code for analysis without exposing your GitHub credentials.

Role definitions

DocuBot categorizes access into three primary roles. Each role is designed to support different levels of responsibility within your documentation workflow.

RolePurpose
Workspace OwnerYou have full control over the entire account, including billing, workspace settings, and all documentation projects.
AdministratorYou manage documentation projects, configure sync schedules, and select documentation styles.
ViewerYou can access the dashboard to view project statuses and generated documentation but cannot modify settings.

Permissions matrix

The following table maps specific actions to the roles that can perform them. Use this matrix to determine which role is required for common tasks.

ActionWorkspace OwnerAdministratorViewer
Create documentation projectsYesYesNo
Connect GitHub repositoriesYesYesNo
Modify sync schedulesYesYesNo
Change documentation stylesYesYesNo
Delete repositoriesYesNoNo
Manage workspace settingsYesNoNo
View documentation statusYesYesYes

Repository-level access

Permissions also apply to how DocuBot interacts with your source code and how it publishes your documentation sites.

Public vs. private visibility

You can add public repositories to DocuBot without additional authorization. However, private repositories require an active GitHub connection. If you’re an Administrator, you can connect your GitHub account to enable DocuBot to scan private code for documentation generation.

Slug reservation and ownership

When you create a documentation project, you define a unique URL slug (e.g., docubot.cc/your-product). This slug is reserved for your workspace. Only the Workspace Owner can release or change a reserved slug by deleting the associated repository project.

Support and escalation

If you encounter access issues or need to change your role within a workspace, please contact your Workspace Owner. For technical issues related to permissions or account access, reach out to our support team through the following channels: