Class LoginConfig


  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
    public class LoginConfig
    extends Object
    LoginConfig
    • Constructor Detail

      • LoginConfig

        public LoginConfig()
    • Method Detail

      • getRBAC

        @Nullable
        public LoginConfig.RBACEnum getRBAC()
        RBAC will remain enabled on GUI if \"external\". That only works with an external auth service.
        Returns:
        RBAC
      • getLoginUrl

        @Nonnull
        public String getLoginUrl()
        primary URL to use for login.
        Returns:
        loginUrl
      • setLoginUrl

        public void setLoginUrl​(String loginUrl)
      • loginFailedMessage

        public LoginConfig loginFailedMessage​(String loginFailedMessage)
      • getLoginFailedMessage

        @Nullable
        public String getLoginFailedMessage()
        message to display to users who fail to login; a full sentence that is rendered in HTML and may contain a link to a secondary login method
        Returns:
        loginFailedMessage
      • setLoginFailedMessage

        public void setLoginFailedMessage​(String loginFailedMessage)
      • fallbackLoginUrl

        public LoginConfig fallbackLoginUrl​(String fallbackLoginUrl)
      • getFallbackLoginUrl

        @Nullable
        public String getFallbackLoginUrl()
        secondary URL to offer users to use for login.
        Returns:
        fallbackLoginUrl
      • setFallbackLoginUrl

        public void setFallbackLoginUrl​(String fallbackLoginUrl)
      • fallbackLoginLabel

        public LoginConfig fallbackLoginLabel​(String fallbackLoginLabel)
      • getFallbackLoginLabel

        @Nullable
        public String getFallbackLoginLabel()
        label to place on fallback_login_url.
        Returns:
        fallbackLoginLabel
      • setFallbackLoginLabel

        public void setFallbackLoginLabel​(String fallbackLoginLabel)
      • addLoginCookieNamesItem

        public LoginConfig addLoginCookieNamesItem​(String loginCookieNamesItem)
      • getLoginCookieNames

        @Nonnull
        public List<String> getLoginCookieNames()
        cookie names used to store JWT
        Returns:
        loginCookieNames
      • setLoginCookieNames

        public void setLoginCookieNames​(List<String> loginCookieNames)
      • getLogoutUrl

        @Nonnull
        public String getLogoutUrl()
        URL to use for logging out.
        Returns:
        logoutUrl
      • setLogoutUrl

        public void setLogoutUrl​(String logoutUrl)
      • putAdditionalProperty

        public LoginConfig putAdditionalProperty​(String key,
                                                 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.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the LoginConfig instance itself
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

        public Object getAdditionalProperty​(String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to LoginConfig
      • fromJson

        public static LoginConfig fromJson​(String jsonString)
                                    throws IOException
        Create an instance of LoginConfig given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of LoginConfig
        Throws:
        IOException - if the JSON string is invalid with respect to LoginConfig
      • toJson

        public String toJson()
        Convert an instance of LoginConfig to an JSON string
        Returns:
        JSON string