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
class	AuthenticationApi.RevokeOAuthTokenOptions

Constructor Summary

Constructors

Constructor and Description
AuthenticationApi()
AuthenticationApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteSocialLogin(String accountId, String userId, SocialAccountInformation socialAccountInformation) Deletes user's social account.
ApiClient	getApiClient()
OauthAccess	getOAuthToken() Creates an authorization token.
UserSocialIdResult	listSocialLogins(String accountId, String userId) Gets a list of a user's social accounts.
LoginInformation	login() Gets login information for a specified user.
LoginInformation	login(AuthenticationApi.LoginOptions options) Gets login information for a specified user.
void	revokeOAuthToken() Revokes an authorization token.
void	revokeOAuthToken(AuthenticationApi.RevokeOAuthTokenOptions options) Revokes an authorization token.
void	setApiClient(ApiClient apiClient)
void	updatePassword(String loginPart, UserPasswordInformation userPasswordInformation) Updates the password for a specified user.
void	updateSocialLogin(String accountId, String userId, SocialAccountInformation socialAccountInformation) Adds social account for a user.

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)

deleteSocialLogin

public void deleteSocialLogin(String accountId,
                     String userId,
                     SocialAccountInformation socialAccountInformation)
                       throws ApiException

Deletes user's social account. Deletes a social account from a use's account.

Parameters:

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

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

socialAccountInformation - (optional)

Throws:

ApiException - if fails to make API call

getOAuthToken

public OauthAccess getOAuthToken()
                          throws ApiException

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

Returns:

OauthAccess

Throws:

ApiException - if fails to make API call

listSocialLogins

public UserSocialIdResult listSocialLogins(String accountId,
                                  String userId)
                                    throws ApiException

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

Parameters:

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

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

Returns:

UserSocialIdResult

Throws:

ApiException - if fails to make API call

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

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

Parameters:

options - for modifying the method behavior.

Returns:

LoginInformation

Throws:

ApiException - if fails to make API call

revokeOAuthToken

public void revokeOAuthToken()
                      throws ApiException

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

Throws:

ApiException - if fails to make API call

revokeOAuthToken

public void revokeOAuthToken(AuthenticationApi.RevokeOAuthTokenOptions options)
                      throws ApiException

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

Parameters:

options - for modifying the method behavior.

Throws:

ApiException - if fails to make API call

updatePassword

public void updatePassword(String loginPart,
                  UserPasswordInformation userPasswordInformation)
                    throws ApiException

Updates the password for a specified user. Updates the password for a specified user.

Parameters:

loginPart - Currently, only the value **password** is supported. (required)

userPasswordInformation - (optional)

Throws:

ApiException - if fails to make API call

updateSocialLogin

public void updateSocialLogin(String accountId,
                     String userId,
                     SocialAccountInformation socialAccountInformation)
                       throws ApiException

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

Parameters:

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

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

socialAccountInformation - (optional)

Throws:

ApiException - if fails to make API call