Enum Class ErrorCode

Object
Enum<ErrorCode>
se.curity.identityserver.sdk.errors.ErrorCode
All Implemented Interfaces:
Serializable, Comparable<ErrorCode>, Constable

public enum ErrorCode extends Enum<ErrorCode>
Errors that can be raised from the authentication service or one of its plug-ins. When the authentication service is used with an OAuth token service, these will be mapped to standard-defined errors.
See Also:
  • Enum Constant Details

    • GENERIC_ERROR

      public static final ErrorCode GENERIC_ERROR
      A generic error. When used in an OAuth context, this will map to server_error.
    • RESOURCE_DOES_NOT_EXIST

      public static final ErrorCode RESOURCE_DOES_NOT_EXIST
      A resource does not exist. When used in an OAuth context, this will map to invalid_request.
    • ACCESS_DENIED

      public static final ErrorCode ACCESS_DENIED
      Access is denied. When used in an OAuth context, this will map to access_denied
    • AUTHENTICATION_FAILED

      public static final ErrorCode AUTHENTICATION_FAILED
      When used in an OAuth context, this will map to login_required.
    • NO_ALLOWED_AUTHENTICATORS

      public static final ErrorCode NO_ALLOWED_AUTHENTICATORS
      There are no allowed authenticators configured which can satisfy the request. When used in an OAuth context, this will map to server_error.
    • MISSING_PARAMETERS

      public static final ErrorCode MISSING_PARAMETERS
      A required parameter was not provided. When used in an OAuth context, this will map to invalid_request.
    • MISSING_HEADERS

      public static final ErrorCode MISSING_HEADERS
      A required header was not provided. When used in an OAuth context, this will map to invalid_request.
    • INVALID_INPUT

      public static final ErrorCode INVALID_INPUT
      The input is not valid for some particular reason. When used in an OAuth context, this will map to invalid_request.
    • INVALID_HEADERS

      public static final ErrorCode INVALID_HEADERS
      A request header or headers is not valid for some particular reason. When used in an OAuth context, this will map to invalid_request.
    • INVALID_ACRS

      public static final ErrorCode INVALID_ACRS
      A request ACR is invalid for some particular reason. When used in an OAuth context, this will map to invalid_request.
    • INVALID_REDIRECT_URI

      public static final ErrorCode INVALID_REDIRECT_URI
      A redirect URI is invalid some particular reason. When used in an OAuth context, this will map to invalid_redirect_uri.
    • INVALID_SERVER_STATE

      public static final ErrorCode INVALID_SERVER_STATE
      The server is in some state that causes the request to be invalid or unable to be processed. When used in an OAuth context, this will map to server_error.
    • INVALID_SERVICE_PROVIDER_ID

      public static final ErrorCode INVALID_SERVICE_PROVIDER_ID
      The given service provider ID was invalid. This parameter should not be used in an OAuth context, but, if it is, this will map to invalid_request.
    • FRESHNESS_ERROR

      public static final ErrorCode FRESHNESS_ERROR
      No SSO session are fresh enough to meet the requested values. When used in an OAuth context, this will map to login_required.
    • SERVICE_PROVIDER_ERROR

      public static final ErrorCode SERVICE_PROVIDER_ERROR
      The service provider data was not valid for some particular reason. This parameter should not be used in an OAuth context, but, if it is, this will map to server_error.
    • EXTERNAL_SERVICE_ERROR

      public static final ErrorCode EXTERNAL_SERVICE_ERROR
      An error occurred contacting some external service (e.g., a database or web service). When used in an OAuth context, this will map to server_error.
    • CONFIGURATION_ERROR

      public static final ErrorCode CONFIGURATION_ERROR
      The configuration of the server caused an unexpected error. When used in an OAuth context, this will map to server_error.
    • TOKEN_ISSUANCE_ERROR

      public static final ErrorCode TOKEN_ISSUANCE_ERROR
      An error occurred trying to issue a token (e.g., a login token or a one-time-usage token meant to challenge the user during the authentication process). When used in an OAuth context, this will map to server_error.
    • ATTRIBUTE_TRANSFORMATION_ERROR

      public static final ErrorCode ATTRIBUTE_TRANSFORMATION_ERROR
      An error occurred transforming attributes. When used in an OAuth context, this will map to server_error.
    • PLUGIN_ERROR

      public static final ErrorCode PLUGIN_ERROR
      A plug-in caused an error for some particular reason. When used in an OAuth context, this will map to server_error.
    • AUTHORIZATION_FAILED

      public static final ErrorCode AUTHORIZATION_FAILED
      An unauthorized error occurred for some particular reason. When used in an OAuth context, this will map to access_denied.
    • ADMIN_API_ERROR

      public static final ErrorCode ADMIN_API_ERROR
      The admin API produced an error for some particular reason. This parameter should not be used in an OAuth context, but, if it is, this will map to server_error.
    • SSO_NOT_POSSIBLE

      public static final ErrorCode SSO_NOT_POSSIBLE
      SSO was requested, but could not be performed. The user must log in. When used in an OAuth context, this will map to login_required.
      Since:
      2.2.0
    • NO_ACCOUNT_TO_SELECT

      public static final ErrorCode NO_ACCOUNT_TO_SELECT
      A particular user was requested to log in, and that account cannot be found. When used in an OAuth context, this will map to account_selection_required.
      Since:
      2.2.0
    • CONFLICT

      public static final ErrorCode CONFLICT
      A conflict occurred (e.g., a new user registered with a username that already exists). When used in an OAuth context, this will map to server_error.
      Since:
      3.0.0
    • USER_ABORTED_OPERATION

      public static final ErrorCode USER_ABORTED_OPERATION
      The user terminated the operation (e.g., by clicking a cancel button during the login process). When used in an OAuth context, this will map to access_denied.
      Since:
      4.1.0
  • Method Details

    • values

      public static ErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      Overrides:
      toString in class Enum<ErrorCode>