List grants for a workspace

View as Markdown
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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workspaceIdstringRequired
Unique identifier of the workspace.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldoubleOptional
hasMorebooleanOptional

[Deprecated] Indicates whether more results are available.