Workbooks

Delete a workbook grant

This endpoint deletes a specific grant from a workbook. Deleting a grant revokes the permissions associated with it, ensuring that the specified users or teams no longer have the access rights previously granted.

Usage notes

  • workbookId: The identifier of the workbook from which the grant is to be deleted. Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • grantId: The identifier of the grant that needs to be removed. Retrieve the grantId by calling the /v2/grants endpoint with the workbookId as the inodeId.

Usage scenarios

  • Access revocation: Administrators can use this endpoint to manage and revoke access as team roles or project needs evolve.
  • Security compliance: Ensures that access to sensitive data within workbooks is tightly controlled and can be promptly adjusted in response to security policy changes or personnel updates.

Best practices

  • Always confirm the identities associated with both the workbook and grant before proceeding with deletion to avoid accidental revocations.
  • Log and audit all grant deletions to maintain records for security audits and compliance tracking.
delete/v2/workbooks/{workbookId}/grants/{grantId}

Request

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

Path parameters

workbookIdstring required

Unique identifier of the workbook.

grantIdstring required

Unique identifier of the grant.

Response

The response body.

WorkbooksDeleteWorkbookGrantResponse200 required

Changes

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