Nomadesk API

Controller: Account Management: ConfigureTwoFactorAuth

ConfigureTwoFactorAuth

Sets the two factor auth secret for the account when going to the setup flow

Authentication Methods


  1. With a username(email) and password
Input Parameter Type Description
LinkID* String
BrandName String This is the name that the user will see when two-factor authentication is configured on his cellphone (If not specified will take brand name)
Output Parameter Type Description
Success Boolean
URL String This is the url used to display the QR code
Email String This is the email address that is being configured

*Required

CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Task=ConfigureTwoFactorAuth&LinkID=7d7216b9-d69b-dc6d-281e-2fc082f1af08'
RESPONSE
<Response>
    <Status>1</Status>
    <Message></Message>
    <URL>https://chart.googleapis.com/chart?chs=200x200&chld=M|0&cht=qr&chl=otpauth%3A%2F%2Ftotp%2Ftwofactorauth%40example.com%3Fsecret%3D34TDEYHC4QKWPL4Y%26issuer%3DCompanyName</URL>
    <Email>twofactorauth@example.com</Email>
</Response>