Skip to content
English
  • There are no suggestions because the search field is empty.

Roles and Permissions for Users and API Keys

Use the built-in roles or create your own, and give every user and API key only the access it needs

A role decides what a user or an API key may do in your organization. OpusDNS comes with built-in roles for the most common tasks, and you can create custom roles with exactly the permissions you need.

 

Where to Find It

Path: Left sidebar → Settings → Roles

Direct URL: /settings/roles

 

Built-in roles

Built-in roles are maintained by OpusDNS and cannot be edited or deleted.

  • Owner: full access. This is the first user of the organization. The owner role is set when the organization is created and cannot be assigned or changed.
  • Admin: full access to everything in the organization.
  • Viewer: read-only access to domains, DNS, contacts, hosts, forwarding, parking, events, jobs, users and audit logs.
  • Domain Manager: full access to domains, DNS, contacts, hosts, email and domain forwarding, parking, events and jobs.
  • DNS Manager: full access to DNS zones, email forwarding and domain forwarding.
  • Billing Manager: read and manage billing.

To see exactly what a role allows, click View permissions next to it.

 

Create a custom role

  1. Go to Settings → Roles and click Add role.
  2. Enter a Name, for example Support, and an optional Description.
  3. Under Permissions, tick what the role may do per area: Read (view), Manage (create and change) and Delete. Areas include domains, DNS, contacts, hosts, email forwards, domain forwards, parking, events, jobs, billing, users, API keys, registrar credentials, tags and audit logs.
  4. Click Create.

When you change a custom role with Edit role, the new permissions apply immediately to every user and API key that holds it. A custom role cannot grant full admin access; use the built-in Admin role for that.

A role cannot be deleted while it is still assigned to a user or an API key. Give those users and keys another role first.

 

Give a user a role

Go to Settings → Users. You can choose the role when you add a user with Add User, change it with Edit user, or pick it directly in the Role column of the list.

  • Only the organization owner can give or take away the Admin role.
  • You cannot change your own role.
  • The last admin of an organization cannot be deleted.

 

Give an API key a role

Every API key has its own role, independent of the user who created it. Choose it in the Role field when you create the key under Developer → API Credentials → New API Credential. Editing a key later only changes its name and description, so create a new key if it needs a different role. See Creating API Credentials.

Give every user and every API key the narrowest role that still does the job, for example Viewer for reporting tools or DNS Manager for a script that only updates DNS records.

 

Sub-organizations

Roles belong to one organization. A user or API key in a sub-organization can only hold a role from that sub-organization. See Sub-Organizations & User Management.

 

Related