Authlete
ClientListResponse Class Reference

Response from Authlete's /api/client/get/list API. More...

Inheritance diagram for ClientListResponse:
AuthorizedClientListResponse

Properties

int Start [get, set]
 The start index (inclusive) for the result set of the query. It is the value contained in the original request (= the value of the "start" request parameter), or the default value (0) if the original request did not contain the parameter. More...
 
int End [get, set]
 The end index (exclusive) for the result set of the query. It is the value contained in the original request (= the value of the "end" request parameter), or the defaul value defined in Authlete server if the original request did not contain the parameter. More...
 
string Developer [get, set]
 The unique identifier of the developer. It is the value contained in the original request (= the value of the "developer" request parameter), or null. In the case of null, it means that all the clients that belong to the service are targeted. More...
 
int TotalCount [get, set]
 The total count of client applications of either the entire service (in the case of developer=null) or the developer. More...
 
Client[] Clients [get, set]
 The list of client applications that match the query conditions. More...
 

Detailed Description

Response from Authlete's /api/client/get/list API.

Property Documentation

◆ Clients

Client [] Clients
getset

The list of client applications that match the query conditions.

◆ Developer

string Developer
getset

The unique identifier of the developer. It is the value contained in the original request (= the value of the "developer" request parameter), or null. In the case of null, it means that all the clients that belong to the service are targeted.

◆ End

int End
getset

The end index (exclusive) for the result set of the query. It is the value contained in the original request (= the value of the "end" request parameter), or the defaul value defined in Authlete server if the original request did not contain the parameter.

◆ Start

int Start
getset

The start index (inclusive) for the result set of the query. It is the value contained in the original request (= the value of the "start" request parameter), or the default value (0) if the original request did not contain the parameter.

◆ TotalCount

int TotalCount
getset

The total count of client applications of either the entire service (in the case of developer=null) or the developer.

The value of this property is not the size of the array returned from the Clients property. Instead, it is the total count of the client applications (of either the entire service or the developer) which exist in Authlete's database.


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