Revoke a pending enrollment

View .md OpenAPI spec Open in Claude Open in ChatGPT

Deprecated

DELETE

/v1/enrollments/{enrollment}

const url = 'https://app.caprid.com/v1/enrollments/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://app.caprid.com/v1/enrollments/example \
  --header 'Authorization: Bearer <token>'

DELETE /v1/organizations/{id}/enrollments/{enrollment} for the API key’s Organization.

Authorizations

Parameters

Path Parameters

enrollment

required

string

Responses

204

Revoked.

400

Sent with a session, which may belong to several Organizations. Use the route the message names instead. This route also returns 400 for anything that route would refuse with 400.

application/json

object

error

required

string

Example

{
  "error": "this route is for API keys; use /v1/organizations/{id}/api-keys"
}

401

No valid credential. Missing, expired and revoked credentials all get the same response, and so does an API key whose trial has lapsed. An Agent token from before a claim gets a 401 too, once the claim has made the trial a person’s, with a message saying to get a new token.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}

Headers

WWW-Authenticate

string

Example

Bearer realm="switchboard"

403

Sent with an API key limited to some Namespaces, to a Namespace outside its limit, or to a route that acts on the Organization as a whole. A limited key can never create API keys.

application/json

object

error

required

string

Example

{
  "error": "this API key is limited to the Namespaces acme-staging, and acme isn't one of them"
}

404

No such thing, or not yours. Another customer’s Organization or Namespace is a 404 too, so nobody can tell which ones exist.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}