1. Docs
  2. API Reference
  3. Delete OAuth client

Delete OAuth client

DELETE/api/v1/oauth-clients/{id}

Deletes an OAuth client from the current Environment by id. Responds 204 No Content on success, or 404 when the client is not found in this Environment.

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.

Path Parameters

idstring Required

Responses

OAuth client deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/oauth-clients/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 OAuth client deleted

(empty body)
 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
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