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

Inheritance diagram for DocuSign.eSign.Api.IAuthenticationApi:

Public Member Functions
void	DeleteSocialLogin (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Deletes user's social account. More...

ApiResponse< Object >	DeleteSocialLoginWithHttpInfo (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Deletes user's social account. More...

OauthAccess	GetOAuthToken ()
	Creates an authorization token. More...

ApiResponse< OauthAccess >	GetOAuthTokenWithHttpInfo ()
	Creates an authorization token. More...

UserSocialIdResult	ListSocialLogins (string accountId, string userId)
	Gets a list of a user's social accounts. More...

ApiResponse< UserSocialIdResult >	ListSocialLoginsWithHttpInfo (string accountId, string userId)
	Gets a list of a user's social accounts. More...

LoginInformation	Login (AuthenticationApi.LoginOptions options=null)
	Gets login information for a specified user. More...

ApiResponse< LoginInformation >	LoginWithHttpInfo (AuthenticationApi.LoginOptions options=null)
	Gets login information for a specified user. More...

void	RevokeOAuthToken ()
	Revokes an authorization token. More...

ApiResponse< Object >	RevokeOAuthTokenWithHttpInfo ()
	Revokes an authorization token. More...

void	UpdatePassword (string loginPart, UserPasswordInformation userPasswordInformation=null)
	Updates the password for a specified user. More...

ApiResponse< Object >	UpdatePasswordWithHttpInfo (string loginPart, UserPasswordInformation userPasswordInformation=null)
	Updates the password for a specified user. More...

void	UpdateSocialLogin (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Adds social account for a user. More...

ApiResponse< Object >	UpdateSocialLoginWithHttpInfo (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Adds social account for a user. More...

System.Threading.Tasks.Task	DeleteSocialLoginAsync (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Deletes user's social account. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteSocialLoginAsyncWithHttpInfo (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Deletes user's social account. More...

System.Threading.Tasks.Task< OauthAccess >	GetOAuthTokenAsync ()
	Creates an authorization token. More...

System.Threading.Tasks.Task< ApiResponse< OauthAccess > >	GetOAuthTokenAsyncWithHttpInfo ()
	Creates an authorization token. More...

System.Threading.Tasks.Task< UserSocialIdResult >	ListSocialLoginsAsync (string accountId, string userId)
	Gets a list of a user's social accounts. More...

System.Threading.Tasks.Task< ApiResponse< UserSocialIdResult > >	ListSocialLoginsAsyncWithHttpInfo (string accountId, string userId)
	Gets a list of a user's social accounts. More...

System.Threading.Tasks.Task< LoginInformation >	LoginAsync (AuthenticationApi.LoginOptions options=null)
	Gets login information for a specified user. More...

System.Threading.Tasks.Task< ApiResponse< LoginInformation > >	LoginAsyncWithHttpInfo (AuthenticationApi.LoginOptions options=null)
	Gets login information for a specified user. More...

System.Threading.Tasks.Task	RevokeOAuthTokenAsync ()
	Revokes an authorization token. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	RevokeOAuthTokenAsyncWithHttpInfo ()
	Revokes an authorization token. More...

System.Threading.Tasks.Task	UpdatePasswordAsync (string loginPart, UserPasswordInformation userPasswordInformation=null)
	Updates the password for a specified user. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	UpdatePasswordAsyncWithHttpInfo (string loginPart, UserPasswordInformation userPasswordInformation=null)
	Updates the password for a specified user. More...

System.Threading.Tasks.Task	UpdateSocialLoginAsync (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Adds social account for a user. More...

System.Threading.Tasks.Task< ApiResponse< Object > >	UpdateSocialLoginAsyncWithHttpInfo (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Adds social account for a user. 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

◆ DeleteSocialLogin()

void DocuSign.eSign.Api.IAuthenticationApi.DeleteSocialLogin	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Deletes user's social account.

Deletes a social account from a use's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ DeleteSocialLoginAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IAuthenticationApi.DeleteSocialLoginAsync	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Deletes user's social account.

Deletes a social account from a use's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns: Task of void

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ DeleteSocialLoginAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAuthenticationApi.DeleteSocialLoginAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Deletes user's social account.

Deletes a social account from a use's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ DeleteSocialLoginWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IAuthenticationApi.DeleteSocialLoginWithHttpInfo	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Deletes user's social account.

Deletes a social account from a use's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ GetOAuthToken()

OauthAccess DocuSign.eSign.Api.IAuthenticationApi.GetOAuthToken ( )

Creates an authorization token.

Creates an OAuth2 authorization server token endpoint.

Exceptions

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

Returns

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ GetOAuthTokenAsync()

System.Threading.Tasks.Task<OauthAccess> DocuSign.eSign.Api.IAuthenticationApi.GetOAuthTokenAsync ( )

Creates an authorization token.

Creates an OAuth2 authorization server token endpoint.

Exceptions

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

Returns: Task of OauthAccess

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ GetOAuthTokenAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<OauthAccess> > DocuSign.eSign.Api.IAuthenticationApi.GetOAuthTokenAsyncWithHttpInfo ( )

Creates an authorization token.

Creates an OAuth2 authorization server token endpoint.

Exceptions

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

Returns: Task of ApiResponse (OauthAccess)

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ GetOAuthTokenWithHttpInfo()

ApiResponse<OauthAccess> DocuSign.eSign.Api.IAuthenticationApi.GetOAuthTokenWithHttpInfo ( )

Creates an authorization token.

Creates an OAuth2 authorization server token endpoint.

Exceptions

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

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ ListSocialLogins()

UserSocialIdResult DocuSign.eSign.Api.IAuthenticationApi.ListSocialLogins	(	string	accountId,
		string	userId
	)

Gets a list of a user's social accounts.

Retrieves a list of social accounts linked to a user's account.

Exceptions

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

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.

Returns

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ ListSocialLoginsAsync()

System.Threading.Tasks.Task<UserSocialIdResult> DocuSign.eSign.Api.IAuthenticationApi.ListSocialLoginsAsync	(	string	accountId,
		string	userId
	)

Gets a list of a user's social accounts.

Retrieves a list of social accounts linked to a user's account.

Exceptions

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

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.

Returns: Task of UserSocialIdResult

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ ListSocialLoginsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<UserSocialIdResult> > DocuSign.eSign.Api.IAuthenticationApi.ListSocialLoginsAsyncWithHttpInfo	(	string	accountId,
		string	userId
	)

Gets a list of a user's social accounts.

Retrieves a list of social accounts linked to a user's account.

Exceptions

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

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.

Returns: Task of ApiResponse (UserSocialIdResult)

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ ListSocialLoginsWithHttpInfo()

ApiResponse<UserSocialIdResult> DocuSign.eSign.Api.IAuthenticationApi.ListSocialLoginsWithHttpInfo	(	string	accountId,
		string	userId
	)

Gets a list of a user's social accounts.

Retrieves a list of social accounts linked to a user's account.

Exceptions

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

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.

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ Login()

LoginInformation DocuSign.eSign.Api.IAuthenticationApi.Login ( AuthenticationApi.LoginOptions options = null )

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. The `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.

Exceptions

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

Parameters

options Options for modifying the behavior of the function.

Returns

◆ LoginAsync()

System.Threading.Tasks.Task<LoginInformation> DocuSign.eSign.Api.IAuthenticationApi.LoginAsync ( AuthenticationApi.LoginOptions options = null )

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. The `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.

Exceptions

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

Parameters

options Options for modifying the behavior of the function.

Returns: Task of LoginInformation

◆ LoginAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<LoginInformation> > DocuSign.eSign.Api.IAuthenticationApi.LoginAsyncWithHttpInfo ( AuthenticationApi.LoginOptions options = null )

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. The `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.

Exceptions

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

Parameters

options Options for modifying the behavior of the function.

Returns: Task of ApiResponse (LoginInformation)

◆ LoginWithHttpInfo()

ApiResponse<LoginInformation> DocuSign.eSign.Api.IAuthenticationApi.LoginWithHttpInfo ( AuthenticationApi.LoginOptions options = null )

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. The `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.

Exceptions

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

Parameters

options Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ RevokeOAuthToken()

void DocuSign.eSign.Api.IAuthenticationApi.RevokeOAuthToken ( )

Revokes an authorization token.

Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access.

Exceptions

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

Returns

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ RevokeOAuthTokenAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IAuthenticationApi.RevokeOAuthTokenAsync ( )

Revokes an authorization token.

Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access.

Exceptions

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

Returns: Task of void

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ RevokeOAuthTokenAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAuthenticationApi.RevokeOAuthTokenAsyncWithHttpInfo ( )

Revokes an authorization token.

Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access.

Exceptions

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

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ RevokeOAuthTokenWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IAuthenticationApi.RevokeOAuthTokenWithHttpInfo ( )

Revokes an authorization token.

Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access.

Exceptions

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

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdatePassword()

void DocuSign.eSign.Api.IAuthenticationApi.UpdatePassword	(	string	loginPart,
		UserPasswordInformation	userPasswordInformation = `null`
	)

Updates the password for a specified user.

Exceptions

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

Parameters

loginPart	Currently, only the value password is supported.
userPasswordInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdatePasswordAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IAuthenticationApi.UpdatePasswordAsync	(	string	loginPart,
		UserPasswordInformation	userPasswordInformation = `null`
	)

Updates the password for a specified user.

Exceptions

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

Parameters

loginPart	Currently, only the value password is supported.
userPasswordInformation	(optional)

Returns: Task of void

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdatePasswordAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAuthenticationApi.UpdatePasswordAsyncWithHttpInfo	(	string	loginPart,
		UserPasswordInformation	userPasswordInformation = `null`
	)

Updates the password for a specified user.

Exceptions

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

Parameters

loginPart	Currently, only the value password is supported.
userPasswordInformation	(optional)

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdatePasswordWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IAuthenticationApi.UpdatePasswordWithHttpInfo	(	string	loginPart,
		UserPasswordInformation	userPasswordInformation = `null`
	)

Updates the password for a specified user.

Exceptions

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

Parameters

loginPart	Currently, only the value password is supported.
userPasswordInformation	(optional)

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdateSocialLogin()

void DocuSign.eSign.Api.IAuthenticationApi.UpdateSocialLogin	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Adds social account for a user.

Adds a new social account to a user's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdateSocialLoginAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IAuthenticationApi.UpdateSocialLoginAsync	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Adds social account for a user.

Adds a new social account to a user's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns: Task of void

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdateSocialLoginAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IAuthenticationApi.UpdateSocialLoginAsyncWithHttpInfo	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Adds social account for a user.

Adds a new social account to a user's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns: Task of ApiResponse

Implemented in DocuSign.eSign.Api.AuthenticationApi.

◆ UpdateSocialLoginWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IAuthenticationApi.UpdateSocialLoginWithHttpInfo	(	string	accountId,
		string	userId,
		SocialAccountInformation	socialAccountInformation = `null`
	)

Adds social account for a user.

Adds a new social account to a user's account.

Exceptions

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

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.
socialAccountInformation	(optional)

Returns: ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.AuthenticationApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteSocialLogin()

◆ DeleteSocialLoginAsync()

◆ DeleteSocialLoginAsyncWithHttpInfo()

◆ DeleteSocialLoginWithHttpInfo()

◆ GetOAuthToken()

◆ GetOAuthTokenAsync()

◆ GetOAuthTokenAsyncWithHttpInfo()

◆ GetOAuthTokenWithHttpInfo()

◆ ListSocialLogins()

◆ ListSocialLoginsAsync()

◆ ListSocialLoginsAsyncWithHttpInfo()

◆ ListSocialLoginsWithHttpInfo()

◆ Login()

◆ LoginAsync()

◆ LoginAsyncWithHttpInfo()

◆ LoginWithHttpInfo()

◆ RevokeOAuthToken()

◆ RevokeOAuthTokenAsync()

◆ RevokeOAuthTokenAsyncWithHttpInfo()

◆ RevokeOAuthTokenWithHttpInfo()

◆ UpdatePassword()

◆ UpdatePasswordAsync()

◆ UpdatePasswordAsyncWithHttpInfo()

◆ UpdatePasswordWithHttpInfo()

◆ UpdateSocialLogin()

◆ UpdateSocialLoginAsync()

◆ UpdateSocialLoginAsyncWithHttpInfo()

◆ UpdateSocialLoginWithHttpInfo()