Package app.kntrl.client.openapi.model

Class AuthenticateReq

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class AuthenticateReq
extends java.lang.Object
    AuthenticateReq

    • Field Detail

      • SERIALIZED_NAME_FACTORS

        public static final java.lang.String SERIALIZED_NAME_FACTORS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_AUTH_REQS

        public static final java.lang.String SERIALIZED_NAME_AUTH_REQS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DRY_RUN

        public static final java.lang.String SERIALIZED_NAME_DRY_RUN
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • AuthenticateReq

        public AuthenticateReq()

    • Method Detail

      • factors

        public AuthenticateReq factors​(java.util.Map<java.lang.String,​java.lang.String> factors)

      • putFactorsItem

        public AuthenticateReq putFactorsItem​(java.lang.String key,
                                      java.lang.String factorsItem)

      • getFactors

        @Nullable
public java.util.Map<java.lang.String,​java.lang.String> getFactors()
        If this field is not specified, server tries to execute and assign auth for the `next-factor` (see `session` model). Otherwise, auths will be assigned to the factors specified in this field. Useful when: - \"Retry mode\". User didn't receive confirmation code and wants to retry. In this case you should provide `authReq` for auth you want to retry and set it to the same factor. - \"Replace mode\". User can't receive confirmation code and wants to try another auth. E.g. they lost email and want to proceed with a secret-questions auth. In this case you should provide `authReq` for auth you want to replace with and set it to the same factor. If it's used in sign-up mode, it just enables those factors (so actual value is ignored and can be `null`). E.g. `\"factors\": { \"second\": null }` will enable second factor during sign-up.
        Returns:
        factors

      • setFactors

        public void setFactors​(java.util.Map<java.lang.String,​java.lang.String> factors)

      • getAuthReqs

        @Nullable
public java.util.Map<java.lang.String,​AuthenticateReqAuthReqsValue> getAuthReqs()
        Request for authenticators
        Returns:
        authReqs

      • getDryRun

        @Nullable
public java.lang.Boolean getDryRun()
        Execute only validation ща authenticator requests.
        Returns:
        dryRun

      • setDryRun

        public void setDryRun​(java.lang.Boolean dryRun)

      • putAdditionalProperty

        public AuthenticateReq putAdditionalProperty​(java.lang.String key,
                                             java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to AuthenticateReq

      • fromJson

        public static AuthenticateReq fromJson​(java.lang.String jsonString)
                                throws java.io.IOException
        Create an instance of AuthenticateReq given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of AuthenticateReq
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to AuthenticateReq

      • toJson

        public java.lang.String toJson()
        Convert an instance of AuthenticateReq to an JSON string
        Returns:
        JSON string