AUauthlete
Client Management

Search Clients

Changed on

Search the clients in the requested service that match the condition provided in the q query parameter. Results are returned via cursor based iteration. To iterate through all clients without a search condition, use the /api/{serviceId}/client API instead.

get/api/{serviceId}/client/search

Request

  • Base URL
    https://us.authlete.com
  • URL
    https://us.authlete.com/api/{serviceId}/client/search
  • Auth
    HTTP bearer

Path parameters

serviceIdinteger required

The ID of the service to retrieve a list of clients from.

Query parameters

qstring

The search query. See the description of this API for the supported syntax and fields.

This parameter is required unless cursor is provided. When cursor is provided, this parameter is ignored and the search query stored in the cursor is used instead.

cursorstring

This should be set to the value of nextCursor from a previous call to this endpoint, which will retrieve the next set of clients matching the original search query. If this is not provided the search will start from the beginning.

limitinteger

The maximum amount of results to return from this request. This value will be clamped between 1 and the allowed maximum. The default will be used if no value is provided.

includeTotalCountboolean

Indicates whether the totalCount property should be calculated and included in the response, otherwise it will be unset.

Warning: Calculating the total count requires an additional query and reduces the performance and throughput of this API. Only set this to true when the total count is actually required, rather than on every request.

Response

limitinteger

The clamped requested limit of clients to return from the request.

nextCursorstring

If there are more matching entries to retrieve this value will be generated and returned. The next call to this endpoint should use this value as the cursor to continue to retrieve the remaining clients from the correct point. If there are no further matching clients, or the search pagination limit has been reached, this property will not be set.

totalCountinteger

The total number of clients in the service that match the search query. This doesn't mean the number of clients contained in the response. Only set when includeTotalCount is true in the request.

Example response

{
  "entities": [
    {
      "number": 1140735077,
      "serviceNumber": 715948317,
      "clientName": "My Test Client",
      "clientId": "1140735077",
      "clientSecret": "gXz97ISgLs4HuXwOZWch8GEmgL4YMvUJwu3er_kDVVGcA0UOhA9avLPbEmoeZdagi9yC_-tEiT2BdRyH9dbrQQ",
      "clientType": "PUBLIC",
      "redirectUris": [
        "https://example.com/callback"
      ],
      "responseTypes": [
        "CODE"
      ],
      "grantTypes": [
        "AUTHORIZATION_CODE"
      ]
    }
  ]
}

Changes