> 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. # List grants for a workspace GET https://api.sigmacomputing.com/v2/workspaces/{workspaceId}/grants This endpoint retrieves a list of all permission grants associated with a specific workspace, identified by its workspaceId. ### Usage notes - Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint. - Optionally use the `page` and `limit` parameters to manage the size of the returned data and navigate through large sets of data. ### Usage scenarios - **Access control management**: Useful for administrators to review and manage who has what access to the workspace. - **Audit and compliance**: Assists in compliance checks and audits by providing a clear view of the permissions granted to different users and teams. ### Best practices - **Use pagination**: Especially important for workspaces with a large number of grants to ensure performance and usability. - **Regular review**: Regularly review and update the workspace grants to ensure they align with current organizational policies and user roles. Reference: https://help.sigmacomputing.com/reference/list-workspace-grants ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/workspaces/{workspaceId}/grants: get: operationId: listWorkspaceGrants summary: List grants for a workspace description: >- This endpoint retrieves a list of all permission grants associated with a specific workspace, identified by its workspaceId. ### Usage notes - Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint. - Optionally use the `page` and `limit` parameters to manage the size of the returned data and navigate through large sets of data. ### Usage scenarios - **Access control management**: Useful for administrators to review and manage who has what access to the workspace. - **Audit and compliance**: Assists in compliance checks and audits by providing a clear view of the permissions granted to different users and teams. ### Best practices - **Use pagination**: Especially important for workspaces with a large number of grants to ensure performance and usability. - **Regular review**: Regularly review and update the workspace grants to ensure they align with current organizational policies and user roles. tags: - Workspaces parameters: - name: workspaceId in: path required: true schema: type: string - name: page in: query required: false schema: type: string - name: limit in: query required: false schema: type: number format: double - 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/workspaces_listWorkspaceGrants_Response_200 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: V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0: type: string enum: - admin - annotate - update - usage - writeback description: 'Valid inode types: table, connection database, and connection schema.' title: >- V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0 V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1: type: string enum: - create - annotate - organize - explore - view - edit - apply description: >- Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**. title: >- V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1 V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2: type: string enum: - view - edit - apply description: 'Valid inode types: version tag.' title: >- V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2 V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission: oneOf: - $ref: >- #/components/schemas/V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0 - $ref: >- #/components/schemas/V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1 - $ref: >- #/components/schemas/V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2 description: The permission granted to the member title: >- V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: grantId: type: string description: The unique identifier of the grant inodeId: type: string description: The unique identifier of the inode organizationId: type: string description: The unique identifier of the organization memberId: type: - string - 'null' description: The unique identifier of the member teamId: type: - string - 'null' description: The unique identifier of the team permission: $ref: >- #/components/schemas/V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission description: The permission granted to the member createdBy: type: string description: The identifier of the user who created this grant updatedBy: type: string description: The identifier of the user or process that last updated this grant createdAt: type: string format: date-time description: When the grant was created updatedAt: type: string format: date-time description: When the grant was last updated required: - grantId - inodeId - organizationId - memberId - teamId - permission - createdBy - updatedBy - createdAt - updatedAt title: >- V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems workspaces_listWorkspaceGrants_Response_200: type: object properties: entries: type: array items: $ref: >- #/components/schemas/V2WorkspacesWorkspaceIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems nextPage: type: - string - 'null' total: type: number format: double hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: workspaces_listWorkspaceGrants_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Request** ```json {} ``` **Response** ```json { "entries": [ { "grantId": "a3f1c9d2-4b7e-4f8a-9c2d-1e2f3a4b5c6d", "inodeId": "7b9e2f1a-3c4d-4e5f-8a9b-0c1d2e3f4a5b", "organizationId": "org-9876543210", "memberId": "user-1234567890", "teamId": null, "permission": "edit", "createdBy": "admin-user-001", "updatedBy": "admin-user-002", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z" } ], "nextPage": null, "total": 1, "hasMore": false } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/workspaces/workspaceId/grants" payload = {} headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/workspaces/workspaceId/grants'; const options = { method: 'GET', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{}' }; 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/workspaces/workspaceId/grants" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", 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/workspaces/workspaceId/grants") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/workspaces/workspaceId/grants") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/workspaces/workspaceId/grants', [ 'body' => '{}', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/workspaces/workspaceId/grants"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/workspaces/workspaceId/grants")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ```