com.authlete.common.dto

Class UserInfoRequest

java.lang.Object

com.authlete.common.dto.UserInfoRequest

All Implemented Interfaces:

Serializable

public class UserInfoRequest
extends Object
implements Serializable

Request to Authlete's /auth/userinfo API.

token (REQUIRED)

An access token to get user information.

clientCertificate (OPTIONAL)

The client certificate from the MTLS of the userinfo request from the client application. See RFC 8705 (OAuth 2.0 Mutual-TLS Client Authentication and Certificate-Bound Access Tokens) for details.

dpop (OPTIONAL)

The value of the DPoP HTTP header. See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

htm (OPTIONAL)

The HTTP method of the userinfo request. In normal cases, the value should be either "GET" or "POST". See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

htu (OPTIONAL)

The URL of the userinfo endpoint. If omitted, the userInfoEndpoint property of Service is used as the default value. See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserInfoRequest()

Method Summary

Modifier and Type	Method and Description
String	getClientCertificate() Get the client certificate used in the TLS connection established between the client application and the userinfo endpoint.
String	getDpop() Get the DPoP header presented by the client during the request to the userinfo endpoint.
String	getHtm() Get the HTTP method of the userinfo request.
String	getHtu() Get the URL of the userinfo endpoint.
String	getToken() Get the access token which has come along with the userinfo request from the client application.
UserInfoRequest	setClientCertificate(String certificate) Set the client certificate used in the TLS connection established between the client application and the userinfo endpoint.
UserInfoRequest	setDpop(String dpop) Set the DPoP header presented by the client during the request to the userinfo endpoint.
UserInfoRequest	setHtm(String htm) Set the HTTP method of the userinfo request.
UserInfoRequest	setHtu(String htu) Set the URL of the userinfo endpoint.
UserInfoRequest	setToken(String token) Set the access token which has been issued by Authlete.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInfoRequest

public UserInfoRequest()

Method Detail

getToken

public String getToken()

Get the access token which has come along with the userinfo request from the client application.

setToken

public UserInfoRequest setToken(String token)

Set the access token which has been issued by Authlete. The access token is the one that has come along with the userinfo request from the client application.

getClientCertificate

public String getClientCertificate()

Get the client certificate used in the TLS connection established between the client application and the userinfo endpoint.

Returns:

The client certificate in PEM format.

setClientCertificate

public UserInfoRequest setClientCertificate(String certificate)

Set the client certificate used in the TLS connection established between the client application and the userinfo endpoint.

The value of this request parameter is referred to when the access token given to the userinfo endpoint was bound to a client certificate when it was issued. See "OAuth 2.0 Mutual TLS Client Authentication and Certificate-Bound Access Tokens" for details about the specification of certificate-bound access tokens.

Parameters:

certificate - The client certificate in PEM format.

Returns:

this object.

Since:

2.37

getDpop

public String getDpop()

Get the DPoP header presented by the client during the request to the userinfo endpoint. The header contains a signed JWT which includes the public key that is paired with the private key used to sign the JWT.

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Returns:

The DPoP header string.

Since:

2.70

setDpop

public UserInfoRequest setDpop(String dpop)

Set the DPoP header presented by the client during the request to the userinfo endpoint. The header contains a signed JWT which includes the public key that is paired with the private key used to sign the JWT.

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Parameters:

dpop - The DPoP header string.

Returns:

this object.

Since:

2.70

getHtm

public String getHtm()

Get the HTTP method of the userinfo request. This field is used to validate the DPoP header.

In normal cases, the value is either "GET" or "POST".

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Returns:

The HTTP method as a string. For example, "GET".

Since:

2.70

setHtm

public UserInfoRequest setHtm(String htm)

Set the HTTP method of the userinfo request. This field is used to validate the DPoP header.

In normal cases, the value is either "GET" or "POST".

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Parameters:

htm - The HTTP method as a string. For example, "GET".

Returns:

this object.

Since:

2.70

getHtu

public String getHtu()

Get the URL of the userinfo endpoint. This field is used to validate the DPoP header.

If this parameter is omitted, the userInfoEndpoint property of the Service is used as the default value.

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Returns:

The URL of the userinfo endpoint.

Since:

2.70

setHtu

public UserInfoRequest setHtu(String htu)

Set the URL of the userinfo endpoint. This field is used to validate the DPoP header.

If this parameter is omitted, the userInfoEndpoint property of the Service is used as the default value.

See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

Parameters:

htu - The URL of the userinfo endpoint.

Returns:

this object.

Since:

2.70