Follow

AuthAnvil Two Factor Auth administrative APIs

Developer Center - Scorpion Software

­

Admin

The Administration web service can be found at https://yourFullyQualifiedDomain.com/AuthAnvil/Admin/admin.asmx

The web service contains access to settings that can apply to a specific site contained within the 2FA install and allows management of 2FA users and settings. Allows only a Master Admin( LogonAsMaster) OR a Site Admin(Logon) to log on and obtain a session key. This session key is a required parameter for all other methods available in the Admin web service. The exceptions being GetAdminVersion (which returns a string version of the web service and is primarily used to verify the responsiveness of the web service) and GetSubscriptionAccountStatus(which returns the status of the account in an encrypted format). This web service would allow you to log on as a master admin. Add a user and assign site admin privileges to that user. Assign a token or temporary pass to that same user and then log onto the admin web service as that new site admin user. You could also create , assign tokens to and enable standard, proxied or grouped users.

Notes:

  • Some of the methods are deprecated and should not be used. This is noted in the method descriptions in the WSDL.
  • Any method related to SSO and/or federated Logon requires the SSO addin module be installed.
  • The 2FA Manager is built using this web service. This web service is the primary method to manage 2FA users , tokens and settings for the 2FA server.
  • There is a Power Shell script shipped with AuthAnvil which emulates the manager functionality and is an excellent guide to the usage of the admin web service.

Power Shell Script location: c:Program FilesScorpion SoftwareAuthAnvilAuthAnvilToolsAuthAnvilManagementConsole.ps1

AddAllowedAgent

This method adds an allowed agent.

AddDelegationURL

This method inserts the specified delegation url for the given proxied user.

AddGroupedUsers

This method assigns users to a user group by user name list

AddGroupedUsersByUserID

This method assigns users to a user group by user ID list

AddSiteAdmin

This method elevates a user to admin status

AddToken

This method inserts a new token to the specified site

AddUser

This method adds a new user.

AssignSoftToken

This assigns a soft token to a user and returns the activation code.(null on failure)

AssignToken

This method assigns a token to a user.

CalculateDashboardSettings

This method populates the loginAttempts, failedPINLogins and FailedOTPLogins.

CreateSiteExportFile

This method create a site export file.(.XAA)

DeleteDelegationURL

This method deletes the specified delegation url for the given proxied user

DeleteSiteAdmin

This method revokes a user’s admin privileges

DeleteTemporaryPassword

This method deletes the temporary password for the user

DeleteToken

This method deletes the token for the given serial number

DeleteUser

This method deletes an AuthAnvil user.

DeleteUsersFromGroup

This method deletes all users from the given group

DisableToken

This method disables a token

EnableToken

This method enables a token

GetAdminVersion

This method returns the version of this admin site.

GetAdusSettingInfo

This method gets the ADUS settings for the current site into a ADUSSettingInfo object.

GetAllTokenSerials

This method returns an ArrayList of TokenListItems.

GetAllowedAgents

This method returns a list of allowed IPs that can communicate with AuthAnvil

GetDelegationSiteID

This method returns the delgation site id for the given proxied user

GetDelegationURL

This method returns the delegation url for the given proxied user.

GetLogs

This method returns an ArrayList of LogListItems from the AuthAnvil database logs in descending timestamp order.

GetLogsByRange

This method returns an ArrayList of LogListItems from the AuthAnvil database logs in descending timestamp order. It will only retrieve entries in the specified range

GetSSOAddinCertificate

This gets the sso addin certificate.

GetServerSettingValue

This method gets the value of the specified server setting

GetSiteAdminUserIds

This method returns an ArrayList of site admin user ids.)

GetSiteName

This method gets the current site name

GetSiteSettings

This method loads the settings for the current site into a SiteSettingInfo object.

GetSites

This method returns all available sites(No Session Key Required).

GetSoftTokenActivationCode

This returns the soft token activation code(if the token has not been assigned).(null on failure)

GetTempPasswordObjectUserList

This method gets an arraylist of TempPasswordUserInfo Objects

GetTokenCount

This method returns the number of assigned tokens on a site.

GetTokenInfoBySerial

This method returns a tokenListItem for the token serial passed in.

GetTokens

This method returns an ArrayList of TokenListItems.

GetUnassignedTokens

This method returns an ArrayList all unassigned token serials

GetUser

This method returns a UserListItem for the given user.

GetUserCount

This method returns the number of users on the site.

GetUserEnabledStatus

This method returns whether or not the user is enabled

GetUserInfoList

This method returns an ArrayList of UserInfo objects.

GetUserTokenEnrollmentStatus

This method returns if a user has been sent a self enroll email and when it was last sent

GetUserTokenInfo

This method returns a tokenInfo object for the given user.

GetUsers

DEPRECATED This method returns an ArrayList of UserListItems.

GetUsersFromGroup

This method returns an ArrayList of all usernames in a group

GetUsersNames

This method returns an ArrayList of usernames.

ImportSiteExportFile

This method imports a site export file. (.XAA)

InsertOrUpdateFederatedInfo

This method updates or inserts federated logon info for the current site.

IsSSOAddinInstalled

This determines if the sso addin is installed.

IsSiteAdministrator

This method checks to see if the user is a site admin.

LoadDashboardSettings

This method populates the duration and threshold values by ref.

LoadFederatedInfo

This method gets the federated logon info.

Logon

This method authenticates a user against their passcode [PIN+OTP] in the AuthAnvil Strong Authentication Server, and returns a session key to use for further admin requests.

LogonAsMaster

This method authenticates Master Admin.

LogonWithSAMLAssertion

This method attempts to authenticate a SAML assertion for a user. Populates the out sessionKey on success.

ReSyncToken

This method resyncs a token.

SendChangePINRequest

This method sends a change PIN request email to the specified user.

SendHardTokenEnrollmentEmail

This method sends a self enrollment email to the specified user.

SendSoftTokenEnrollmentEmail

This method assigns a token to a user.

SendTokenUnLockedEmail

This method sends a token unlocked email to the specified user

SetAdusSettingInfo

This method sets( inserts or updates) the ADUS settings for the current site.

SetFederatedLogonEnabledStatus

This method enables or disables SSO for the current site.

SetServerSettingValue

This method updates( if a value exists) or inserts( if the setting does not exist) the value of the specified server setting.

SetSiteSettings

This method inserts or updates the settings for the current site .

SetTemporaryPassword

This method sets a temporary password for the user

SetUserEnabledStatus

This method sets the users enabled status

SetUserTokenEnrollmentStatus

This method sets a users self enroll token status

TestToken

This method tests a token

TruncateAllowedAgentsTable

This method truncates the allowedAgent table.

UnassignToken

This method unassigns the given token(any type) from its user

UnlockToken

This method unlocks a locked token

UpdateEnrollment

This method updates the user enrollment info.

UpdatePIN

This method updates a users PIN.

UpdateSiteName

This method updates the site with a new name

UpdateTemporaryPasswordExpiry

This method updates the expiry of the temporary password for the user

UpdateUser

This method updates the users information by userID

VerifyValidTemporaryPassword

This method determines if the users temporary password is still valid. Populates expiryDate with the expiry time( even if not valid).

Master Admin

The web service contains access to settings that can apply to any or all sites contained within the 2FA install. Allows a Master Admin to log on and obtain a session key. This session key is a required parameter for all other methods available in the MasterAdmin web service. The sole exception being the method GetVersion () which simply returns a string version of the web service and is used to verify the responsiveness of the web service.

The MasterAdmin service is located at /AuthAnvil/Admin/MasterAdmin.asmx

AddSite

This method creates a new site

DeleteSite

This method deletes a site and all token, user and setting entries related to the deleted site.

GetSiteIDByName

This method returns the Site ID for the given site name

GetSubscriptionValues

This method gets the editable subscription values

GetVersion

This method returns the version of this Master Admin web service.

Logon

This method authenticates a Master Admin in the AuthAnvil Strong Authentication Server, and returns a session key to use for further master admin requests.

SetSubscriptionValues

This method sets the editable subscription values

UpdateSiteName

This method updates the site with a new name

Notes:

  • This is the only way to manage sites on the AUthAnvilServer.
  • There can only be one MasterAdmin per 2FA install.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk