UserInfoIssueRequest Class Reference

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

Properties
string	Token [get, set]
	The access token contained in the userinfo request from the client application to the userinfo endpoint. More...
string	Claims [get, set]
	Claims of the subject in JSON format. This request parameter is optional. More...
string	Sub [get, set]
	The value of the "sub" claim. This request parameter is optional. More...

Detailed Description

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

Property Documentation

Claims

string Claims

getset

Claims of the subject in JSON format. This request parameter is optional.

The implementation of your service is required to retrieve claims of the subject (= information about the end-user) from its database and format them into JSON.

For example, if "given_name" claim, "family_name" claim and "email" claim are requested, the implementation should generate a JSON object like the following, and then set its string representation to this Claims property.

{
  "given_name": "Takahiko",
  "family_name": "Kawasaki",
  "email": "takahiko.kawasaki@example.com"
}

See 5.1. Standard Claims" of <a href="https://openid.net/specs/openid-connect-core-1_0.html">OpenID Connect Core 1.0 for further details about the format.

Sub

string Sub

getset

The value of the "sub" claim. This request parameter is optional.

If this property holds a non-empty value, it is used as the value of the "sub" claim. Otherwise, the value of the subject associated with the access token is used.

Token

string Token

getset

The access token contained in the userinfo request from the client application to the userinfo endpoint.

---

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

• Authlete/Dto/UserInfoIssueRequest.cs