DocuSign.Api.GroupUsers (DocuSign v3.1.1)

View Source

API calls for all endpoints tagged GroupUsers.

Summary

Functions

groups_delete_group_users(connection, account_id, group_id, opts \\ [])

Deletes one or more users from a group Deletes one or more users from a group. This request takes a userInfoList that contains the users that you want to delete.

groups_get_group_users(connection, account_id, group_id, opts \\ [])

Gets a list of users in a group. Retrieves a list of users in a group.

groups_put_group_users(connection, account_id, group_id, opts \\ [])

Adds one or more users to an existing group. Adds one or more existing Docusign users to an existing group.

Functions

groups_delete_group_users(connection, account_id, group_id, opts \\ [])

@spec groups_delete_group_users(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.UsersResponse.t()} | {:error, Req.Response.t()}

Deletes one or more users from a group Deletes one or more users from a group. This request takes a userInfoList that contains the users that you want to delete.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • group_id (String.t): The ID of the group being accessed.
  • opts (keyword): Optional parameters
    • :body (UserInfoList):

Returns

  • {:ok, DocuSign.Model.UsersResponse.t} on success
  • {:error, Req.Response.t} on failure

groups_get_group_users(connection, account_id, group_id, opts \\ [])

@spec groups_get_group_users(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.UsersResponse.t()} | {:error, Req.Response.t()}

Gets a list of users in a group. Retrieves a list of users in a group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • group_id (String.t): The ID of the group being accessed.
  • opts (keyword): Optional parameters
    • :count (String.t): The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100<br> Default: 50
    • :start_position (String.t): The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.

Returns

  • {:ok, DocuSign.Model.UsersResponse.t} on success
  • {:error, Req.Response.t} on failure

groups_put_group_users(connection, account_id, group_id, opts \\ [])

@spec groups_put_group_users(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.UsersResponse.t()} | {:error, Req.Response.t()}

Adds one or more users to an existing group. Adds one or more existing Docusign users to an existing group.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • group_id (String.t): The ID of the group being accessed.
  • opts (keyword): Optional parameters
    • :body (UserInfoList):

Returns

  • {:ok, DocuSign.Model.UsersResponse.t} on success
  • {:error, Req.Response.t} on failure