> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Grant permissions on a workbook to users or teams POST https://api.sigmacomputing.com/v2/workbooks/{workbookId}/grants Content-Type: application/json You can use this endpoint to grant specific document permissions on a specific workbook to users or teams. ### Usage notes - Ensure the **workbookId** in the path is valid and that the user has rights to modify its permissions. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant. - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint. - Grant permissions on a specific version tag of a workbook by specifying the **tagId**. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response. ### Usage scenarios - **Team collaboration**: Granting edit permissions to a team for collaborative work on a project. - **External consultant**: Providing view access to an external consultant. ### Best practices - Validate user and team IDs before submitting them in a request to avoid errors. - Use the **tagId** to help manage and revoke grants systematically as project requirements change. Reference: https://help.sigmacomputing.com/reference/create-workbook-grant ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/workbooks/{workbookId}/grants: post: operationId: createWorkbookGrant summary: Grant permissions on a workbook to users or teams description: >- You can use this endpoint to grant specific document permissions on a specific workbook to users or teams. ### Usage notes - Ensure the **workbookId** in the path is valid and that the user has rights to modify its permissions. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant. - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint. - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint. - Grant permissions on a specific version tag of a workbook by specifying the **tagId**. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response. ### Usage scenarios - **Team collaboration**: Granting edit permissions to a team for collaborative work on a project. - **External consultant**: Providing view access to an external consultant. ### Best practices - Validate user and team IDs before submitting them in a request to avoid errors. - Use the **tagId** to help manage and revoke grants systematically as project requirements change. tags: - Workbooks parameters: - name: workbookId in: path required: true schema: type: string - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: >- #/components/schemas/workbooks_createWorkbookGrant_Response_200 requestBody: description: The request body. content: application/json: schema: type: object properties: grants: type: array items: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems required: - grants servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0: type: object properties: memberId: type: string required: - memberId description: The UUID of the member receiving the grant title: >- V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0 V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1: type: object properties: teamId: type: string required: - teamId description: The UUID of the team receiving the grant title: >- V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1 V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee: oneOf: - $ref: >- #/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0 - $ref: >- #/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1 title: >- V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission: type: string enum: - view - explore - edit description: Permission to grant for access to the workbook. title: >- V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems: type: object properties: grantee: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee permission: $ref: >- #/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission description: Permission to grant for access to the workbook. tagId: type: string required: - grantee - permission title: >- V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems workbooks_createWorkbookGrant_Response_200: type: object properties: {} title: workbooks_createWorkbookGrant_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json { "grants": [ { "grantee": { "memberId": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f" }, "permission": "view" }, { "grantee": { "memberId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a" }, "permission": "edit" }, { "grantee": { "memberId": "f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a" }, "permission": "explore" } ] } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/workbooks/workbookId/grants" payload = { "grants": [ { "grantee": { "memberId": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f" }, "permission": "view" }, { "grantee": { "memberId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a" }, "permission": "edit" }, { "grantee": { "memberId": "f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a" }, "permission": "explore" } ] } headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/workbooks/workbookId/grants'; const options = { method: 'POST', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{"grants":[{"grantee":{"memberId":"a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f"},"permission":"view"},{"grantee":{"memberId":"d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a"},"permission":"edit"},{"grantee":{"memberId":"f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a"},"permission":"explore"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/workbooks/workbookId/grants" payload := strings.NewReader("{\n \"grants\": [\n {\n \"grantee\": {\n \"memberId\": \"a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f\"\n },\n \"permission\": \"view\"\n },\n {\n \"grantee\": {\n \"memberId\": \"d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a\"\n },\n \"permission\": \"edit\"\n },\n {\n \"grantee\": {\n \"memberId\": \"f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a\"\n },\n \"permission\": \"explore\"\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/workbooks/workbookId/grants") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{\n \"grants\": [\n {\n \"grantee\": {\n \"memberId\": \"a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f\"\n },\n \"permission\": \"view\"\n },\n {\n \"grantee\": {\n \"memberId\": \"d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a\"\n },\n \"permission\": \"edit\"\n },\n {\n \"grantee\": {\n \"memberId\": \"f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a\"\n },\n \"permission\": \"explore\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.sigmacomputing.com/v2/workbooks/workbookId/grants") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{\n \"grants\": [\n {\n \"grantee\": {\n \"memberId\": \"a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f\"\n },\n \"permission\": \"view\"\n },\n {\n \"grantee\": {\n \"memberId\": \"d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a\"\n },\n \"permission\": \"edit\"\n },\n {\n \"grantee\": {\n \"memberId\": \"f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a\"\n },\n \"permission\": \"explore\"\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.sigmacomputing.com/v2/workbooks/workbookId/grants', [ 'body' => '{ "grants": [ { "grantee": { "memberId": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f" }, "permission": "view" }, { "grantee": { "memberId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a" }, "permission": "edit" }, { "grantee": { "memberId": "f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a" }, "permission": "explore" } ] }', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/workbooks/workbookId/grants"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"grants\": [\n {\n \"grantee\": {\n \"memberId\": \"a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f\"\n },\n \"permission\": \"view\"\n },\n {\n \"grantee\": {\n \"memberId\": \"d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a\"\n },\n \"permission\": \"edit\"\n },\n {\n \"grantee\": {\n \"memberId\": \"f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a\"\n },\n \"permission\": \"explore\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = ["grants": [ [ "grantee": ["memberId": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f"], "permission": "view" ], [ "grantee": ["memberId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a"], "permission": "edit" ], [ "grantee": ["memberId": "f1e2d3c4-b5a6-7d8e-9f0a-1b2c3d4e5f6a"], "permission": "explore" ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/workbooks/workbookId/grants")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```