AuthenticationCallbackResponse Class Reference

Authentication response from a service implementation to Authlete. More...

Properties
bool	Authenticated [get, set]
	The authentication result. true if the end-user was authenticated successfully. Otherwise, false. More...
string	Subject [get, set]
	The subject (= unique identifier) of the authenticated end-user. More...
string	Claims [get, set]
	Claims of the authenticated end-user in JSON format. More...

Detailed Description

Authentication response from a service implementation to Authlete.

Property Documentation

Authenticated

bool Authenticated

getset

The authentication result. true if the end-user was authenticated successfully. Otherwise, false.

Claims

string Claims

getset

Claims of the authenticated end-user in JSON format.

For example, to embed "given_name" claim, "family_name" claim and "email" claim, the string should be formatted like the following.

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

See 5.1. Standard Claims of OpenID Connect Core 1.0 for further details about the format.

This property does not have to be set (1) when the end-user was not authenticated, (2) when the authentication request does not contain any claims, or (3) when the service implementation cannot or does not want to provide data for any of the requested claims.

Subject

string Subject

getset

The subject (= unique identifier) of the authenticated end-user.

When the end-user was authenticated successfully, the subject (= unique identifier) of the end-user should be set to this property.

The value of the "subject" does not always have to be equal to the value of the "id" in the authentication request. For example, "id" may be an email address but a service implementation may have generated and assigned a unique identifier such as 60504791 to the end-user who can be identified by the email address. In such a case, 60504791 should be set as this Subject property.

This property does not have to be set when the Authenticated property is false.

---

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

• Authlete/Dto/AuthenticationCallbackResponse.cs