Skip to main content

getClientsInfo

PageableClientInfoResponse getClientsInfo(limit, last_client_id, last_created_on)

GET /api/2.0/oauth2/clients/info

List client info

Retrieves a paginated list of information for all clients, each in the same consent-facing form as the single-client info read. An administrator sees every client of the tenant, a plain user only the clients they created. Paging is keyset-based: limit sets the page size, and last_client_id and last_created_on are carried over from the previous page. Unlike the full client listing, limit has no default here - it has to be supplied on every call and has to lie between 1 and 50, and a missing or out-of-range value is rejected with 400.

Parameters​

NameInTypeDescriptionNotes
limitqueryInteger (int32)How many entries to return, between 1 and 50. It has no default and has to be sent on every call.[required] [example: 30] [min: 1] [max: 50]
last_client_idqueryStringID of the last retrieved client[optional] [example: 6c7cf17b-1bd3-47d5-94c6-be2d3570e168]
last_created_onqueryDate (date-time)Date of the last retrieved client[optional] [example: 2024-04-04T12:00:00Z]

Responses​

Status codeDescriptionTypeResponse headers
200Successfully retrieved clients infoPageableClientInfoResponse-
400The limit parameter is missing, is outside the range 1-50, or last_created_on cannot be parsed as a date-timeProblemDetail-
403Insufficient permissions to list client informationProblemDetail-
406The Accept header does not allow application/jsonProblemDetail-
429Too many requests - rate limit exceededProblemDetail-
500Internal server error occurredProblemDetail-
405The HTTP method is not allowed for this pathProblemDetail-

Return type​

PageableClientInfoResponse

Authorization​

x-signature

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json