GET /clients – Retrieves a paginated list of client applications for a specific product.


Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

  • None

Path Parameters:

  • None

Query Parameters:

  • provider: The authentication provider (optional). Defaults to auth0-client if omitted. See ClientProvider.
  • product: The product identifier associated with the client (required). See ProductKey.
  • limit: The maximum number of clients to return in the response (optional).
  • next: The pagination token to retrieve the next set of results (optional).


Status Code Meaning When it Happens
400 Bad Request Missing or invalid fields in request body
401 Unauthorized Missing or invalid authentication token
404 Not Found Specified client does not exist
500 Internal Server Error Unexpected error
{
"error": "Detailed error message here"
}

GET /clients?product=exampleProduct&limit=10&next=paginationToken
GET /clients?product=exampleProduct&limit=10&provider=cognito-client
json
{
"data": [
{
"id": "clientId1",
"name": "name1",
"callbacks": ["string"],
// More fields may be present depending on the provider
},
{
"id": "clientId2",
"name": "name2",
"callbacks": ["string"],
// More fields may be present depending on the provider
}
],
"page": {
"limit": 10,
"next": "nextPaginationToken"
}
}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.