com.authlete.common.dto

Class IntrospectionRequest

java.lang.Object

com.authlete.common.dto.IntrospectionRequest

All Implemented Interfaces:

Serializable

public class IntrospectionRequest
extends Object
implements Serializable

Request to Authlete's /auth/introspection API.

token (REQUIRED)

An access token to introspect.

scopes (OPTIONAL)

Scopes that should be covered by the access token.

subject (OPTIONAL)

The subject that should be associated with the access token.

clientCertificate (OPTIONAL)

The certificate presented by the client, used to validate TLS client certificate bound access tokens. 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 request to the protected resource endpoint. See "OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)" for details.

htu (OPTIONAL)

The URL of the protected resource endpoint. 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
IntrospectionRequest()

Method Summary

Modifier and Type	Method and Description
String	getClientCertificate() Get the client certificate, used to validate binding against access tokens using the TLS client certificate confirmation method.
String	getDpop() Get the DPoP header presented by the client during the request to the resource server.
String	getHtm() Get the HTTP method of the request from the client to the protected resource endpoint.
String	getHtu() Get the URL of the protected resource endpoint.
String[]	getScopes() Get the scopes which are required to access the target protected resource.
String	getSubject() Get the subject (= end-user ID managed by the service implementation) which is required to access the target protected resource.
String	getToken() Get the access token.
IntrospectionRequest	setClientCertificate(String clientCertificate) Set the client certificate, used to validate binding against access tokens using the TLS client certificate confirmation method.
IntrospectionRequest	setDpop(String dpop) Set the DPoP header presented by the client during the request to the resource server.
IntrospectionRequest	setHtm(String htm) Set the HTTP method of the request from the client to the protected resource endpoint.
IntrospectionRequest	setHtu(String htu) Set the URL of the protected resource endpoint.
IntrospectionRequest	setScopes(String[] scopes) Set the scopes which are required to access the target protected resource.
IntrospectionRequest	setSubject(String subject) Set the subject (= end-user ID managed by the service implementation) which is required to access the target protected resource.
IntrospectionRequest	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

IntrospectionRequest

public IntrospectionRequest()

Method Detail

getToken

public String getToken()

Get the access token.

setToken

public IntrospectionRequest setToken(String token)

Set the access token which has been issued by Authlete.

getScopes

public String[] getScopes()

Get the scopes which are required to access the target protected resource.

setScopes

public IntrospectionRequest setScopes(String[] scopes)

Set the scopes which are required to access the target protected resource. If the array contains a scope which is not covered by the access token, Authlete's /auth/introspection API returns FORBIDDEN as the action and insufficent_scope as the error code.

Parameters:

scopes - Scopes required to access the target protected resource. If null is given, Authlete's /auth/introspection endpoint does not perform scope checking.

getSubject

public String getSubject()

Get the subject (= end-user ID managed by the service implementation) which is required to access the target protected resource.

setSubject

public IntrospectionRequest setSubject(String subject)

Set the subject (= end-user ID managed by the service implementation) which is required to access the target protected resource. If the specified subject is different from the one associated with the access token, Authlete's /auth/introspection API returns FORBIDDEN as the action and invalid_request as the error code.

Parameters:

subject - Subject (= end-user ID managed by the service implementation) which is required to access the protected resource. If null is given, Authlete's /auth/introspection endpoint does not perform subject checking.

getClientCertificate

public String getClientCertificate()

Get the client certificate, used to validate binding against access tokens using the TLS client certificate confirmation method.

Returns:

The certificate in PEM format.

Since:

2.14

setClientCertificate

public IntrospectionRequest setClientCertificate(String clientCertificate)

Set the client certificate, used to validate binding against access tokens using the TLS client certificate confirmation method.

Parameters:

clientCertificate - The certificate in PEM format.

Since:

2.14

getDpop

public String getDpop()

Get the DPoP header presented by the client during the request to the resource server. This header contains a signed JWT which includes the public key that is paired with the private key used to sign it.

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 IntrospectionRequest setDpop(String dpop)

Set the DPoP header presented by the client during the request to the resource server. This header contains a signed JWT which includes the public key that is paired with the private key used to sign it.

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 request from the client to the protected resource endpoint. This field is used to validate the DPoP header.

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 IntrospectionRequest setHtm(String htm)

Set the HTTP method of the request from the client to the protected resource endpoint. This field is used to validate the DPoP header.

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 protected resource endpoint. This field is used to validate the DPoP header.

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

Returns:

The URL of the protected resource endpoint.

Since:

2.70

setHtu

public IntrospectionRequest setHtu(String htu)

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

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

Parameters:

htu - The URL of the protected resource endpoint.

Returns:

this object.

Since:

2.70