com.docusign.esign.api

Class AuthenticationApi

java.lang.Object

com.docusign.esign.api.AuthenticationApi

public class AuthenticationApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AuthenticationApi.LoginOptions

Constructor Summary

Constructors

Constructor and Description
AuthenticationApi()
AuthenticationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
LoginInformation	login() Gets login information for a specified user.
LoginInformation	login(AuthenticationApi.LoginOptions options) Gets login information 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

AuthenticationApi

public AuthenticationApi()

AuthenticationApi

public AuthenticationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

login

public LoginInformation login()
                       throws ApiException

Gets login information for a specified user. Retrieves login information for a specified user. Each account that is associated with the login credentials is listed. You can use the returned information to determine whether a user is authenticated and select an account to use in future operations. \n\nThe `baseUrl` property, returned in the response, is used in all future API calls as the base of the request URL. The `baseUrl` property contains the DocuSign server, the API version, and the `accountId` property that is used for the login. This request uses your DocuSign credentials to retrieve the account information.

Returns:

LoginInformation

Throws:

ApiException

login

public LoginInformation login(AuthenticationApi.LoginOptions options)
                       throws ApiException

Gets login information for a specified user. Retrieves login information for a specified user. Each account that is associated with the login credentials is listed. You can use the returned information to determine whether a user is authenticated and select an account to use in future operations. \n\nThe `baseUrl` property, returned in the response, is used in all future API calls as the base of the request URL. The `baseUrl` property contains the DocuSign server, the API version, and the `accountId` property that is used for the login. This request uses your DocuSign credentials to retrieve the account information. AuthenticationApi.LoginOptions Options for modifying the method behavior.

Returns:

LoginInformation

Throws:

ApiException - if fails to make API call