Authlete
Properties | List of all members
IntrospectionRequest Class Reference

Request to Authlete's /api/auth/introspection API. The API returns information about an access token. More...

Properties

string Token [get, set]
 An access token. More...
 
string[] Scopes [get, set]
 Scopes which are required to access the protected resource endpoint of the resource server. If the array contains one or more scopes which are not covered by the access token, Authlete's /api/auth/introspection API returns IntrospectionAction.FORBIDDEN as the "action" and sets "insufficient_scope" as the error code. If this property holds null, Authlete's /api/auth/introspection API does not check scopes of the access token. More...
 
string Subject [get, set]
 The subject (= unique identifier) of an end-user which is required to access the protected resource endpoint of the resource server. If the specified subject is different from the one associated with the access token, Authlete's /api/auth/introspection API returns IntrospectionAction.FORBIDDEN as the "action" and sets "invalid_request" as the error code. If this property holds null, Authlete's /api/auth/introspection API does not check the subject of the access token. More...
 
string ClientCertificate [get, set]
 The client certificate which the client application presented at the API of the resource server. More...
 
string Dpop [get, set]
 The DPoP header presented by the client during the request to the resource server. The header contains a signed JWT which includes the public key that is paired with the private key used to sign the JWT. More...
 
string Htm [get, set]
 The HTTP method of the request from the client to the protected resource endpoint. The property is used to validate the DPoP header. More...
 
string Htu [get, set]
 The URL of the protected resource endpoint. This property is used to validate the DPoP header. More...
 

Detailed Description

Request to Authlete's /api/auth/introspection API. The API returns information about an access token.

Property Documentation

◆ ClientCertificate

string ClientCertificate
getset

The client certificate which the client application presented at the API of the resource server.

If the access token which the client application presented is bound to a client certificate, the client application has to present the client certificate in addition to the access token when it accesses APIs.

Since version 1.0.9.

◆ Dpop

string Dpop
getset

The DPoP header presented by the client during the request to the resource server. 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.

Since version 1.4.0.

◆ Htm

string Htm
getset

The HTTP method of the request from the client to the protected resource endpoint. The property is used to validate the DPoP header.

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

Since version 1.4.0.

◆ Htu

string Htu
getset

The URL of the protected resource endpoint. This property is used to validate the DPoP header.

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

Since version 1.4.0.

◆ Scopes

string [] Scopes
getset

Scopes which are required to access the protected resource endpoint of the resource server. If the array contains one or more scopes which are not covered by the access token, Authlete's /api/auth/introspection API returns IntrospectionAction.FORBIDDEN as the "action" and sets "insufficient_scope" as the error code. If this property holds null, Authlete's /api/auth/introspection API does not check scopes of the access token.

◆ Subject

string Subject
getset

The subject (= unique identifier) of an end-user which is required to access the protected resource endpoint of the resource server. If the specified subject is different from the one associated with the access token, Authlete's /api/auth/introspection API returns IntrospectionAction.FORBIDDEN as the "action" and sets "invalid_request" as the error code. If this property holds null, Authlete's /api/auth/introspection API does not check the subject of the access token.

◆ Token

string Token
getset

An access token.

The documentation for this class was generated from the following file: