Cubicle

List a Box's grants

GET
/v1/boxes/{box}/grants

Returns every grant on the Box, revoked ones included, sorted by identity, as a bare array. Any active member of the Box's organization may list them with a sign-in session; API keys cannot use this route.

Each granted member has their own guest account in the Box (guestAccount). The Box has applied the latest access change for a member when appliedRevision equals desiredRevision. Box grants explains what a grant allows.

Authorization

session
headerAuthorizationBearer <token>

A sign-in session token (jvs_…) from the Dashboard, cubicle login or the device authorization flow.

Path Parameters

box*string

The Box's ID, ORG/NAME with the slash encoded as %2F, or a bare NAME, which ?org= narrows. See Box references.

Query Parameters

org?string

The organization's ID or name, to narrow a bare NAME in {box}. Ignored for an ID or ORG/NAME.

Response Body

The Box's grants.

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.cubicle.sh/v1/boxes/acme%2Fjob-1/grants'
Example Response
[  {    "userId": "2c4e6a8b-0d1f-4e3a-9b5c-7d9f1b3d5e7a",    "identity": "ada@example.com",    "status": "active",    "guestAccount": "jv_2c4e6a8b0d1f",    "desiredRevision": 2,    "appliedRevision": 2  }]