Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.IGroupsApi:

Public Member Functions
GroupInformation	CreateGroups (string accountId, GroupInformation groupInformation=null)
	Creates one or more groups for the account. More...

ApiResponse< GroupInformation >	CreateGroupsWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Creates one or more groups for the account. More...

GroupBrands	DeleteBrands (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. More...

ApiResponse< GroupBrands >	DeleteBrandsWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. More...

UsersResponse	DeleteGroupUsers (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro More...

ApiResponse< UsersResponse >	DeleteGroupUsersWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro More...

GroupInformation	DeleteGroups (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. More...

ApiResponse< GroupInformation >	DeleteGroupsWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. More...

GroupBrands	GetBrands (string accountId, string groupId)
	Gets group brand ID Information. More...

ApiResponse< GroupBrands >	GetBrandsWithHttpInfo (string accountId, string groupId)
	Gets group brand ID Information. More...

UsersResponse	ListGroupUsers (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

ApiResponse< UsersResponse >	ListGroupUsersWithHttpInfo (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

GroupInformation	ListGroups (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

ApiResponse< GroupInformation >	ListGroupsWithHttpInfo (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

GroupBrands	UpdateBrands (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. More...

ApiResponse< GroupBrands >	UpdateBrandsWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. More...

UsersResponse	UpdateGroupUsers (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. More...

ApiResponse< UsersResponse >	UpdateGroupUsersWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. More...

GroupInformation	UpdateGroups (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. More...

ApiResponse< GroupInformation >	UpdateGroupsWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. More...

System.Threading.Tasks.Task< GroupInformation >	CreateGroupsAsync (string accountId, GroupInformation groupInformation=null)
	Creates one or more groups for the account. More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	CreateGroupsAsyncWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Creates one or more groups for the account. More...

System.Threading.Tasks.Task< GroupBrands >	DeleteBrandsAsync (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. More...

System.Threading.Tasks.Task< ApiResponse< GroupBrands > >	DeleteBrandsAsyncWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. More...

System.Threading.Tasks.Task< UsersResponse >	DeleteGroupUsersAsync (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro More...

System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	DeleteGroupUsersAsyncWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro More...

System.Threading.Tasks.Task< GroupInformation >	DeleteGroupsAsync (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	DeleteGroupsAsyncWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. More...

System.Threading.Tasks.Task< GroupBrands >	GetBrandsAsync (string accountId, string groupId)
	Gets group brand ID Information. More...

System.Threading.Tasks.Task< ApiResponse< GroupBrands > >	GetBrandsAsyncWithHttpInfo (string accountId, string groupId)
	Gets group brand ID Information. More...

System.Threading.Tasks.Task< UsersResponse >	ListGroupUsersAsync (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	ListGroupUsersAsyncWithHttpInfo (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

System.Threading.Tasks.Task< GroupInformation >	ListGroupsAsync (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	ListGroupsAsyncWithHttpInfo (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

System.Threading.Tasks.Task< GroupBrands >	UpdateBrandsAsync (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. More...

System.Threading.Tasks.Task< ApiResponse< GroupBrands > >	UpdateBrandsAsyncWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. More...

System.Threading.Tasks.Task< UsersResponse >	UpdateGroupUsersAsync (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. More...

System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	UpdateGroupUsersAsyncWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. More...

System.Threading.Tasks.Task< GroupInformation >	UpdateGroupsAsync (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	UpdateGroupsAsyncWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateGroups()

GroupInformation DocuSign.eSign.Api.IGroupsApi.CreateGroups	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Creates one or more groups for the account.

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ CreateGroupsAsync()

System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.IGroupsApi.CreateGroupsAsync	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Creates one or more groups for the account.

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: Task of GroupInformation

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ CreateGroupsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.IGroupsApi.CreateGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Creates one or more groups for the account.

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: Task of ApiResponse (GroupInformation)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ CreateGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.IGroupsApi.CreateGroupsWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Creates one or more groups for the account.

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.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteBrands()

GroupBrands DocuSign.eSign.Api.IGroupsApi.DeleteBrands	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Deletes brand information from the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteBrandsAsync()

System.Threading.Tasks.Task<GroupBrands> DocuSign.eSign.Api.IGroupsApi.DeleteBrandsAsync	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Deletes brand information from the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of GroupBrands

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteBrandsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupBrands> > DocuSign.eSign.Api.IGroupsApi.DeleteBrandsAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Deletes brand information from the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of ApiResponse (GroupBrands)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteBrandsWithHttpInfo()

ApiResponse<GroupBrands> DocuSign.eSign.Api.IGroupsApi.DeleteBrandsWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Deletes brand information from the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroups()

GroupInformation DocuSign.eSign.Api.IGroupsApi.DeleteGroups	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Deletes an existing user group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupsAsync()

System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.IGroupsApi.DeleteGroupsAsync	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Deletes an existing user group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: Task of GroupInformation

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.IGroupsApi.DeleteGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Deletes an existing user group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: Task of ApiResponse (GroupInformation)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.IGroupsApi.DeleteGroupsWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Deletes an existing user group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupUsers()

UsersResponse DocuSign.eSign.Api.IGroupsApi.DeleteGroupUsers	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Deletes one or more users from a gro

Deletes one or more users from a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupUsersAsync()

System.Threading.Tasks.Task<UsersResponse> DocuSign.eSign.Api.IGroupsApi.DeleteGroupUsersAsync	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Deletes one or more users from a gro

Deletes one or more users from a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of UsersResponse

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupUsersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<UsersResponse> > DocuSign.eSign.Api.IGroupsApi.DeleteGroupUsersAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Deletes one or more users from a gro

Deletes one or more users from a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of ApiResponse (UsersResponse)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ DeleteGroupUsersWithHttpInfo()

ApiResponse<UsersResponse> DocuSign.eSign.Api.IGroupsApi.DeleteGroupUsersWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Deletes one or more users from a gro

Deletes one or more users from a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ GetBrands()

GroupBrands DocuSign.eSign.Api.IGroupsApi.GetBrands	(	string	accountId,
		string	groupId
	)

Gets group brand ID Information.

Retrieves information about the brands associated with the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ GetBrandsAsync()

System.Threading.Tasks.Task<GroupBrands> DocuSign.eSign.Api.IGroupsApi.GetBrandsAsync	(	string	accountId,
		string	groupId
	)

Gets group brand ID Information.

Retrieves information about the brands associated with the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: Task of GroupBrands

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ GetBrandsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupBrands> > DocuSign.eSign.Api.IGroupsApi.GetBrandsAsyncWithHttpInfo	(	string	accountId,
		string	groupId
	)

Gets group brand ID Information.

Retrieves information about the brands associated with the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: Task of ApiResponse (GroupBrands)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ GetBrandsWithHttpInfo()

ApiResponse<GroupBrands> DocuSign.eSign.Api.IGroupsApi.GetBrandsWithHttpInfo	(	string	accountId,
		string	groupId
	)

Gets group brand ID Information.

Retrieves information about the brands associated with the requested group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ ListGroups()

GroupInformation DocuSign.eSign.Api.IGroupsApi.ListGroups	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

Gets information about groups associated with the account.

Retrieves information about groups associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns

◆ ListGroupsAsync()

System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.IGroupsApi.ListGroupsAsync	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

Gets information about groups associated with the account.

Retrieves information about groups associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of GroupInformation

◆ ListGroupsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.IGroupsApi.ListGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

Gets information about groups associated with the account.

Retrieves information about groups associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (GroupInformation)

◆ ListGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.IGroupsApi.ListGroupsWithHttpInfo	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

Gets information about groups associated with the account.

Retrieves information about groups associated with the account.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ ListGroupUsers()

UsersResponse DocuSign.eSign.Api.IGroupsApi.ListGroupUsers	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

Gets a list of users in a group.

Retrieves a list of users in a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
options	Options for modifying the behavior of the function.

Returns

◆ ListGroupUsersAsync()

System.Threading.Tasks.Task<UsersResponse> DocuSign.eSign.Api.IGroupsApi.ListGroupUsersAsync	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

Gets a list of users in a group.

Retrieves a list of users in a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of UsersResponse

◆ ListGroupUsersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<UsersResponse> > DocuSign.eSign.Api.IGroupsApi.ListGroupUsersAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

Gets a list of users in a group.

Retrieves a list of users in a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (UsersResponse)

◆ ListGroupUsersWithHttpInfo()

ApiResponse<UsersResponse> DocuSign.eSign.Api.IGroupsApi.ListGroupUsersWithHttpInfo	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

Gets a list of users in a group.

Retrieves a list of users in a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ UpdateBrands()

GroupBrands DocuSign.eSign.Api.IGroupsApi.UpdateBrands	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Adds group brand ID information to a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateBrandsAsync()

System.Threading.Tasks.Task<GroupBrands> DocuSign.eSign.Api.IGroupsApi.UpdateBrandsAsync	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Adds group brand ID information to a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of GroupBrands

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateBrandsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupBrands> > DocuSign.eSign.Api.IGroupsApi.UpdateBrandsAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Adds group brand ID information to a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of ApiResponse (GroupBrands)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateBrandsWithHttpInfo()

ApiResponse<GroupBrands> DocuSign.eSign.Api.IGroupsApi.UpdateBrandsWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

Adds group brand ID information to a group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroups()

GroupInformation DocuSign.eSign.Api.IGroupsApi.UpdateGroups	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Updates the group information for a group.

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupsAsync()

System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.IGroupsApi.UpdateGroupsAsync	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Updates the group information for a group.

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: Task of GroupInformation

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.IGroupsApi.UpdateGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Updates the group information for a group.

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: Task of ApiResponse (GroupInformation)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.IGroupsApi.UpdateGroupsWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

Updates the group information for a group.

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupInformation	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupUsers()

UsersResponse DocuSign.eSign.Api.IGroupsApi.UpdateGroupUsers	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Adds one or more users to an existing group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupUsersAsync()

System.Threading.Tasks.Task<UsersResponse> DocuSign.eSign.Api.IGroupsApi.UpdateGroupUsersAsync	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Adds one or more users to an existing group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of UsersResponse

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupUsersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<UsersResponse> > DocuSign.eSign.Api.IGroupsApi.UpdateGroupUsersAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Adds one or more users to an existing group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of ApiResponse (UsersResponse)

Implemented in DocuSign.eSign.Api.GroupsApi.

◆ UpdateGroupUsersWithHttpInfo()

ApiResponse<UsersResponse> DocuSign.eSign.Api.IGroupsApi.UpdateGroupUsersWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

Adds one or more users to an existing group.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.GroupsApi.

The documentation for this interface was generated from the following file:

sdk/src/DocuSign.eSign/Api/GroupsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateGroups()

◆ CreateGroupsAsync()

◆ CreateGroupsAsyncWithHttpInfo()

◆ CreateGroupsWithHttpInfo()

◆ DeleteBrands()

◆ DeleteBrandsAsync()

◆ DeleteBrandsAsyncWithHttpInfo()

◆ DeleteBrandsWithHttpInfo()

◆ DeleteGroups()

◆ DeleteGroupsAsync()

◆ DeleteGroupsAsyncWithHttpInfo()

◆ DeleteGroupsWithHttpInfo()

◆ DeleteGroupUsers()

◆ DeleteGroupUsersAsync()

◆ DeleteGroupUsersAsyncWithHttpInfo()

◆ DeleteGroupUsersWithHttpInfo()

◆ GetBrands()

◆ GetBrandsAsync()

◆ GetBrandsAsyncWithHttpInfo()

◆ GetBrandsWithHttpInfo()

◆ ListGroups()

◆ ListGroupsAsync()

◆ ListGroupsAsyncWithHttpInfo()

◆ ListGroupsWithHttpInfo()

◆ ListGroupUsers()

◆ ListGroupUsersAsync()

◆ ListGroupUsersAsyncWithHttpInfo()

◆ ListGroupUsersWithHttpInfo()

◆ UpdateBrands()

◆ UpdateBrandsAsync()

◆ UpdateBrandsAsyncWithHttpInfo()

◆ UpdateBrandsWithHttpInfo()

◆ UpdateGroups()

◆ UpdateGroupsAsync()

◆ UpdateGroupsAsyncWithHttpInfo()

◆ UpdateGroupsWithHttpInfo()

◆ UpdateGroupUsers()

◆ UpdateGroupUsersAsync()

◆ UpdateGroupUsersAsyncWithHttpInfo()

◆ UpdateGroupUsersWithHttpInfo()