Apps

Narrow an app grant

Narrows an app's standing access. Requires grants.manage. Tokens, refresh chains and keys the app made that reach beyond the new access end, with pending codes; the rest keep working. The app may need to reconnect.

PATCH
/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.

Request body

application/json
  1. body
scopes*array<>

The complete resulting scope set, no wider than the current grant.

Itemsitems <= 1000
expected_scopes*array<string>

The complete scope set last read from the grant. A changed grant refuses the update.

Itemsitems <= 1000

Response body

About errors

Returns the app's narrowed access.

application/json
  1. response

The app's narrowed access.

scopes*array<string>

The resulting scope set.

revoked_keys*integer

How many keys the app made, or those keys made, Marfa revoked because they reached beyond the resulting scope set.

Range0 <= value
  • validation_error: the body has an invalid or unknown field.
  • missing_required_field: a required field is absent.
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, and details.required_scope names it, or the requested scopes widen access.
application/json
  1. response

An error response.

error*

What went wrong.

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

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

  • conflict: the grant's scopes changed; read them again before submitting.
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 PATCH 'http://localhost:8600/grants/string' \  -H 'Content-Type: application/json' \  -d '{  "scopes": [    "string"  ],  "expected_scopes": [    "string"  ]}'
About errors
{  "scopes": [    "core.note:read"  ],  "revoked_keys": 1}