Pro jednotlivé uživatele lze aktivovat dvoufázové ověřování (2FA) nejen v klientské aplikaci, ale také pomocí REST API.

Pozor: aktivace 2FA se vztahuje také na API volání s HTTP autentizací, kdy je nutné každý požadavek daného uživatele doplnit query parametrem otp s aktuální hodnotou jednorázového hesla.

Zapnutí

PUT /u/{user}/enable-2fa?secret={secret}&otp={otp-code}

Parametry:

Parametr * Popis
user * Uživatelské jméno právě přihlášeného uživatele
secret * Privátní klíč uživatele
otp-code * Jednorázové heslo
* = povinný parametr

Výsledek:

Ve formátu XML nebo JSON je vrácen příznak úspěchu operace success a zpráva message:
{
  "winstrom": {
    "@version": "1.0",
    "success": "true",
    "message": "Dvoufázové ověření bylo úspěšně nastaveno."
  }
}

Vypnutí

PUT /u/{user}/disable-2fa?otp={otp-code}

Parametry:

Parametr * Popis
user * Uživatelské jméno právě přihlášeného uživatele
otp-code * Jednorázové heslo
* = povinný parametr

Výsledek:

Ve formátu XML nebo JSON je vrácen příznak úspěchu operace success a zpráva message:
<winstrom version="1.0">
    <success>true</success>
    <message>Dvoufázové ověření bylo úspěšně vypnuto.</message>
</winstrom>

Vypnutí administrátorem

Uživatel s oprávněním 'Měnit heslo uživatelům' může vypnout dvoufázové ověření jinému uživateli.

PUT /u/disable-2fa?username={username}

Parametry:

Parametr * Popis
username * Uživatelské jméno právě přihlášeného uživatele
* = povinný parametr

Výsledek:

Ve formátu XML nebo JSON je vrácen příznak úspěchu operace success a zpráva message:
    <winstrom version="1.0">
        <success>true</success>
        <message>Dvoufázové ověření bylo úspěšně vypnuto.</message>
    </winstrom>
    

Vystavení QR kódu

GET /u/{user}/qrcode-2fa

Parametry:

Parametr * Popis
user * Uživatelské jméno právě přihlášeného uživatele
* = povinný parametr

Pro zadaného uživatele vystaví QR kód ve formátu image/png s nově vygenerovaným privátní klíčem. V HTTP hlavičce odpovědi Secret se nachází privátní klíč v textové podobě.

Pokud má uživatel dvoufázové ověření již aktivní, operace vrací stavový kód 403.