com.okta.sdk.resource.model.ApplicationSignOnMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation

The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

There is a newer version: 21.0.0

Show newest version

package com.okta.sdk.resource.model;

import java.util.Objects;
import java.util.Arrays;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.annotations.ApiModel;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * Authentication mode for the app | signOnMode | Description | | ---------- | ----------- | | AUTO_LOGIN | Secure Web
 * Authentication (SWA) | | BASIC_AUTH | HTTP Basic Authentication with Okta Browser Plugin | | BOOKMARK | Just a
 * bookmark (no-authentication) | | BROWSER_PLUGIN | Secure Web Authentication (SWA) with Okta Browser Plugin | |
 * OPENID_CONNECT | Federated Authentication with OpenID Connect (OIDC) | | SAML_1_1 | Federated Authentication with
 * SAML 1.1 WebSSO (not supported for custom apps) | | SAML_2_0 | Federated Authentication with SAML 2.0 WebSSO | |
 * SECURE_PASSWORD_STORE | Secure Web Authentication (SWA) with POST (plugin not required) | | WS_FEDERATION | Federated
 * Authentication with WS-Federation Passive Requestor Profile | Select the `signOnMode` for your custom app:
 */
public enum ApplicationSignOnMode {

    AUTO_LOGIN("AUTO_LOGIN"),

    BASIC_AUTH("BASIC_AUTH"),

    BOOKMARK("BOOKMARK"),

    BROWSER_PLUGIN("BROWSER_PLUGIN"),

    OPENID_CONNECT("OPENID_CONNECT"),

    SAML_1_1("SAML_1_1"),

    SAML_2_0("SAML_2_0"),

    SECURE_PASSWORD_STORE("SECURE_PASSWORD_STORE"),

    WS_FEDERATION("WS_FEDERATION"),

    UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");

    private String value;

    ApplicationSignOnMode(String value) {
        this.value = value;
    }

    @JsonValue
    public String getValue() {
        return value;
    }

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    @JsonCreator
    public static ApplicationSignOnMode fromValue(String value) {
        for (ApplicationSignOnMode b : ApplicationSignOnMode.values()) {
            if (b.value.equals(value)) {
                return b;
            }
        }
        return UNKNOWN_DEFAULT_OPEN_API;
    }

    /**
     * Convert the instance into URL query string.
     *
     * @param prefix
     *            prefix of the query string
     *
     * @return URL query string
     */
    public String toUrlQueryString(String prefix) {
        if (prefix == null) {
            prefix = "";
        }

        return String.format("%s=%s", prefix, this.toString().toString());
    }
}