C E G I N R S T

C

com.auth0.guardian - package com.auth0.guardian

com.auth0.guardian.networking - package com.auth0.guardian.networking

confirmEnroll(Transaction, String) - Method in class com.auth0.guardian.Guardian

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

confirmEnroll(String, String) - Method in class com.auth0.guardian.Guardian

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

E

Enrollment - Class in com.auth0.guardian

Enrollment data obtained after confirmation

EnrollmentType - Class in com.auth0.guardian

The type of multi-factor enrollment: TOTP or SMS

EnrollmentType() - Constructor for class com.auth0.guardian.EnrollmentType

execute() - Method in class com.auth0.guardian.networking.Request

G

getErrorCode() - Method in exception com.auth0.guardian.GuardianException

Returns the `errorCode` value, if available.

getRecoveryCode() - Method in class com.auth0.guardian.Enrollment

Returns the recovery code that can be used by the user to authenticate when the main method (TOTP/SMS) is not available.

getRecoveryCode() - Method in class com.auth0.guardian.Transaction

getTotpSecret() - Method in class com.auth0.guardian.Transaction

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.

getTransactionToken() - Method in class com.auth0.guardian.Transaction

Guardian - Class in com.auth0.guardian

Guardian(String) - Constructor for class com.auth0.guardian.Guardian

Creates an instance for a specific Guardian server URL

GuardianException - Exception in com.auth0.guardian

Class that wraps server-side or app errors exclusively related to Guardian

GuardianException(String, Throwable) - Constructor for exception com.auth0.guardian.GuardianException

GuardianException(Map<String, Object>) - Constructor for exception com.auth0.guardian.GuardianException

I

isAlreadyEnrolled() - Method in exception com.auth0.guardian.GuardianException

Whether the error is caused by the user already having a confirmed enrollment

isEnrollmentNotFound() - Method in exception com.auth0.guardian.GuardianException

Whether the error is caused by the enrollment being invalid or not found on the server

isInvalidOTP() - Method in exception com.auth0.guardian.GuardianException

Whether the error is caused by the use of an invalid OTP code

isInvalidToken() - Method in exception com.auth0.guardian.GuardianException

Whether the error is caused by the use of an invalid token

isLoginTransactionNotFound() - Method in exception com.auth0.guardian.GuardianException

Whether the error is caused by the login transaction being invalid, expired or not found

isTransactionNotFound() - Method in exception com.auth0.guardian.GuardianException

Whether the error is caused by the transaction being invalid, expired or not found (e.g.

N

newRequest(String, HttpUrl, Class<T>) - Method in class com.auth0.guardian.networking.RequestFactory

R

Request<T> - Class in com.auth0.guardian.networking

requestEnroll(String, EnrollmentType) - Method in class com.auth0.guardian.Guardian

Request to create an enrollment

RequestFactory - Class in com.auth0.guardian.networking

RequestFactory(OkHttpClient) - Constructor for class com.auth0.guardian.networking.RequestFactory

S

setBody(Object) - Method in class com.auth0.guardian.networking.Request

setHeader(String, String) - Method in class com.auth0.guardian.networking.Request

setParameter(String, Object) - Method in class com.auth0.guardian.networking.Request

setQueryParameter(String, String) - Method in class com.auth0.guardian.networking.Request

SMS(String) - Static method in class com.auth0.guardian.EnrollmentType

Creates an enrollment type specific for SMS-based multi-factor authentication

T

toString() - Method in exception com.auth0.guardian.GuardianException

TOTP() - Static method in class com.auth0.guardian.EnrollmentType

Creates an enrollment type specific for TOTP-based multi-factor authentication

totpURI(String, String) - Method in class com.auth0.guardian.Transaction

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

Transaction - Class in com.auth0.guardian

An enrollment Transaction

C E G I N R S T