com.authlete.common.dto

Class StandardIntrospectionRequest

java.lang.Object

com.authlete.common.dto.StandardIntrospectionRequest

All Implemented Interfaces:

Serializable

public class StandardIntrospectionRequest
extends Object
implements Serializable

Request to Authlete's /api/auth/introspection/standard API. Note that the API and /api/auth/introspection API are different. /api/auth/introspection/standard API exists to help your authorization server provide its own introspection API which complies with RFC 7662 (OAuth 2.0 Token Introspection).

parameters (REQUIRED)

Request parameters which comply with the introspection request defined in "2.1. Introspection Request" in RFC 7662. The following is an example value of parameters.

token=pNj1h24a4geA_YHilxrshkRkxJDsyXBZWKp3hZ5ND7A&token_type_hint=access_token

The implementation of the introspection endpoint of your authorization server will receive an HTTP POST [RFC 7231] request with parameters in the "application/x-www-form-urlencoded" format. It is the entity body of the request that Authlete's /api/auth/introspection/standard API expects as the value of parameters.

withHiddenProperties (OPTIONAL)

Flag indicating whether to include hidden properties in the output.

Authlete has a mechanism whereby to associate arbitrary key-value pairs with an access token. Each key-value pair has a hidden attribute. By default, key-value pairs whose hidden attribute is true are not embedded in the standard introspection output.

If the withHiddenProperties request parameter is given and its value is true, /api/auth/introspection/standard API includes all the associated key-value pairs into the output regardless of the value of the hidden attribute.

Since:

2.7

Author:

Takahiko Kawasaki

See Also:

RFC 7662, OAuth 2.0 Token Introspection, StandardIntrospectionResponse, AuthleteApi.standardIntrospection(StandardIntrospectionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
StandardIntrospectionRequest()

Method Summary

Modifier and Type	Method and Description
String	getParameters() Get the value of parameters that represents the request parameters which the introspection endpoint of the authorization server received.
boolean	isWithHiddenProperties() Get the flag which indicates whether to include hidden properties associated with the token in the output.
StandardIntrospectionRequest	setParameters(String parameters) Set the value of parameters that represents the request parameters which the introspection endpoint of the authorization server received.
StandardIntrospectionRequest	setWithHiddenProperties(boolean with) Set the flag which indicates whether to include hidden properties associated with the token in the output.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardIntrospectionRequest

public StandardIntrospectionRequest()

Method Detail

getParameters

public String getParameters()

Get the value of parameters that represents the request parameters which the introspection endpoint of the authorization server received.

Returns:

Request parameters which comply with RFC 7662. For example, "token=pNj1h24a4geA_YHilxrshkRkxJDsyXBZWKp3hZ5ND7A".

setParameters

public StandardIntrospectionRequest setParameters(String parameters)

Set the value of parameters that represents the request parameters which the introspection endpoint of the authorization server received.

Parameters:

parameters - Request parameters which comply with RFC 7662. For example, "token=pNj1h24a4geA_YHilxrshkRkxJDsyXBZWKp3hZ5ND7A".

Returns:

this object.

isWithHiddenProperties

public boolean isWithHiddenProperties()

Get the flag which indicates whether to include hidden properties associated with the token in the output.

Authlete has a mechanism whereby to associate arbitrary key-value pairs with an access token. Each key-value pair has a hidden attribute. By default, key-value pairs whose hidden attribute is true are not embedded in the standard introspection output.

If the withHiddenProperties request parameter is given and its value is true, /api/auth/introspection/standard API includes all the associated key-value pairs into the output regardless of the value of the hidden attribute.

Returns:

true if hidden properties are included in the output.

Since:

2.83

setWithHiddenProperties

public StandardIntrospectionRequest setWithHiddenProperties(boolean with)

Set the flag which indicates whether to include hidden properties associated with the token in the output.

See the description of isWithHiddenProperties() for details.

Parameters:

with - true to include hidden properties in the output.

Returns:

this object.

Since:

2.83