Skip to main content

Roles and permissions

This section describes the access control model Uniform uses. Uniform manages users as part of a team. Roles are assigned to users.

Permissions are assigned to composition components to control which roles can create different compositions. Custom permissions enable more granular control over access to composition components. After configuring users and roles, team administrators can navigate to a composition component in Canvas, choose the permissions tab, and add role-based permissions to the component.

Users and API keys

Uniform functionality is always performed by either a user or an API key. Therefore, access control is applied to users and API keys.

  • Access control is set on the project level. This enables a specific user or API key to be granted permissions on a per-project basis.
  • Access control is granted in one of two ways: roles or custom permissions.
  • If roles are used, the permissions assigned role(s) are granted.
  • If custom permissions are used, the custom permissions are granted.

Roles

Roles are a reusable collection of permissions that can be assigned to users and API keys.

info

Only team admins can create, edit and delete roles.

Create role

You create a new user by inviting the person to Uniform.

  1. In Uniform, navigate to Security > Roles.

  2. Click the red (+) button.

  3. Enter the role's name

  4. Select the permissions you want to assign.

    About this step

    See the roles & permissions reference for details about the individual permissions that are supported.

  5. Click Add Role.

Edit role

Editing a role enables you to change the permissions for the role.

  1. In Uniform, navigate to Security > Roles.

  2. Click the name of the role you want to edit.

  3. Select the permissions you want to assign.

    About this step

    See the roles & permissions reference for details about the individual permissions that are supported.

  4. Click Save.

Delete role

Deleting a role enables you to remove the role from your Uniform team.

  1. In Uniform, navigate to Security > Roles.
  2. Click the name of the role you want to delete.
  3. Click Delete Role.
  4. Click OK.

Default project roles

When a new project is created, the following roles are added by default:

  • Developer
  • Editor
  • Viewer
tip

Team admins can change or delete these roles. They are added for convenience and are not required in order for Uniform to function properly.

info

For information about the permissions granted to these roles, see the Roles & Permissions reference.

Composition permissions

You are able to assign permissions on composition components in order to control which roles are able to create, edit, and delete certain kinds of compositions.

Use case

If you are building a site with sensitive pages, such as those with legal information, you might want to restrict the ability to create these kinds of pages to certain users.

Assign permissions

Permissions must be assigned to a composition component to allow team members or APIs to work with compositions. Custom permissions can extend how permissions are applied. To grant Create and Read access to compositions, the user must also have "Manage Component Library" access. Also, if a role or API has read access to a composition that has been personalized, they will have read access to context elements.

  1. In Canvas > Composition library, open a component that is marked as a composition component.

  2. Navigate to the tab Permissions.

  3. Turn off the option Use team permissions.

    About this step

    When this option is enabled, any user with permission Compositions Create can create compositions using the composition component. Disabling this option allows you to override this setting to prevent users from being able to use this composition component.

  4. Click the red (+) button.

  5. Select the role you want the permissions to be applied to.

  6. Select the permissions you want to be applied:

    PermissionDescription
    ReadView compositions created using the component.
    WriteMake changes to and publish compositions created using the component.
    CreateCreate new compositions using the component
    DeleteDelete compositions created using the component.
  7. Click OK.

  8. Click Save to save the changes to the component.

    composition-permissions-9-22