ErrorResponse, Message, Response, AuthenticationResponse@Immutable public class AuthenticationErrorResponse extends AuthorizationErrorResponse implements AuthenticationResponse
access_denied. For a complete list see OAuth 2.0 (RFC 6749),
sections 4.1.2.1 and 4.2.2.1, OpenID Connect Core 1.0 section 3.1.2.6.
If the authorisation request fails due to a missing, invalid, or
mismatching redirect_uri, or if the client_id is missing or
invalid, a response must not be sent back to the requesting
client. Instead, the OpenID provider should simply display the error to the
end-user.
Standard errors:
Example HTTP response:
HTTP/1.1 302 Found
Location: https://client.example.org/cb?
error=invalid_request
&error_description=the%20request%20is%20not%20valid%20or%20malformed
&state=af0ifjsldkj
Related specifications:
| Constructor | Description |
|---|---|
AuthenticationErrorResponse(URI redirectURI,
com.nimbusds.jwt.JWT jwtResponse,
ResponseMode rm) |
Creates a new JSON Web Token (JWT) secured OpenID Connect
authentication error response.
|
AuthenticationErrorResponse(URI redirectURI,
ErrorObject error,
State state,
ResponseMode rm) |
Creates a new OpenID Connect authentication error response.
|
| Modifier and Type | Method | Description |
|---|---|---|
static Set<ErrorObject> |
getStandardErrors() |
Gets the standard errors for an OpenID Connect authentication error
response.
|
static AuthenticationErrorResponse |
parse(HTTPRequest httpRequest) |
Parses an OpenID Connect authentication error response from the
specified HTTP request at the client redirection (callback) URI.
|
static AuthenticationErrorResponse |
parse(HTTPResponse httpResponse) |
Parses an OpenID Connect authentication error response from the
specified initial HTTP 302 redirect response generated at the
authorisation endpoint.
|
static AuthenticationErrorResponse |
parse(URI uri) |
Parses an OpenID Connect authentication error response.
|
static AuthenticationErrorResponse |
parse(URI redirectURI,
Map<String,List<String>> params) |
Parses an OpenID Connect authentication error response.
|
AuthenticationErrorResponse |
toErrorResponse() |
Casts this response to an authorisation error response.
|
AuthenticationSuccessResponse |
toSuccessResponse() |
Casts this response to an authorisation success response.
|
getRedirectionURI, getStategetErrorObject, impliedResponseMode, indicatesSuccess, toParametersgetJWTResponse, getRedirectionURI, getResponseMode, getState, parse, parse, parse, parse, parseResponseParameters, parseResponseParameters, toHTTPRequest, toHTTPResponse, toURIclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitindicatesSuccess, toHTTPResponsepublic AuthenticationErrorResponse(URI redirectURI, ErrorObject error, State state, ResponseMode rm)
redirectURI - The base redirection URI. Must not be
null.error - The error. Should match one of the
standard errors for an
OpenID Connect authentication error response.
Must not be null.state - The state, null if not requested.rm - The implied response mode, null if
unknown.public AuthenticationErrorResponse(URI redirectURI, com.nimbusds.jwt.JWT jwtResponse, ResponseMode rm)
redirectURI - The base redirection URI. Must not be
null.jwtResponse - The JWT-secured response. Must not be
null.rm - The implied response mode, null if
unknown.public static Set<ErrorObject> getStandardErrors()
public AuthenticationSuccessResponse toSuccessResponse()
AuthorizationResponsetoSuccessResponse in interface AuthenticationResponsetoSuccessResponse in class AuthorizationResponsepublic AuthenticationErrorResponse toErrorResponse()
AuthorizationResponsetoErrorResponse in interface AuthenticationResponsetoErrorResponse in class AuthorizationResponsepublic static AuthenticationErrorResponse parse(URI redirectURI, Map<String,List<String>> params) throws ParseException
redirectURI - The base redirection URI. Must not be
null.params - The response parameters to parse. Must not be
null.ParseException - If the parameters couldn't be parsed to an
OpenID Connect authentication error response.public static AuthenticationErrorResponse parse(URI uri) throws ParseException
Use a relative URI if the host, port and path details are not known:
URI relUrl = new URI("https:///?error=invalid_request");
Example URI:
https://client.example.com/cb? error=invalid_request &error_description=the%20request%20is%20not%20valid%20or%20malformed &state=af0ifjsldkj
uri - The URI to parse. Can be absolute or relative, with a
fragment or query string containing the authorisation
response parameters. Must not be null.ParseException - If the URI couldn't be parsed to an OpenID
Connect authentication error response.public static AuthenticationErrorResponse parse(HTTPResponse httpResponse) throws ParseException
Example HTTP response:
HTTP/1.1 302 Found Location: https://client.example.com/cb?error=invalid_request&state=af0ifjsldkj
httpResponse - The HTTP response to parse. Must not be
null.ParseException - If the HTTP response couldn't be parsed to an
OpenID Connect authentication error response.public static AuthenticationErrorResponse parse(HTTPRequest httpRequest) throws ParseException
query, fragment and form_post
response modes.
Example HTTP request (authorisation success):
GET /cb?error=invalid_request&state=af0ifjsldkj HTTP/1.1 Host: client.example.com
httpRequest - The HTTP request to parse. Must not be
null.ParseException - If the HTTP request couldn't be parsed to an
OpenID Connect authentication error response.parse(HTTPResponse)Copyright © 2018 Connect2id Ltd.. All rights reserved.