com.auth0.guardian.Enrollment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guardian Show documentation

Java library for Auth0's Guardian platform.

There is a newer version: 0.3.1

/*
 * Copyright (c) 2017 Auth0 (http://auth0.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.auth0.guardian;

/**
 * Enrollment data obtained after confirmation
 */
public class Enrollment {

    private final String recoveryCode;

    Enrollment(String recoveryCode) {
        this.recoveryCode = recoveryCode;
    }

    /**
     * Returns the recovery code that can be used by the user to authenticate when the main method (TOTP/SMS) is not
     * available. For example when the user lost his phone.
     *
     * @return the recovery code
     */
    public String getRecoveryCode() {
        return recoveryCode;
    }
}