Data Set Grant

Create Data Set Grant

Creates a new data set grant for the specified data set. The requesting user must have access to the data set in order for it to succeed.

post/dataSetGrants

Request

  • Base URL
    https://data.lucid.app
  • URL
    https://data.lucid.app/dataSetGrants
  • Auth
    OAuth 2
    Authorization code: https://lucid.app/oauth2/authorize
    Token URL: https://api.lucid.co/oauth2/token scopes: data-service.admin

Request body

dataSetstring required

Link to the data set to grant access to

permissionTypestring required

Type of permission to grant

identifierstring required

The document id, account id, or user id matching the permission type

rolestring required

Available types are: 'edit' and 'view'

Example request

{
  "dataSet": "https://data.lucid.app/dataSets/8",
  "permissionType": "account",
  "identifier": "1234",
  "role": "edit"
}

Response

OK with Data Set Grant

uristring required

URI of the data set grant

dataSetstring required

Link to get the data set for the grant

permissionTypestring required

Type of permission granted

identifierstring required

The document id, account id, or user id matching the permission type

rolestring required

Available types are: 'edit' and 'view'

Example response

{
  "uri": "https://data.lucid.app/dataSetGrants/435",
  "dataSet": "https://data.lucid.app/dataSets/8",
  "permissionType": "account",
  "identifier": "1234",
  "role": "edit"
}

Changes

No recorded changes to this operation across all 1 revision of this API.