OktaJava.User.mustache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta-api-swagger-templates Show documentation
There is a newer version: 9.0.0-beta
Show newest version
{{!
    Copyright 2018-Present Okta, Inc.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
}}

    /**
     * Enroll Factor
     * Enrolls a user with a supported factor.
     * @param updatePhone  (optional, default to false)
     * @param templateId id of SMS template (only for SMS factor) (optional)
     * @param tokenLifetimeSeconds  (optional, default to 300)
     * @param activate  (optional, default to false)
     * @param body Factor (required)
     * @return Factor
     * @deprecated use {@link User#addFactor(Factor, Boolean, String, Integer, Boolean)}
    */
    @javax.annotation.Generated(
            value    = "com.okta.swagger.codegen.OktaJavaClientApiCodegen",
            comments = "POST - /api/v1/users/{userId}/factors")
    @Deprecated
    Factor addFactor(Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate, Factor body);

    /**
     * Enroll Factor
     * Enrolls a user with a supported factor.
     * @param updatePhone  (optional, default to false)
     * @param templateId id of SMS template (only for SMS factor) (optional)
     * @param body Factor (required)
     * @return Factor
     * @deprecated use {@link User#addFactor(Factor, Boolean, String)}
    */
    @javax.annotation.Generated(
            value    = "com.okta.swagger.codegen.OktaJavaClientApiCodegen",
            comments = "POST - /api/v1/users/{userId}/factors")
    @Deprecated
    Factor addFactor(Boolean updatePhone, String templateId, Factor body);

    /**
     * Forgot Password
     * Generates a one-time token (OTT) that can be used to reset a user's password.  The user will be required to validate their security question's answer when visiting the reset link.
     * This operation can only be performed on users with a valid [recovery question credential](#recovery-question-object) and have an `ACTIVE` status.
     * @param sendEmail  (optional, default to true)
     * @param userCredentials  (optional)
     * @return ForgotPasswordResponse
     * @deprecated use {@link User#forgotPassword(UserCredentials, Boolean)}
    */
    @javax.annotation.Generated(
            value    = "com.okta.swagger.codegen.OktaJavaClientApiCodegen",
            comments = "POST - /api/v1/users/{userId}/credentials/forgot_password")
    @Deprecated
    ForgotPasswordResponse forgotPassword(Boolean sendEmail, UserCredentials userCredentials);