Cubicle

Grant access to a Box

PUT
/v1/boxes/{box}/grants/{user}

Gives a member of the Box's organization a grant on the Box, and returns 204 No Content. Owners and admins may grant any active member, themselves and service accounts included, with a sign-in session; API keys cannot use this route.

The member gets their guest account in the Box, at once if the Box is running, or when it next starts. Granting a member who already has an active grant changes nothing but applies their account again. A grant is what allows running commands, SSH, private-network access and the console; the owner or admin role alone does not. See Box grants.

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.

user*string

The member's user ID: a person's, or a service account's. List members shows them.

Formatuuid

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 member holds an active grant on the Box.

Example Request
curl -X PUT 'https://api.cubicle.sh/v1/boxes/acme%2Fjob-1/grants/2c4e6a8b-0d1f-4e3a-9b5c-7d9f1b3d5e7a'
Example Response
Empty