AUauthlete
Client Management

List Clients (Cursor Pagination)

Changed on

Retrieve the clients in the requested service via cursor based iteration.

get/api/{serviceId}/client

Request

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

Path parameters

serviceIdinteger required

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

Query parameters

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 available and receive the next available set. If this is not provided the list operation 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. For some large datasets this can be expensive and is not always required to calculate.

Response

limitinteger

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

nextCursorstring

If there are more 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 continue to retrieve the remaining clients from the correct point. If there are no further clients to list this property will not be set.

totalCountinteger

The total number of clients that belong to the service. This doesn't mean the number of clients contained in the response.

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