Skip to main content

Preferences

You can access your preferences by clicking your avatar in the bottom left corner in the horizontal navigation panel.

Profile options

Profile

Your profile

Manage your name, email, and phone number.

Manage organization

Name

Edit the name of your organization.

Data retention

Set the number of days of data to retain for:

  • Audit logs
  • Analytic batches & events
  • Completed Action Cards and Action Flows
  • SDK request debugger logs
  • Webhook logs

Note: Purging this data has no impact on the insights dashboard.

By default this is set to 365 days on new Organizations.

Authentication preferences

Make Multi-Factor Authentication (MFA) required for your Workbench members.

Change the inactivity period after which workbench members will be logged out, this period is expressed in minutes and defaults to 30 minutes.

Tool preferences

Show all JWT claims in SDK request debugger

Enabling this setting will log all JWT claims in a given SDK request in the request debugger tool. Depending on the content in the JWT this may include sensitive information.

Manage environments

Manage your environments, including adding new environments.

Configure analytics export settings for your environment:

  • in the Environments list select the context menu of the desired environment
  • enable the inclusion of test cards, request payloads and/or card responses

Configure your environment to require authentication for magic links:

  • in the Environments list select the context menu of the desired environment
  • enable Require Authentication in the Magic Links section

Workbench members

Note: only Workbench members with edit permissions to the ‘Workbench user group assignment’ resource can invite members.

Click on the 'manage' button in the bottom left, and select ‘Workbench members’, then ’Invite new member’. Enter the person's first and last name, email address, and the group(s) you'd like them to belong to.

Manage options

You can revoke an invite by navigating to the ‘settings’ tab, then select ‘team members’, and ‘invites’. Select the menu on the right, then ‘cancel’.

Single sign-on (SSO)

Atomic supports Workbench members logging in using either an email and password, or Single sign-on (SSO). When using SSO authentication, it is also possible to manage authorisation by your identity provider. Contact us with the name of your identity provider, and we’ll provide you the configuration instructions.

Permissions

Atomic gives fine grained control of the permissions assigned to team members, so you can configure them to match your organization’s roles.

Permissions overview

Workbench team members can be assigned to one or more groups. Each group has access to roles. Each Role gives access to specific resources. We’ll cover what each of these different levels of access are in detail below, so you can configure your account to best suit your organization.

By default a new Atomic organization comes with three roles (Owner, Admin, and Editor), each with default permission levels outlined in the Permissions for default roles table.

Resource

There are many different resource types in the Atomic Workbench which Workbench members can interact with.

Each resource type has up to three permissions, which specify the actions that can be taken by the member for that resource:

  1. View
  2. Edit
  3. Admin

Some resources only offer a limited set of actions, for example 'Activity log' can only be viewed.

See the Permissions resources section for a description of each different resource and the access available.

Role

A role is a collection of one or more permissions. For example, a custom role called "Card editor" could have the permission to edit the card templates resource as well as the permission to view the theme resource.

Create a role
  1. In the Workbench Members area, select the ‘Role’ tab, select ‘Create new role’
  2. Give the new role a name and description
  3. Select each resources and its corresponding permission level
  4. Select ‘Create role’
Update a role
  1. Select the role from the Workbench Members area.
  2. Make the required changes (add or remove permissions to a resource, and/or add additional resources)
  3. Click Update role button in top right corner.
  4. Refresh the page when you're making changes to permissions for your own logged in workbench user for the changes to take effect.

Groups

A group is a collection of roles, based on particular job functions. Groups can be scoped to all or only specific environments. By default a group is assigned the role for all environments in the organization. For example, a “Card creator” role and a “Theme viewer” role.

Create a new group:

  1. In the Workbench Members area, select the ‘Groups’ tab, then ‘Create new group’
  2. Give the new group a name and description
  3. Select the Role(s) the group will have access to
  4. (optional) Select the specific environments. See the comment below about resources being scoped to the environment or organization level.
  5. Select ‘Create group’
Resources are scoped to the environment or the organization level

Some permissions can not be limited to an environment level, because their corresponding resource has an organization-wide scope.
Read more in the Scoping of resources section to understand what this means for your setup.

Configure permissions for your team

Team members

Workbench members can be given memberships to one or more groups. Based on those groups they’ll be granted permission to access the specified resources and environments.

workbench user group assignment permission required

Only workbench members with permissions to the ‘Workbench user group assignment’ resource can add or remove workbench members from groups.

Invite a new workbench member
  1. Click the 'manage' button in the bottom left corner and select Workbench members.
  2. Click ‘invite new member’.
  3. Add their first and last name, email address, then select the Group(s) they will have access to.
  4. Select ‘Invite’ to send them an invite via email.
Disable a workbench member
  1. Click your avatar in the bottom left corner > Workbench members
  2. Select the overflow menu for the team member you wish to disable, and select ‘Disable’.

Scoping of resources

Some resources can be limited to one or more environments, other resources have permissions that are set on an organization level. The list of permissions that can only be applied to the whole organization are listed in the Organization-scoped workbench resources section of the Permissions resources guide.

To limit access of permissions to certain environments only, you need to explicitly select the environment names the group does have access to. If no environment has been selected, the group has access to all environments.

Any groups that are limited to specific environments will not have access to any of the resources that are controlled by organization-level permissions. To grant workbench members access to an organization-level resource, make them part of a role and a group that has explicit access to (one or more of these) organization-level permissions, ensure the group is scoped to allow access to all environments.

Example of an environment and organization scoped permission group

A group "analysts" needs:

  • access to the analytics exporter for 1 (test) environment
  • access to the audit log (an organization level resource)

The way to achieve this, is by creating 2 roles and assigning them to 2 groups. It's good practice to use the same name for a role and its corresponding group.

  • the "analytics - test" role has view permission to the analytics exporter resource. The "analytics - test" group is scoped to only allow access to the "test" environment within the organization
  • the "audit log" role has access to the audit log and the "audit log" group has access to all environments