Package com.nimbusds.oauth2.sdk

Class PushedAuthorizationRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.AbstractOptionallyAuthenticatedRequest

com.nimbusds.oauth2.sdk.PushedAuthorizationRequest

All Implemented Interfaces:

Message, Request

@Immutable
public class PushedAuthorizationRequest
extends AbstractOptionallyAuthenticatedRequest

Pushed authorisation request (PAR).

Example HTTP request:

 POST /as/par HTTP/1.1
 Host: as.example.com
 Content-Type: application/x-www-form-urlencoded
 Authorization: Basic czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3

 response_type=code
 &client_id=s6BhdRkqt3
 &state=af0ifjsldkj
 &redirect_uri=https%3A%2F%2Fclient.example.org%2Fcb
 

Related specifications:

• OAuth 2.0 Pushed Authorization Requests (RFC 9126)

Constructor Summary

Constructors

Constructor	Description
PushedAuthorizationRequest(URI endpoint, ClientAuthentication clientAuth, AuthorizationRequest authzRequest)	Creates a new authenticated pushed authorisation request for a confidential client.
PushedAuthorizationRequest(URI endpoint, AuthorizationRequest authzRequest)	Creates a new pushed authorisation request for a public client.

Method Summary

Modifier and Type	Method	Description
AuthorizationRequest	getAuthorizationRequest()	Returns the pushed authorisation request.
static PushedAuthorizationRequest	parse(HTTPRequest httpRequest)	Parses a pushed authorisation request from the specified HTTP request.
HTTPRequest	toHTTPRequest()	Returns the matching HTTP request.

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractOptionallyAuthenticatedRequest

getClientAuthentication

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest

getEndpointURI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PushedAuthorizationRequest

public PushedAuthorizationRequest(URI endpoint,
 ClientAuthentication clientAuth,
 AuthorizationRequest authzRequest)

Creates a new authenticated pushed authorisation request for a confidential client.

Parameters:

endpoint - The URI of the PAR endpoint. May be null if the toHTTPRequest() method is not going to be used.

clientAuth - The client authentication. Must not be null.

authzRequest - The authorisation request. Must not be null.

PushedAuthorizationRequest

public PushedAuthorizationRequest(URI endpoint,
 AuthorizationRequest authzRequest)

Creates a new pushed authorisation request for a public client.

Parameters:

endpoint - The URI of the PAR endpoint. May be null if the toHTTPRequest() method is not going to be used.

authzRequest - The authorisation request. Must not be null.

Method Details

getAuthorizationRequest

public AuthorizationRequest getAuthorizationRequest()

Returns the pushed authorisation request.

Returns:

The pushed authorisation request.

toHTTPRequest

public HTTPRequest toHTTPRequest()

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

parse

public static PushedAuthorizationRequest parse(HTTPRequest httpRequest)
                                        throws ParseException

Parses a pushed authorisation request from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The pushed authorisation request.

Throws:

ParseException - If the HTTP request couldn't be parsed to a pushed authorisation request.