com.docusign.esign.api

Class UsersApi

java.lang.Object

com.docusign.esign.api.UsersApi

public class UsersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
UserSettingsInformation	getSettings(String accountId, String userId) Gets the user account settings for a specified user.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSettings

public UserSettingsInformation getSettings(String accountId,
                                           String userId)
                                    throws ApiException

Gets the user account settings for a specified user. Retrieves a list of the account settings and email notification information for the specified user.\n\nThe response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see the [ML:userSettings list].

Parameters:

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

userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. UsersApi.GetSettingsOptions Options for modifying the method behavior.

Returns:

UserSettingsInformation

Throws:

ApiException - if fails to make API call