Skip to main content
Module

x/authlete_deno/mod.ts>ClientListResponse

Authlete Library for Deno
authlete/authlete-deno
Latest
class ClientListResponse
Re-export
import { ClientListResponse } from "https://deno.land/x/authlete_deno@v1.2.10/mod.ts";

Response from Authlete /client/get/list API.

Properties

optional
clients: Client[]

The list of clients that match the query conditions.

optional
developer: string

The developer specified in the query. It is the value contained in the original request (= the value of developer parameter). When the developer parameter is unset, it means that all the clients that belong to the service are targeted.

end: number

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

start: number

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

totalCount: number

The total count of client applications either of the service (when the developer property is unset) or of the developer (when it is set).

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