com.nimbusds.openid.connect.sdk
Class UserInfoRequest

java.lang.Object
  com.nimbusds.oauth2.sdk.ProtectedResourceRequest
      com.nimbusds.openid.connect.sdk.UserInfoRequest

All Implemented Interfaces:

Message, Request

@Immutable
public final class UserInfoRequest
extends ProtectedResourceRequest

UserInfo request. Used to retrieve the consented claims about the end-user. This class is immutable.

Example HTTP GET request:

 GET /userinfo?schema=openid HTTP/1.1
 Host: server.example.com
 Authorization: Bearer mF_9.B5f-4.1JqM
 

Example HTTP POST request:

 POST /userinfo HTTP/1.1
 Host: server.example.com
 Content-Type: application/x-www-form-urlencoded

 schema=openid&access_token=mF_9.B5f-4.1JqM
 

Related specifications:

• OpenID Connect Messages 1.0, section 2.3.1.
• OpenID Connect Standard 1.0, section 4.1.
• OAuth 2.0 Bearer Token Usage (RFC6750), section 2.

Author:

Vladimir Dzhuvinov

Constructor Summary

UserInfoRequest(BearerAccessToken accessToken)
Creates a new UserInfo HTTP GET request.

UserInfoRequest(HTTPRequest.Method httpMethod, BearerAccessToken accessToken)
Creates a new UserInfo request.

Method Summary

HTTPRequest.Method	getMethod() Gets the HTTP method for this UserInfo request.
static UserInfoRequest	parse(HTTPRequest httpRequest) Parses the specified HTTP request for a UserInfo request.
HTTPRequest	toHTTPRequest(URL url) Returns the matching HTTP request.

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

getAccessToken

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInfoRequest

public UserInfoRequest(BearerAccessToken accessToken)

Creates a new UserInfo HTTP GET request.

Parameters:

accessToken - An OAuth 2.0 Bearer access token for the request. Must not be null.

UserInfoRequest

public UserInfoRequest(HTTPRequest.Method httpMethod,
                       BearerAccessToken accessToken)

Creates a new UserInfo request.

Parameters:

httpMethod - The HTTP method. Must be HTTP GET or POST and not null.

accessToken - An OAuth 2.0 Bearer access token for the request. Must not be null.

Method Detail

getMethod

public HTTPRequest.Method getMethod()

Gets the HTTP method for this UserInfo request.

Returns:

The HTTP method.

toHTTPRequest

public HTTPRequest toHTTPRequest(URL url)
                          throws SerializeException

Description copied from interface: Request

Returns the matching HTTP request.

Parameters:

url - The URL of the HTTP endpoint for which the request is intended. Must not be null.

Returns:

The HTTP request.

Throws:

SerializeException - If the request message couldn't be serialised to an HTTP request.

parse

public static UserInfoRequest parse(HTTPRequest httpRequest)
                             throws ParseException

Parses the specified HTTP request for a UserInfo request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The UserInfo request.

Throws:

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