Data Set Grant

Get Data Set Grant

Gets the requested data set grant if the access tokens are valid and the user has access to the data set. Note that the id in the URI is the number at the end of the data set grant's uri, not the identifier field of the object.

get/dataSetGrants/{dataSetId}

Request

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

Path parameters

dataSetIdinteger required

ID of data set to return grant for

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.