module:api/AuthenticationApi

module:api/AuthenticationApi

new module:api/AuthenticationApi(apiClient)

Source:

Constructs a new AuthenticationApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

deleteSocialLogin(accountId, userId, optsOrCallback, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
socialAccountInformation module:model/SocialAccountInformation
callback module:api/AuthenticationApi~deleteSocialLoginCallback

The callback function, accepting three arguments: error, data, response

getOAuthToken(callback)

Source:

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

Parameters:
Name Type Description
callback module:api/AuthenticationApi~getOAuthTokenCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/OauthAccess

listSocialLogins(accountId, userId, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

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.
callback module:api/AuthenticationApi~listSocialLoginsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserSocialIdResult

login(optsOrCallback, callback)

Source:

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:
Name Type Description
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
apiPassword String

When set to true, shows the account API password in the response.
embedAccountIdGuid String
includeAccountIdGuid String

When set to true, shows the account ID GUID in the response.
loginSettings String

Determines whether login settings are returned in the response. Valid Values: * all - All the login settings are returned. * none - no login settings are returned.
callback module:api/AuthenticationApi~loginCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/LoginInformation

revokeOAuthToken(callback)

Source:

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

Parameters:
Name Type Description
callback module:api/AuthenticationApi~revokeOAuthTokenCallback

The callback function, accepting three arguments: error, data, response

updatePassword(loginPart, optsOrCallback, callback)

Source:

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

Parameters:
Name Type Description
loginPart String

Currently, only the value password is supported.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
userPasswordInformation module:model/UserPasswordInformation
callback module:api/AuthenticationApi~updatePasswordCallback

The callback function, accepting three arguments: error, data, response

updateSocialLogin(accountId, userId, optsOrCallback, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
socialAccountInformation module:model/SocialAccountInformation
callback module:api/AuthenticationApi~updateSocialLoginCallback

The callback function, accepting three arguments: error, data, response

Type Definitions

deleteSocialLoginCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteSocialLogin operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getOAuthTokenCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getOAuthToken operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/OauthAccess

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listSocialLoginsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listSocialLogins operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserSocialIdResult

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

loginCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the login operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/LoginInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

revokeOAuthTokenCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the revokeOAuthToken operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updatePasswordCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updatePassword operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSocialLoginCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateSocialLogin operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.