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

Active/inactive OAuth client counts for the environment

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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

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

Requires capability oauth_clients.viewDeveloper Console

View OAuth clients. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Query Parameters

qstring Optional

Responses

application/json

  • dataActiveSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

ActiveSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/oauth-clients/summary?q=value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
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
 Was this page helpful?

Tell us how we can improve this guide.

Canopy