1. Docs
  2. API Reference
  3. Rotate an OAuth client's secret

Rotate an OAuth client's secret

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/oauth-clients/{id}/rotate-secret

Rotates the OAuth client's client_secret, generating and hashing a new secret. The replaced secret keeps working for 24 hours (previous_secret_expires_at says until when) so the systems using it can move over; send expire_previous: "now" to stop it at once, for a secret that has leaked. Rotating again inside the overlap replaces the secret still in its overlap. The new raw secret is returned in this response only and cannot be retrieved again. Returns 404 when the client is not found in the current Environment.

Authentication

Bearer TokenAuthorization

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

Requires capability oauth_clients.manageDeveloper Console

Create, edit, rotate, and delete OAuth clients. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

idstring Required

Request body

application/json

expire_previousenum Optional

`window` (the default) keeps the replaced secret working for 24 hours so the systems using it can move to the new one. `now` stops it the moment the rotation lands, for a secret that has leaked.

one of "now" · "window"

Responses

application/json

  • dataOAuthClientSecretRotatedResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

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

OAuthClientSecretRotatedResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/oauth-clients/value/rotate-secret" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expire_previous": "now"
  }'
Response
{
  "data": {
    "client_id": "string",
    "client_secret": "string",
    "previous_secret_expires_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList OAuth clients for Application
POSTRegister a new OAuth client
GETActive/inactive OAuth client counts for the environment
GETGet OAuth client details
PATCHUpdate OAuth client
DELETEDelete OAuth client
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
 Was this page helpful?

Tell us how we can improve this guide.

Canopy