Package app.kntrl.client.openapi.model

Class IpAuthCfg

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

    • Field Detail

      • SERIALIZED_NAME_REQUIRES_AUTH

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

      • SERIALIZED_NAME_SKIP_ON_FAIL

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

      • SERIALIZED_NAME_RATE_LIMITER

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

      • SERIALIZED_NAME_BURN_QUOTA

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

      • SERIALIZED_NAME_IP_BYTES_TO_IGNORE

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

      • SERIALIZED_NAME_HISTORY_SIZE

        public static final java.lang.String SERIALIZED_NAME_HISTORY_SIZE
        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

      • IpAuthCfg

        public IpAuthCfg()

    • Method Detail

      • requiresAuth

        public IpAuthCfg requiresAuth​(java.util.List<java.util.List<java.lang.String>> requiresAuth)

      • addRequiresAuthItem

        public IpAuthCfg addRequiresAuthItem​(java.util.List<java.lang.String> requiresAuthItem)

      • getRequiresAuth

        @Nullable
public java.util.List<java.util.List<java.lang.String>> getRequiresAuth()
        If this is not null, app forbids to add this auth until listed auth enabled. - if this a string -> require specified auth to be enabled before this. - array of strings -> require any of listed auths to be enabled - array of arrays of strings -> works as `[ [ \"auth1\" and \"auth2\" ] or [ \"auth1\" and \"auth2\" ] ]`
        Returns:
        requiresAuth

      • setRequiresAuth

        public void setRequiresAuth​(java.util.List<java.util.List<java.lang.String>> requiresAuth)

      • skipOnFail

        public IpAuthCfg skipOnFail​(java.lang.Boolean skipOnFail)

      • getSkipOnFail

        @Nullable
public java.lang.Boolean getSkipOnFail()
        When this is set to true app will attempt next auth in case of error on current. It's works good with IP auth. User can provide both IP auth request and SMS auth request. And SMS will be executed only when IP auth is failed. If set to false any error on this auth will stop the whole request execution.
        Returns:
        skipOnFail

      • setSkipOnFail

        public void setSkipOnFail​(java.lang.Boolean skipOnFail)

      • rateLimiter

        public IpAuthCfg rateLimiter​(java.lang.String rateLimiter)

      • getRateLimiter

        @Nullable
public java.lang.String getRateLimiter()
        Apply rate limiter for this auth.
        Returns:
        rateLimiter

      • setRateLimiter

        public void setRateLimiter​(java.lang.String rateLimiter)

      • burnQuota

        public IpAuthCfg burnQuota​(java.lang.Double burnQuota)

      • getBurnQuota

        @Nullable
public java.lang.Double getBurnQuota()
        Every auth execution will burn this amount of quota. Takes place only when rate limiter is specified
        Returns:
        burnQuota

      • setBurnQuota

        public void setBurnQuota​(java.lang.Double burnQuota)

      • ipBytesToIgnore

        public IpAuthCfg ipBytesToIgnore​(java.lang.Integer ipBytesToIgnore)

      • getIpBytesToIgnore

        @Nullable
public java.lang.Integer getIpBytesToIgnore()
        This allows to drop last bytes of IP. So it allows to authenticate factor when ip has rough match, e.g. the same country, same city, or same internet provider.
        Returns:
        ipBytesToIgnore

      • setIpBytesToIgnore

        public void setIpBytesToIgnore​(java.lang.Integer ipBytesToIgnore)

      • historySize

        public IpAuthCfg historySize​(java.lang.Integer historySize)

      • getHistorySize

        @Nullable
public java.lang.Integer getHistorySize()
        History of IP addresses user used to sign-in. Authenticated when user attempts to sign in with one of stored IPs.
        Returns:
        historySize

      • setHistorySize

        public void setHistorySize​(java.lang.Integer historySize)

      • putAdditionalProperty

        public IpAuthCfg 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 IpAuthCfg

      • fromJson

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

      • toJson

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