Schema permissions

Permissions in Schema Builder allow you to assign access to schemas and scope of actions you can perform (edit the schema structure, adding records to the schema, duplicating, and deleting). It helps you control the contributions to the schema and restrict the access to the defined users.

Prerequisites


To define schema permissions, you must create a schema first.

Permission types


You can assign permissions on two levels:

General schema permissions


There are four types of general schema permissions:

Permission type Explanation
Private Schema is viewable and editable by its author
Public Every user can view, edit the schema, and add records to it (default)
Read-only Only the author can edit the schema, all other users can view it
Restricted You can define different permissions for different users and user groups
Important: Regardless of the selected permission for the schema, only the author or the admin of the business profile can assign or modify permissions.

Defining general schema permissions

  1. Go to Data Management > Schema builder.
  2. On the list, find the schema you want to define permissions for.
  3. Next to the name of the schema, click the padlock icon.
  4. From the dropdown list, select the permission.
Assigning permissions to a schema
Assigning permissions to the schema

Schema record permissions


There are four types of record permissions:

Permission type Explanation
Private Only the author of the schema can add records to the schema, schema records are not visible or searchable for other users
Public All users can add records to the schema
Read-only Only the author of the schema can add records to it, all other users can view the records
Restricted You can define different permissions for different users and user groups
Important: Regardless of the selected permission for the schema, only the author or the admin of the business profile can assign or modify permissions.

Defining schema record permissions

  1. Go to Data Management > Schema builder.
  2. On the list, find and click the schema you want to define record permissions for.
  3. Click the padlock icon on any schema record.
    Assigning record permissions to a schema
    Assigning record permissions to the schema
  4. From the dropdown list, select the permission. Permission you selected is applicable for all records.
    Selecting record permissions to a schema
    Selecting record permissions to the schema

User groups and users


For the Restricted type of permission (general and schema record permissions), you can either define users or user groups and their permission scope.

Users

  1. Select the Users tab.
  2. Enter the name or email addresses of users who you want to grant permissions.
  3. Confirm your choice by clicking Add user.
  4. In the table below, select permissions for the selected users.
    • Execute to complete actions such as editing the schema or adding records to the schema.
    • Read to preview schema or records in schema.
    • Edit to edit the structure of the schema and schema records.
    • Delete to delete schemas or schema records.
  5. Confirm by clicking Apply.
Assigning record permissions to a schema
Assigning record permissions to the schema

User groups

The users groups are sourced from Settings > Roles.

Note: You can read more about Roles here.

  1. Select the User groups tab.
  2. Click the user group or user groups for which you want to define the permissions.
  3. In the table below, select permissions for the selected users.
    • Execute to complete actions such as editing the schema or adding records to the schema.
    • Read to preview the schema or records in the schema.
    • Edit to edit the structure of the schema and schema records.
    • Delete to delete schemas or schema records.
  4. Confirm by clicking Apply.
Assigning record permissions to a schema
Assigning record permissions to the schema

If there are users who are assigned with permissions as individuals and they belong to a user groups with different set of permissions at the same time, the user group permissions are applicable then.

Important: The change of permissions can take up to 5 minutes.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker