DocuSign.Api.Groups (DocuSign v2.0.0)
View SourceAPI calls for all endpoints tagged Groups.
Summary
Functions
Deletes an existing user group.
Deletes an existing user group. When you delete a group, you include only the groupId in the request body. Example: { "groups": [ { "groupId": "12345" } }
Gets information about groups associated with the account. Gets information about groups associated with the account. <ds-inlinemessage kind="information" markdown="1"> To get the users in a group: 1. Use this endpoint to get the group ID. 2. Use listGroupUsers to get the list of users. </ds-inlinemessage> ### Related topics - How to set a permission profile
Creates one or more groups for the account.
Creates one or more groups for the account. Groups help you manage users. For example, you can use groups to limit user access to templates. 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. <ds-inlinemessage kind="warning" markdown="1"> This endpoint uses only the <code>groupName</code> and <code>permissionProfileId</code> properties in the request body. All other properties are ignored. </ds-inlinemessage> Example request: json { "groups": [ { "groupName": "montagues" }, { "groupName": "capulets" }, { "groupName": "nobles", "permissionProfileId": 1597 } ] } Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. It is an error if the permissionProfileId does not exist. ### Related topics - How-To Set Up a Permission Profile
Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group. ### Related topics - How-To Set Up a Permission Profile
Functions
@spec groups_delete_groups(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.GroupInformation.t()} | {:error, Tesla.Env.t()}
Deletes an existing user group.
Deletes an existing user group. When you delete a group, you include only the groupId in the request body. Example: { "groups": [ { "groupId": "12345" } }
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:body(GroupInformation):
Returns
{:ok, DocuSign.Model.GroupInformation.t}on success{:error, Tesla.Env.t}on failure
@spec groups_get_groups(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.GroupInformation.t()} | {:error, Tesla.Env.t()}
Gets information about groups associated with the account. Gets information about groups associated with the account. <ds-inlinemessage kind="information" markdown="1"> To get the users in a group: 1. Use this endpoint to get the group ID. 2. Use listGroupUsers to get the list of users. </ds-inlinemessage> ### Related topics - How to set a permission profile
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:count(String.t): The maximum number of results to return. Usestart_positionto specify the number of results to skip. Valid values:1to100:group_type(String.t): The type of group to return. Valid values:AdminGroupCustomGroup*EveryoneGroup:include_usercount(String.t): When true, every group returned in the response includes auserCountproperty that contains the total number of users in the group. The default is true.:search_text(String.t): Filters the results of a GET request based on the text that you specify.:start_position(String.t): The zero-based index of the result from which to start returning results. Use withcountto limit the number of results. The default value is0.
Returns
{:ok, DocuSign.Model.GroupInformation.t}on success{:error, Tesla.Env.t}on failure
@spec groups_post_groups(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.GroupInformation.t()} | {:error, Tesla.Env.t()}
Creates one or more groups for the account.
Creates one or more groups for the account. Groups help you manage users. For example, you can use groups to limit user access to templates. 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. <ds-inlinemessage kind="warning" markdown="1"> This endpoint uses only the <code>groupName</code> and <code>permissionProfileId</code> properties in the request body. All other properties are ignored. </ds-inlinemessage> Example request: json { "groups": [ { "groupName": "montagues" }, { "groupName": "capulets" }, { "groupName": "nobles", "permissionProfileId": 1597 } ] } Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs. It is an error if the permissionProfileId does not exist. ### Related topics - How-To Set Up a Permission Profile
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:body(GroupInformation):
Returns
{:ok, DocuSign.Model.GroupInformation.t}on success{:error, Tesla.Env.t}on failure
@spec groups_put_groups(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.GroupInformation.t()} | {:error, Tesla.Env.t()}
Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group. ### Related topics - How-To Set Up a Permission Profile
Parameters
connection(DocuSign.Connection): Connection to serveraccount_id(String.t): The external account number (int) or account ID GUID.opts(keyword): Optional parameters:body(GroupInformation):
Returns
{:ok, DocuSign.Model.GroupInformation.t}on success{:error, Tesla.Env.t}on failure