1. Docs
  2. API Reference
  3. Active/inactive OAuth client counts for the environment

Active/inactive OAuth client counts for the environment

GET/api/v1/oauth-clients/summary

Returns Environment-wide active and inactive OAuth client counts (not just the current page), optionally narrowed by the same q name filter the list endpoint uses. Drives the client stat card.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Query Parameters

qstring Optional

Responses

application/json

  • dataActiveSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

ActiveSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/oauth-clients/summary?q=value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "active_count": 0,
    "inactive_count": 0
  }
}
 Related endpoints
GETList OAuth clients for Application
POSTRegister a new OAuth client
GETGet OAuth client details
PATCHUpdate OAuth client
DELETEDelete OAuth client
POSTRotate an OAuth client's secret
GETList a machine client's role assignments
POSTAssign a role to a machine client at a node
PATCHChange a machine client's assignment
DELETERemove a machine client's assignment
GETGet where a machine client holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy