Check authenticator API

https://api.alert.alertinghub.co.uk/api/json/checkauth

The check authenticator API allows you to create check a Google-Authenticator style TOTP compliant authentication secret. You can either pass in a compliant secret or, more usefully, if you have created an authenticator using the create authentication API call and asked for the authenticator to be tracked by Alerting Hub, you can simply specify just the issuer/label combination of the authenticator. This latter mode of operation means you never need to handle the actual secret itself.

JSON sample

{
    "version": "latest",
    "apiKey": "abcdefghijklmnopqrstuvwxyz",
    "issuer" : "AcmeTrading",
    "label" : "MyTest2",
    "code" : "123456"
}

API parameters

ParameterRequirementDefaultDescription
versionMandatoryNoneSee API guide
apiKeyMandatoryNoneSee API guide
codeMandatoryNoneThe code you are asking Alerting Hub to check, usually this would be a 6-digit string as entered by a user into a web-application or similar.
issuerOptionalNoneThe issuer string to use, this is the main name shown on the Google Authenticator app. Specify this if you are asking Alerting Hub to check a tracked authenticator.
labelOptionalNoneThe label string to use, this is the name shown (usually in brackets) on the Google Authenticator app. Specify this if you are asking Alerting Hub to check a tracked authenticator.
secretOptionalNoneSpecifies the base32 encoded secret if you are asking Alerting Hub to check a non-track authenticator.

Response

ParameterDescription
successtrue | false. If true then the authentication code was valid, if false then failureReason should also be returned.