OAuth2Constants.Error (OpenAM Project 15.2.1-SNAPSHOT API)

java.lang.Object
- org.forgerock.openam.oauth2.OAuth2Constants.Error

Enclosing class:

OAuth2Constants
```
public static class OAuth2Constants.Error
extends Object
```
See 11.4. The OAuth Extensions Error Registry

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_DENIED` The resource owner or authorization server denied the request.
`static String`	`BAD_REQUEST`
`static String`	`CONSENT_REQUIRED` OpenID Connect Consent error
`static String`	`ERROR` A single error code
`static String`	`ERROR_DESCRIPTION` OPTIONAL.
`static String`	`ERROR_URI` OPTIONAL.
`static String`	`EXPIRED_TOKEN` The access token provided has expired.
`static String`	`INSUFFICIENT_SCOPE` The request requires higher privileges than provided by the access token.
`static String`	`INTERACTION_REQUIRED` OpenID Connect interaction required error
`static String`	`INVALID_CLIENT` The client identifier provided is invalid, the client failed to authenticate, the client did not include its credentials, provided multiple client credentials, or used unsupported credentials type.
`static String`	`INVALID_CLIENT_METADATA` The request contains invalid client metadata.
`static String`	`INVALID_CODE` The code provided is invalid.
`static String`	`INVALID_GRANT` The provided access grant is invalid, expired, or revoked (e.g.
`static String`	`INVALID_REQUEST` The request is missing a required parameter, includes an invalid parameter value, or is otherwise malformed.
`static String`	`INVALID_SCOPE` The requested scope is invalid, unknown, or malformed.
`static String`	`INVALID_TOKEN` The access token provided is expired, revoked, malformed, or invalid for other reasons.
`static String`	`LOGIN_REQUIRED` OpenID Connect login required error
`static String`	`METHOD_NOT_ALLOWED` The request is using the incorrect method.
`static String`	`NOT_FOUND` The request is for data which does not exist.
`static String`	`REDIRECT_TEMPORARY` OAuth 2
`static String`	`REDIRECT_URI_MISMATCH` The redirection URI provided does not match a pre-registered value.
`static String`	`SERVER_ERROR` The authorization server encountered an unexpected condition which prevented it from fulfilling the request.
`static String`	`TEMPORARILY_UNAVAILABLE` The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
`static String`	`UNAUTHORIZED_CLIENT` The client is not authorized to request an access token using this method.
`static String`	`UNKNOWN_ERROR` Handles all errors that don't stem from invalid requests -- e.g., perhaps errors resulting from databases that are down or logic errors in code.
`static String`	`UNSUPPORTED_AUTH_TYPE` The requested authentication type is not supported by the authorization server.
`static String`	`UNSUPPORTED_GRANT_TYPE` The provided access grant is invalid, expired, or revoked (e.g.
`static String`	`UNSUPPORTED_RESPONSE_TYPE` The authorization server does not support obtaining an access token using this method.

Constructor Summary

Constructors
Constructor and Description

Error()

Constructors
Constructor and Description
`Error()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ERROR
```
public static final String ERROR
```
    A single error code
    
    See Also:
    
    Constant Field Values
  - ERROR_DESCRIPTION
```
public static final String ERROR_DESCRIPTION
```
    OPTIONAL. A human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.
    
    See Also:
    
    Constant Field Values
  - ERROR_URI
```
public static final String ERROR_URI
```
    OPTIONAL. A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.
    
    See Also:
    
    Constant Field Values
  - INVALID_REQUEST
```
public static final String INVALID_REQUEST
```
    The request is missing a required parameter, includes an invalid parameter value, or is otherwise malformed.
    
    See Also:
    
    Constant Field Values
  - METHOD_NOT_ALLOWED
```
public static final String METHOD_NOT_ALLOWED
```
    The request is using the incorrect method.
    
    See Also:
    
    Constant Field Values
  - UNAUTHORIZED_CLIENT
```
public static final String UNAUTHORIZED_CLIENT
```
    The client is not authorized to request an access token using this method.
    
    See Also:
    
    Constant Field Values
  - ACCESS_DENIED
```
public static final String ACCESS_DENIED
```
    The resource owner or authorization server denied the request.
    
    See Also:
    
    Constant Field Values
  - UNSUPPORTED_RESPONSE_TYPE
```
public static final String UNSUPPORTED_RESPONSE_TYPE
```
    The authorization server does not support obtaining an access token using this method.
    
    See Also:
    
    Constant Field Values
  - INVALID_SCOPE
```
public static final String INVALID_SCOPE
```
    The requested scope is invalid, unknown, or malformed.
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR
```
public static final String SERVER_ERROR
```
    The authorization server encountered an unexpected condition which prevented it from fulfilling the request.
    
    See Also:
    
    Constant Field Values
  - TEMPORARILY_UNAVAILABLE
```
public static final String TEMPORARILY_UNAVAILABLE
```
    The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
    
    See Also:
    
    Constant Field Values
  - INVALID_TOKEN
```
public static final String INVALID_TOKEN
```
    The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
    
    See Also:
    
    Error Codes, Constant Field Values
  - INSUFFICIENT_SCOPE
```
public static final String INSUFFICIENT_SCOPE
```
    The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the "scope" attribute with the scope necessary to access the protected resource.
    
    See Also:
    
    Error Codes, Constant Field Values
  - EXPIRED_TOKEN
```
public static final String EXPIRED_TOKEN
```
    The access token provided has expired. Resource servers SHOULD only use this error code when the client is expected to be able to handle the response and request a new access token using the refresh token issued with the expired access token. The resource server MUST respond with the HTTP 401 (Unauthorized) status code.
    
    See Also:
    
    5.2.1. Error Codes, Constant Field Values
  - INVALID_CLIENT
```
public static final String INVALID_CLIENT
```
    The client identifier provided is invalid, the client failed to authenticate, the client did not include its credentials, provided multiple client credentials, or used unsupported credentials type.
    
    See Also:
    
    4.3.1. Error Codes, Constant Field Values
  - UNKNOWN_ERROR
```
public static final String UNKNOWN_ERROR
```
    Handles all errors that don't stem from invalid requests -- e.g., perhaps errors resulting from databases that are down or logic errors in code.
    
    See Also:
    
    4.3.1. Error Codes, Constant Field Values
  - INVALID_GRANT
```
public static final String INVALID_GRANT
```
    The provided access grant is invalid, expired, or revoked (e.g. invalid assertion, expired authorization token, bad end-user password credentials, or mismatching authorization code and redirection URI).
    
    See Also:
    
    4.3.1. Error Codes, Constant Field Values
  - UNSUPPORTED_GRANT_TYPE
```
public static final String UNSUPPORTED_GRANT_TYPE
```
    The provided access grant is invalid, expired, or revoked (e.g. invalid assertion, expired authorization token, bad end-user password credentials, or mismatching authorization code and redirection URI).
    
    See Also:
    
    4.3.1. Error Codes, Constant Field Values
  - INVALID_CODE
```
public static final String INVALID_CODE
```
    The code provided is invalid.
    
    See Also:
    
    4.3.1. Error Codes, Constant Field Values
  - REDIRECT_URI_MISMATCH
```
public static final String REDIRECT_URI_MISMATCH
```
    The redirection URI provided does not match a pre-registered value.
    
    See Also:
    
    3.2.1. Error Codes, Constant Field Values
  - UNSUPPORTED_AUTH_TYPE
```
public static final String UNSUPPORTED_AUTH_TYPE
```
    The requested authentication type is not supported by the authorization server.
    
    See Also:
    
    Constant Field Values
  - NOT_FOUND
```
public static final String NOT_FOUND
```
    The request is for data which does not exist.
    
    See Also:
    
    Constant Field Values
  - INVALID_CLIENT_METADATA
```
public static final String INVALID_CLIENT_METADATA
```
    The request contains invalid client metadata.
    
    See Also:
    
    Constant Field Values
  - BAD_REQUEST
```
public static final String BAD_REQUEST
```
    See Also:
    
    Constant Field Values
  - CONSENT_REQUIRED
```
public static final String CONSENT_REQUIRED
```
    OpenID Connect Consent error
    
    See Also:
    
    Constant Field Values
  - LOGIN_REQUIRED
```
public static final String LOGIN_REQUIRED
```
    OpenID Connect login required error
    
    See Also:
    
    Constant Field Values
  - INTERACTION_REQUIRED
```
public static final String INTERACTION_REQUIRED
```
    OpenID Connect interaction required error
    
    See Also:
    
    Constant Field Values
  - REDIRECT_TEMPORARY
```
public static final String REDIRECT_TEMPORARY
```
    OAuth 2
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Error
```
public Error()
```

Class OAuth2Constants.Error

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR

ERROR_DESCRIPTION

ERROR_URI

INVALID_REQUEST

METHOD_NOT_ALLOWED

UNAUTHORIZED_CLIENT

ACCESS_DENIED

UNSUPPORTED_RESPONSE_TYPE

INVALID_SCOPE

SERVER_ERROR

TEMPORARILY_UNAVAILABLE

INVALID_TOKEN

INSUFFICIENT_SCOPE

EXPIRED_TOKEN

INVALID_CLIENT

UNKNOWN_ERROR

INVALID_GRANT

UNSUPPORTED_GRANT_TYPE

INVALID_CODE

REDIRECT_URI_MISMATCH

UNSUPPORTED_AUTH_TYPE

NOT_FOUND

INVALID_CLIENT_METADATA

BAD_REQUEST

CONSENT_REQUIRED

LOGIN_REQUIRED

INTERACTION_REQUIRED

REDIRECT_TEMPORARY

Constructor Detail

Error