Authlete
Properties | List of all members
DeveloperAuthenticationCallbackResponse Class Reference

Developer authentication response from a service implementation to Authlete. More...

Properties

bool Authenticated [get, set]
 The result of developer authentication. When the pair of "id" and "password" contained in the developer authentication request are valid, true should be set to this property. Otherwise, if developer authentication failed, false should be set. More...
 
string Subject [get, set]
 The subject (= unique identifier) of the authenticated developer. More...
 
string DisplayName [get, set]
 The display name of the authenticated developer. More...
 

Detailed Description

Developer authentication response from a service implementation to Authlete.

Property Documentation

◆ Authenticated

bool Authenticated
getset

The result of developer authentication. When the pair of "id" and "password" contained in the developer authentication request are valid, true should be set to this property. Otherwise, if developer authentication failed, false should be set.

◆ DisplayName

string DisplayName
getset

The display name of the authenticated developer.

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

◆ Subject

string Subject
getset

The subject (= unique identifier) of the authenticated developer.

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 subject.

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: