Skip to navigation
Sigma REST APIGrants

Create or update a grant

View as Markdown

Create a grant or update an existing grant on a document, folder, or workspace to a user or a team by ID.

Usage notes

  • This endpoint can only be used to escalate the level of access that a user has to a document. To remove or reduce a user’s access to a specific document, call /v2/grants/{grantId} to delete the existing grant and re-grant the desired level of access.
  • Retrieve the memberId by calling the /v2/members endpoint.
  • Retrieve the teamId by calling the /v2/teams endpoint.
  • Retrieve the inodeId by calling the /v2/files endpoint and using the id included in the response.
  • Retrieve the inodeId for a data model by calling the /v2/dataModels endpoint and using the dataModelId included in the response.
  • Optionally specify a tagId to associate the permission with a specific version tag of a workbook, dataset (deprecated), or database table. Retrieve the tagId by calling the /v2/tags endpoint and using the versionTagId included in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
granteeobjectRequired
permissionenumRequired
inodeIdstringRequired
tagIdstringOptional

Response

The response body.
grantIdstring
The unique identifier of the grant
inodeIdstring
The unique identifier of the inode
organizationIdstring
The unique identifier of the organization
memberIdstring or null
The unique identifier of the member
teamIdstring or null
The unique identifier of the team
permissionenum
The permission granted to the member
createdBystring
The identifier of the user who created this grant
updatedBystring
The identifier of the user or process that last updated this grant
createdAtdatetime
When the grant was created
updatedAtdatetime
When the grant was last updated
inodeTypeenum