Grants

Create or update a grant

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.
post/v2/grants

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

inodeIdstring required
tagIdstring

Response

The response body.

grantIdstring required

The unique identifier of the grant

inodeIdstring required

The unique identifier of the inode

organizationIdstring required

The unique identifier of the organization

memberIdstring nullable required

The unique identifier of the member

teamIdstring nullable required

The unique identifier of the team

createdBystring required

The identifier of the user who created this grant

updatedBystring required

The identifier of the user or process that last updated this grant

createdAtstring date-time required

When the grant was created

updatedAtstring date-time required

When the grant was last updated

inodeType'folder' | 'customFunction' | 'symlink' | 'versionTag' | 'worksheet' | 'block' | 'dashboard' | 'report' | 'table' | 'semanticView' | 'metricView' | 'scope' | 'sql' | 'workbook' | 'template' | 'dataset' | 'datafile' | 'storedProcedure' | 'apiConnector' | 'apiConnectorAuth' | 'mcpConnector' | 'warehouseAgent' | 'agentSkill' | 'tlsProfile' | 'schedule' | 'application' | 'appBranch' required

Changes

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