Authlete
GrantedScopesGetResponse Class Reference

Response from Authlete's /api/client/granted_scopes/get/{clientId} API. More...

Inheritance diagram for GrantedScopesGetResponse:
ApiResponse

Properties

long ServiceApiKey [get, set]
 The API key of the service. More...
 
long ClientId [get, set]
 The client ID. More...
 
string Subject [get, set]
 The subject (= unique identifier) of the end-user who has granted authorization to the client application. More...
 
string[] LatestGrantedScopes [get, set]
 The scopes granted to the client application by the last authorization process by the end-user (who is identified by the subject). More...
 
string[] MergedGrantedScopes [get, set]
 The scopes granted to the client application by all the past authorization processes. Note that revoked scopes are not included. More...
 
long ModifiedAt [get, set]
 The timestamp in milliseconds since the Unix epoch (1970-Jan-1) at which the record was modified. More...
 
- Properties inherited from ApiResponse
string ResultCode [get, set]
 The code of the result of an Authlete API call. For example, "A004001". More...
 
string ResultMessage [get, set]
 The message of the result of an Authlete API call. For example, "[A001202] /client/get/list, Authorization header is missing." More...
 

Detailed Description

Response from Authlete's /api/client/granted_scopes/get/{clientId} API.

Property Documentation

◆ ClientId

long ClientId
getset

The client ID.

◆ LatestGrantedScopes

string [] LatestGrantedScopes
getset

The scopes granted to the client application by the last authorization process by the end-user (who is identified by the subject).

null means that there is no record about granted scopes. An empty array means that there exists a record about granted scopes but no scope has been granted to the client application. If the returned array holds some elements, they are the scopes granted to the client application by the last authorization process.

◆ MergedGrantedScopes

string [] MergedGrantedScopes
getset

The scopes granted to the client application by all the past authorization processes. Note that revoked scopes are not included.

◆ ModifiedAt

long ModifiedAt
getset

The timestamp in milliseconds since the Unix epoch (1970-Jan-1) at which the record was modified.

◆ ServiceApiKey

long ServiceApiKey
getset

The API key of the service.

◆ Subject

string Subject
getset

The subject (= unique identifier) of the end-user who has granted authorization to the client application.


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