Skip to main content

Lock to a single client

Restrict a custom role to one client company and limit its users to the engagements they're added to

Lock to a single client is a permission option on custom roles. It makes the role available to client users in addition to the default client roles, and it gives those users Firm Member-like permissions inside the engagements they're added to.
⠀

Who the role is for

The Lock to a single client option on a custom role determines who the role is for:

  • Firm users: Custom roles with Lock to a single client turned off are available for users who belong to your firm. These roles can include any of the permissions that are configurable on custom roles.

  • Client users: Custom roles with Lock to a single client turned on are available for users who belong to a client company. These roles give a user access only to the engagements they're added to.

Client users are users whose company is a client company rather than your firm.
⠀
For the default roles, see Firm permissions and roles and Client permissions overview.
⠀

Before you begin

  • The Lock to a single client option appears only for firms that have this feature enabled. Contact support for more information.

  • To create, edit, or delete custom roles, you need a role that includes access to Settings > Roles.

Create a custom role with Lock to a single client

To create a custom role with Lock to a single client enabled, follow these steps:

  1. Go to Settings > Roles and create a custom role.

  2. Turn on Lock to a single client. The permissions that can't be used with this option become unavailable.

  3. Turn on the permissions that you want users with this role to have.

  4. Click Create. The role appears as a column in the Roles table.

⠀

Role assignment

  • Lock to a single client turned on: You can assign the role only to users who belong to a client company.

  • Lock to a single client turned off: You can assign the role only to users who belong to your firm.

You select a client user's role when you create the user. After you create a user with a role that has Lock to a single client turned on, you can't change the user to a different role. For the steps to create a client user, see Client users.
⠀

Access scope

Users with a role that has Lock to a single client turned on have access to one client's data only:

  • Can access: The client company they belong to, and the engagements they're added to.

  • Can't access: Other engagements for the same client, other clients, and firm-level (system) settings.

Within an engagement, the engagement permission you give a user determines their access. For example, you can give one user permission to edit and another user read-only access. For more information, see Configure engagement permissions.
⠀

Unavailable permissions

When you turn on Lock to a single client, most other permissions become unavailable. You can't turn on the following permissions for a role that has Lock to a single client turned on:

Area

Unavailable permissions

Firm management

Can create and edit firm users

Client management

Can create and edit client companies, Can manage client users, Can lock controls

Engagement management

Can manage engagements, Can view all engagements

Template management

Can read document templates, Can read financial statement templates, Can update financial statement templates

Can edit controls is the only other permission in the role editor that you can turn on for these roles.
⠀

Change a role after you create it

You can edit a role's name and permissions at any time. The only setting you can't change is Lock to a single client: after you create the role, you can't turn it on or off. For the steps to edit a role, see Custom roles.

Did this answer your question?