Package org.keycloak.utils

Class TotpUtils

java.lang.Object

org.keycloak.utils.TotpUtils

public class TotpUtils
extends Object

Author:

Stian Thorgersen

Constructor Summary

Constructors

Constructor	Description
TotpUtils()

Method Summary

Modifier and Type	Method	Description
static String	encode(String totpSecret)
static String	qrCode(String totpSecret, RealmModel realm, UserModel user)	Deprecated. Use qrCode(KeycloakSession, String, RealmModel, UserModel) instead to get locale-aware issuer names.
static String	qrCode(KeycloakSession session, String totpSecret, RealmModel realm, UserModel user)	Generates a QR code using a locale-aware realm display name as issuer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TotpUtils

public TotpUtils()

Method Details

encode

public static String encode(String totpSecret)

qrCode

@Deprecated(since="26.7.0")
public static String qrCode(String totpSecret,
 RealmModel realm,
 UserModel user)

Deprecated.

Use qrCode(KeycloakSession, String, RealmModel, UserModel) instead to get locale-aware issuer names.

Generates a QR code using the realm name as issuer. Use when no session is available.

qrCode

public static String qrCode(KeycloakSession session,
 String totpSecret,
 RealmModel realm,
 UserModel user)

Generates a QR code using a locale-aware realm display name as issuer. Preferred when a session is available.