com.microsoft.aad.msal4j.AuthenticationErrorCode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of msal4j Show documentation
Microsoft Authentication Library for Java gives you the ability to obtain tokens from Azure AD v2 (work and school accounts, MSA) and Azure AD B2C, gaining access to Microsoft Cloud API and any other API secured by Microsoft identities
There is a newer version: 1.18.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.aad.msal4j;

/**
 * Class containing error codes returned by the service or generated by the client
 */
public class AuthenticationErrorCode {

    /**
     * In the context of device code user has not yet authenticated via browser. For more details,
     * see https://aka.ms/msal4j-device-code
     */
    public final static String AUTHORIZATION_PENDING = "authorization_pending";

    /**
     * In the context of device code, this error happens when the device code has expired before
     * the user signed-in on another device (this is usually after 15 min). For more details, see
     * https://aka.ms/msal4j-device-code
     */
    public final static String CODE_EXPIRED = "code_expired";

    /**
     * Standard Oauth2 protocol error code. It indicates that the application needs to expose
     * the UI to the user so that user does an interactive action in order to get a new token.
     */
    public final static String INVALID_GRANT = "invalid_grant";

    /**
     * WS-Trust Endpoint not found in Metadata document
     */
    public final static String WSTRUST_ENDPOINT_NOT_FOUND_IN_METADATA_DOCUMENT = "wstrust_endpoint_not_found";

    /**
     * WS-Trust endpoint response did not contain the required fields
     */
    public final static String WSTRUST_INVALID_RESPONSE = "wstrust_invalid_response";

    /**
     * WS-Trust request resulted in service error
     */
    public final static String WSTRUST_SERVICE_ERROR = "wstrust_service_error";

    /**
     * Password is required for managed user. Will typically happen when trying to do integrated windows authentication
     * for managed users. For more information, see https://aka.ms/msal4j-iwa
     */
    public final static String PASSWORD_REQUIRED_FOR_MANAGED_USER = "password_required_for_managed_user";

    /**
     * User realm discovery failed
     */
    public final static String USER_REALM_DISCOVERY_FAILED = "user_realm_discovery_failed";

    /**
     * Not found in the cache
     */
    public final static String CACHE_MISS = "cache_miss";

    /**
     * Not able to parse instance discovery metadata. Ensure data is in valid JSON format, and that
     * it contains relevant fields. For more information, see https://aka.ms/msal4j-instance-discovery
     */
    public final static String INVALID_INSTANCE_DISCOVERY_METADATA = "invalid_instance_discovery_metadata";

    /**
     * Unknown error occurred
     */
    public final static String UNKNOWN = "unknown";

    /**
     * The current redirect URI is not a loopback URL. To use the OS browser, a loopback URL must be
     * configured both during app registration as well as when initializing the InteractiveRequestParameters
     * object. For more details, see https://aka.ms/msal4j-interactive-request
     */
    public final static String LOOPBACK_REDIRECT_URI = "loopback_redirect_uri";

    /**
     * Unable to start Http listener to the specified port. This might be because the port is busy.
     */
    public final static String UNABLE_TO_START_HTTP_LISTENER = "unable_to_start_http_listener";

    /**
     * Authorization result response is invalid. Authorization result must contain authorization
     * code and state.
     */
    public final static String INVALID_AUTHORIZATION_RESULT = "invalid_authorization_result";

    /**
     * Redirect URI provided to MSAL is of invalid format. Redirect URL must be a loopback URL.
     * For more details, see https://aka.ms/msal4j-interactive-request
     */
    public final static String INVALID_REDIRECT_URI = "invalid_redirect_uri";

    /**
     * MSAL was unable to open the user-default browser. This is either because the current platform
     * does not support {@link java.awt.Desktop} or {@link java.awt.Desktop.Action#BROWSE}. Interactive
     * requests require that the client have a system default browser. For more details, see
     * https://aka.ms/msal4j-interactive-request
     */
    public final static String DESKTOP_BROWSER_NOT_SUPPORTED = "desktop_browser_not_supported";

    /**
     * Request was throttled according to instructions from STS.
     */
    public final static String THROTTLED_REQUEST = "throttled_request";

    /**
     * A JSON processing failure, indicating the JSON provided to MSAL is of invalid format.
     */
    public final static String INVALID_JSON = "invalid_json";

    /**
     * A JWT parsing failure, indicating the JWT provided to MSAL is of invalid format.
     */
    public final static String INVALID_JWT = "invalid_jwt";

    /**
     * Indicates that a Broker implementation is missing from the device, such as when an app developer
     * does not include one of our broker packages as a dependency in their project, or otherwise cannot
     * be accessed by MSAL Java
     */
    public final static String MISSING_BROKER = "missing_broker";

    /**
     * Indicates that a timeout occurred during an HTTP call. If this was thrown in relation to a connection timeout error,
     * there is likely a network issue preventing the library from reaching a service, such as being blocked by a firewall.
     * If this was thrown in relation to a read timeout error, there is likely an issue in the service itself causing a
     * slow response, and this may be resolvable by increasing timeouts. For more details, see https://aka.ms/msal4j-http-client
     */
    public final static String HTTP_TIMEOUT = "http_timeout";

    /**
     * Indicates an error from the MSAL Java/MSALRuntime interop layer used by the Java Brokers package,
     * and will generally just be forwarding an error message from the interop layer or MSALRuntime itself
     */
    public final static String MSALRUNTIME_INTEROP_ERROR = "interop_package_error";

    /**
     * Indicates an error related to the MSAL Java Brokers package
     */
    public final static String MSALJAVA_BROKERS_ERROR = "brokers_package_error";

    /**
     * Indicates that a request to managed identity endpoint failed, see error message for detailed reason and correlation id.
     * For more information on managed identity see https://aka.ms/msal4j-managed-identity.
     */
    public static final String MANAGED_IDENTITY_REQUEST_FAILED = "managed_identity_request_failed";
}