Apps

Revoke an app grant

Revokes the app's tokens and consent. Requires grants.manage.

DELETE
/grants/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the app's grant.

Query parameters

revoke_keys?boolean

Also revoke every key the app minted, and every key those keys minted, but an owner's key (owner_key). Omitting it, or false, leaves them working.

Response body

About errors

Returns ok: true. The app's grant is revoked.

application/json
  1. response

Confirms that the request succeeded.

ok*true

Always true.

Value intrue
  • validation_error: the query has a parameter this endpoint doesn't take, or revoke_keys is neither true nor false, or is named more than once. Nothing is revoked.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • forbidden: the credential lacks grants.manage.
application/json
  1. response

An error response.

error*

What went wrong.

  • grant_not_found: the ID does not name an app grant.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X DELETE 'http://localhost:8600/grants/string'
About errors
{  "ok": true}