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

Groups Resource

The Groups resource provides methods that allow you to manage groups for the account.

Groups can be used to help manage users by associating users with a group. A group can be associated with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set Permission Profiles for a group, but this makes it easier to manage user permissions for a large number of users. Groups can also be used with template sharing to limit user access to templates.

MethodDescription
list
GET /v2/accounts/{accountId}/groups

Retrieves information about groups associated with the account.

update
PUT /v2/accounts/{accountId}/groups

Updates the group name and modifies, or sets, the permission profile for the group.

create
POST /v2/accounts/{accountId}/groups

Creates one or more groups for the account.

Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

delete
DELETE /v2/accounts/{accountId}/groups

Deletes an existing user group.