TotpUtils (Keycloak REST Services 26.7.0 API)

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, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)

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

static String

qrCode(org.keycloak.models.KeycloakSession session, String totpSecret, org.keycloak.models.RealmModel realm, org.keycloak.models.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, org.keycloak.models.RealmModel realm, org.keycloak.models.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(org.keycloak.models.KeycloakSession session, String totpSecret, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
  
  Generates a QR code using a locale-aware realm display name as issuer. Preferred when a session is available.