1. Docs
  2. API Reference
  3. Remove a machine client's assignment

Remove a machine client's assignment

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

Takes one of the machine client's assignments away; an assignment held by anyone else reads as 404. Responds 204 No Content.

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
assignmentIdstring Required

Responses

Assignment removed

application/json

  • errorApiErrorBodyDto*

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/assignments/value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Assignment removed

(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
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
GETGet where a machine client holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy