{"api":"esign_rest","category":"reference"}

Roles Category

Each role is associated with specific permissions. Each new member is assigned a role when you create them, automatically granting them the permissions associated with that role.

Roles use the following permission types to control the actions that users can perform:

  • Room
  • Room Details
  • Documents
  • Envelopes
  • Member Management
  • Company Settings

Roles in Rooms v5

Rooms v5 has three predefined roles:

  • Admin: This role can manage all members and company settings.
  • Manager: This role is designed to manage rooms in one or more offices or regions. Depending on the permissions that you set for the individual member in the ClassicManagerPermissions object, managers can also perform additional tasks, such as managing member accounts and company account information.
  • Agent: This role is for contributors who only have access to rooms that they create or that are created for them. Agents cannot manage company settings or other members.

However, you can reconfigure the permissions for these roles in the Members object.

Roles in Rooms v6

Rooms v6 enables you to fully configure custom roles containing permissions that make sense for your company. Because each new member is assigned a role, you must set up these roles before you can invite members to join your account.

In Rooms v6, permissions for roles are tied to the roleId property and not yet exposed. You can learn more about these permission types and configure them in the console.

Internal and External Roles

In Rooms v6, a role can be either internal or external. You assign internal roles to people inside your company. You assign external roles to people outside your company when you invite them to a room.

Each member inside your company has a default company role. However, they can also be assigned additional roles with different permissions on a per-room basis. Regardless of the member's default company role, what they can do in a room is entirely controlled by their role in that particular room.

Roles

This object contains information about a role.

MethodDescription
GetRoles
GET /v2/accounts/{accountId}/roles

Gets roles.

CreateRole
POST /v2/accounts/{accountId}/roles

Creates a role.

GetRole
GET /v2/accounts/{accountId}/roles/{roleId}

Gets a role.

UpdateRole
PUT /v2/accounts/{accountId}/roles/{roleId}

Updates a role.

DeleteRole
DELETE /v2/accounts/{accountId}/roles/{roleId}

Deletes a role.

}} />