Roles and Permissions

This guide explains the purpose of each role and the permissions they grant within your organization.

Understanding Roles

• Admin: The most powerful role. Admins have full access to all features and settings.
• Developer: A technical role for team members who need to manage domains, API keys, and webhooks.
• User: A read-only role. Users can view the dashboard and a list of domains but cannot make any changes.

Default Roles and Management

To get started quickly, the first user to sign up and create an organization is automatically assigned the Admin role.

Any new users who are invited to join that organization will be assigned the User role by default.

As an Admin, you can change these roles at any time:

1. Navigate to Settings > Team.
2. In the "Current Team Members" table, click the three-dots button next to a user's name.
3. Select the Manage User option.

Role Capabilities Summary

This table provides a comprehensive overview of the permissions for each role.

Permission Details

Here is a detailed breakdown of what each permission allows a user to do.

• View Dashboard (VIEW_DASHBOARD)

  • Allows the user to view the main dashboard and see high-level metrics.

• View Domains (VIEW_DOMAINS)

  • Allows the user to view a list of domains and their details.

• View Developer Portal (VIEW_DEVELOPER)

  • Allows the user to access the Developer Portal page.

• View Servers (VIEW_SERVERS)

  • Allows the user to view the list of configured servers.

• View Email Settings (VIEW_EMAIL)

  • Allows the user to view the email sender settings.

• View Reports (VIEW_REPORTS)

  • Allows the user to access the Report Center and view all reports.

• Manage Domains (MANAGE_DOMAINS)

  • Allows the user to add, edit, and delete domains.

• Manage API Keys (MANAGE_API_KEY)

  • Allows the user to generate new API keys in the Developer Portal.

• Revoke API Key (REVOKE_API_KEY)

  • Allows the user to revoke existing API keys.

• Manage Webhooks (MANAGE_WEBHOOKS)

  • Allows the user to create, edit, and delete webhooks.

• Manage Servers (MANAGE_SERVERS)

  • Allows the user to add, edit, and delete servers.

• Manage User Roles (MANAGE_USER_ROLES)

  • Allows the user to change the role of other team members.

• Manage Team (MANAGE_TEAM)

  • Allows the user to invite and remove team members.

• Manage Subscription (MANAGE_SUBSCRIPTION)

  • Allows the user to view and change subscription plans and access billing history.

• Manage Email Settings (MANAGE_EMAIL_SETTINGS)

  • Allows the user to configure and verify the custom email sender settings.

• Manage Brand Customization (MANAGE_BRAND)

  • Allows the user to manage the organization's white-label customization settings.