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

Inheritance diagram for DocuSign.eSign.Api.AuthenticationApi:

Classes
class	LoginOptions
	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. More...

Public Member Functions
	AuthenticationApi (DocuSignClient aplClient)
	Initializes a new instance of the AuthenticationApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

void	DeleteSocialLogin (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Deletes user's social account. Deletes a social account from a use's account. More...

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

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

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

OauthAccess	GetOAuthToken ()
	Creates an authorization token. Creates an OAuth2 authorization server token endpoint. More...

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

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

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

UserSocialIdResult	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. More...

ApiResponse< UserSocialIdResult >	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. More...

async System.Threading.Tasks.Task< UserSocialIdResult >	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. More...

async System.Threading.Tasks.Task< ApiResponse< UserSocialIdResult > >	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. More...

LoginInformation	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. More...

ApiResponse< LoginInformation >	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. More...

async System.Threading.Tasks.Task< LoginInformation >	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. More...

async System.Threading.Tasks.Task< ApiResponse< LoginInformation > >	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. More...

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

ApiResponse< Object >	RevokeOAuthTokenWithHttpInfo ()
	Revokes an authorization token. Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access. More...

async System.Threading.Tasks.Task	RevokeOAuthTokenAsync ()
	Revokes an authorization token. Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	RevokeOAuthTokenAsyncWithHttpInfo ()
	Revokes an authorization token. Revokes an OAuth2 authorization server token. After the revocation is complete, a caller must re-authenticate to restore access. More...

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

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

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

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

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

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

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

async System.Threading.Tasks.Task< ApiResponse< Object > >	UpdateSocialLoginAsyncWithHttpInfo (string accountId, string userId, SocialAccountInformation socialAccountInformation=null)
	Adds social account for a user. Adds a new social account to a user's account. More...

Public Member Functions inherited from DocuSign.eSign.Api.IAuthenticationApi
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...

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

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

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

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

Constructor & Destructor Documentation

◆ AuthenticationApi()

DocuSign.eSign.Api.AuthenticationApi.AuthenticationApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the AuthenticationApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ DeleteSocialLogin()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ DeleteSocialLoginAsync()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ DeleteSocialLoginAsyncWithHttpInfo()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ DeleteSocialLoginWithHttpInfo()

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

inline

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)

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ GetBasePath()

String DocuSign.eSign.Api.AuthenticationApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetOAuthToken()

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

inline

Creates an authorization token. Creates an OAuth2 authorization server token endpoint.

Exceptions

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

Returns: OauthAccess

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ GetOAuthTokenAsync()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ GetOAuthTokenAsyncWithHttpInfo()

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

inline

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)

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ GetOAuthTokenWithHttpInfo()

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

inline

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 OauthAccess

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ ListSocialLogins()

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

inline

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: UserSocialIdResult

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ ListSocialLoginsAsync()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ ListSocialLoginsAsyncWithHttpInfo()

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

inline

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)

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ ListSocialLoginsWithHttpInfo()

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

inline

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 UserSocialIdResult

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ Login()

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

inline

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: LoginInformation

◆ LoginAsync()

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

inline

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()

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

inline

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.AuthenticationApi.LoginWithHttpInfo ( AuthenticationApi.LoginOptions options = null )

inline

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 LoginInformation

◆ RevokeOAuthToken()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ RevokeOAuthTokenAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.AuthenticationApi.RevokeOAuthTokenAsync ( )

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ RevokeOAuthTokenAsyncWithHttpInfo()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ RevokeOAuthTokenWithHttpInfo()

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

inline

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)

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdatePassword()

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

inline

Updates the password for a specified user. 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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdatePasswordAsync()

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

inline

Updates the password for a specified user. 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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdatePasswordAsyncWithHttpInfo()

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

inline

Updates the password for a specified user. 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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdatePasswordWithHttpInfo()

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

inline

Updates the password for a specified user. 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)

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdateSocialLogin()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdateSocialLoginAsync()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdateSocialLoginAsyncWithHttpInfo()

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

inline

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

Implements DocuSign.eSign.Api.IAuthenticationApi.

◆ UpdateSocialLoginWithHttpInfo()

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

inline

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)

Implements DocuSign.eSign.Api.IAuthenticationApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.AuthenticationApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.AuthenticationApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

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

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AuthenticationApi()

Member Function Documentation

◆ DeleteSocialLogin()

◆ DeleteSocialLoginAsync()

◆ DeleteSocialLoginAsyncWithHttpInfo()

◆ DeleteSocialLoginWithHttpInfo()

◆ GetBasePath()

◆ GetOAuthToken()

◆ GetOAuthTokenAsync()

◆ GetOAuthTokenAsyncWithHttpInfo()

◆ GetOAuthTokenWithHttpInfo()

◆ ListSocialLogins()

◆ ListSocialLoginsAsync()

◆ ListSocialLoginsAsyncWithHttpInfo()

◆ ListSocialLoginsWithHttpInfo()

◆ Login()

◆ LoginAsync()

◆ LoginAsyncWithHttpInfo()

◆ LoginWithHttpInfo()

◆ RevokeOAuthToken()

◆ RevokeOAuthTokenAsync()

◆ RevokeOAuthTokenAsyncWithHttpInfo()

◆ RevokeOAuthTokenWithHttpInfo()

◆ UpdatePassword()

◆ UpdatePasswordAsync()

◆ UpdatePasswordAsyncWithHttpInfo()

◆ UpdatePasswordWithHttpInfo()

◆ UpdateSocialLogin()

◆ UpdateSocialLoginAsync()

◆ UpdateSocialLoginAsyncWithHttpInfo()

◆ UpdateSocialLoginWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory