com.auth0.guardian

Class Transaction

java.lang.Object

com.auth0.guardian.Transaction

All Implemented Interfaces:

java.io.Serializable

public class Transaction
extends java.lang.Object
implements java.io.Serializable

An enrollment Transaction

A transaction is created when requesting to enroll. This transaction will be required to confirm the enrollment once the user added his TOTP account or received the SMS with the code.

Implements java.io.Serializable to make it easy to save on the session. The transaction contains sensitive information like the transaction token and the recovery code. Keep in mind this when considering possible storage options.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRecoveryCode()
java.lang.String	getTotpSecret() Returns the TOTP secret to be encoded in a URI for QR code generation, or manually entered if a camera is not available to the enrollment device.
java.lang.String	getTransactionToken()
java.lang.String	totpURI(java.lang.String user, java.lang.String issuer) Returns the TOTP enrollment URI to be displayed in the QR code

Methods inherited from class java.lang.Object

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

Method Detail

getTransactionToken

public java.lang.String getTransactionToken()

getRecoveryCode

public java.lang.String getRecoveryCode()

getTotpSecret

public java.lang.String getTotpSecret()
                               throws java.lang.IllegalStateException

Returns the TOTP secret to be encoded in a URI for QR code generation, or manually entered if a camera is not available to the enrollment device.

Returns:

the TOTP secret

Throws:

java.lang.IllegalStateException - when there is no OTP secret

totpURI

public java.lang.String totpURI(java.lang.String user,
                                java.lang.String issuer)
                         throws java.lang.IllegalStateException

Returns the TOTP enrollment URI to be displayed in the QR code

Parameters:

user - the user name or email of the account

issuer - the issuer of the account, usually the company or service name

Returns:

the TOTP URI

Throws:

java.lang.IllegalStateException - when there is no OTP secret