com.auth0.guardian

Class Guardian

java.lang.Object

com.auth0.guardian.Guardian

public class Guardian
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Guardian(java.lang.String baseUrl) Creates an instance for a specific Guardian server URL

Method Summary

Modifier and Type	Method and Description
void	confirmEnroll(java.lang.String transactionToken, java.lang.String otp) Confirms an enrollment started with requestEnroll(String, EnrollmentType).
Enrollment	confirmEnroll(Transaction transaction, java.lang.String otp) Confirms an enrollment started with requestEnroll(String, EnrollmentType).
Transaction	requestEnroll(java.lang.String ticket, EnrollmentType type) Request to create an enrollment

Methods inherited from class java.lang.Object

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

Constructor Detail

Guardian

public Guardian(java.lang.String baseUrl)

Creates an instance for a specific Guardian server URL

Parameters:

baseUrl - the Guardian server URL

Method Detail

requestEnroll

public Transaction requestEnroll(java.lang.String ticket,
                                 EnrollmentType type)
                          throws java.io.IOException,
                                 GuardianException

Request to create an enrollment

Parameters:

ticket - the enrollment ticket

type - the enrollment type to request

Returns:

an enrollment Transaction

Throws:

java.io.IOException - when there's a connection issue

GuardianException - when there's a Guardian specific issue

confirmEnroll

public Enrollment confirmEnroll(Transaction transaction,
                                java.lang.String otp)
                         throws java.io.IOException,
                                java.lang.IllegalArgumentException,
                                GuardianException

Confirms an enrollment started with requestEnroll(String, EnrollmentType).

Use this method to confirm an enrollment transaction once the user scanned the QR code with a TOTP app (for a transaction initiated with EnrollmentType.TOTP()) or when the user received the OTP code delivered to his phone number by SMS (for a transaction initiated with EnrollmentType.SMS(String)).

Parameters:

transaction - the enrollment transaction

otp - the code obtained from the TOTP app or delivered to the phone number by SMS

Returns:

extra information about the enrollment, like the recovery code

Throws:

java.io.IOException - when there's a connection issue

java.lang.IllegalArgumentException - when the transaction is not valid

GuardianException - when there's a Guardian specific issue (invalid otp for example)

confirmEnroll

public void confirmEnroll(java.lang.String transactionToken,
                          java.lang.String otp)
                   throws java.io.IOException,
                          java.lang.IllegalArgumentException,
                          GuardianException

Confirms an enrollment started with requestEnroll(String, EnrollmentType).

Use this method to confirm an enrollment transaction once the user scanned the QR code with a TOTP app (for a transaction initiated with EnrollmentType.TOTP()) or when the user received the OTP code delivered to his phone number by SMS (for a transaction initiated with EnrollmentType.SMS(String)). This overload is intended for stateless applications where Serializable is not acceptable, avoiding the necessity of utilising poor practises to preserve Transaction between user actions.

Parameters:

transactionToken - the token associated with the transaction to confirm.

otp - the code obtained from the TOTP app or delivered to the phone number by SMS

Throws:

java.io.IOException - when there's a connection issue

java.lang.IllegalArgumentException - when the transaction is not valid

GuardianException - when there's a Guardian specific issue (invalid otp for example)