Create a grant

POST

/v1/workspaces/{workspaceId}/grants

curl --request POST \
  --url https://shareout.site/v1/workspaces/example/grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subject_type": "sharee", "subject_id": "example", "resource_type": "folder", "resource_id": "example", "capability": "view" }'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Request Body ^required

Media type application/json

object

subject_type

required

string

Allowed values: sharee external_user

subject_id

required

string

resource_type

required

string

Allowed values: folder artifact file

resource_id

required

string

capability

required

string

Allowed values: view comment create edit

Responses

201

Created

Media type application/json

object

id

string

subject_type

string

Allowed values: sharee external_user

subject_id

string

resource_type

string

Allowed values: folder artifact file

resource_id

string

capability

string

Allowed values: view comment create edit

Example

{
  "subject_type": "sharee",
  "resource_type": "folder",
  "capability": "view"
}

400

Invalid request

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}

403

Access denied

Media type application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

Example

{
  "success": false
}