Authlete
Properties | List of all members
UserInfoRequest Class Reference

Request to Authlete's /api/auth/userinfo API. More...

Properties

string Token [get, set]
 The access token that the userinfo endpoint implementation received from the client application. More...
 
string ClientCertificate [get, set]
 The client certificate used in the TLS connection established between the client application and the userinfo endpoint in PEM format. More...
 
string Dpop [get, 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. More...
 
string Htm [get, set]
 The HTTP method of the userinfo request. This property is used to validate the DPoP header. More...
 
string Htu [get, set]
 The URL of the userinfo endpoint. This property is used to validate the DPoP header. More...
 

Detailed Description

Request to Authlete's /api/auth/userinfo API.

Property Documentation

◆ ClientCertificate

string ClientCertificate
getset

The client certificate used in the TLS connection established between the client application and the userinfo endpoint in PEM format.

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.

Since version 1.3.0.

◆ Dpop

string Dpop
getset

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.

Since version 1.4.0.

◆ Htm

string Htm
getset

The HTTP method of the userinfo request. This property 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.

Since version 1.4.0.

◆ Htu

string Htu
getset

The URL of the userinfo endpoint. This property 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.

Since version 1.4.0.

◆ Token

string Token
getset

The access token that the userinfo endpoint implementation received from the client application.

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