List grants

View as MarkdownOpen in Claude
List all grants for a given object. ### Usage notes You can specify one of the following: - A user by userId. Retrieve the **userId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response. - A team by teamId. Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint. - A document (such as a workbook, report, data model, or dataset (deprecated)), folder, or workspace by inodeId. - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response. - Retrieve the **inodeId** for a data model by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and using the `dataModelId` included in the response. ### Usage scenarios - **Manage inherited permissions**: Identify files and folders that have permissions directly granted to them. - **Review long-lived permissions**: Audit permissions granted more than a year ago and determine if they are still needed.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional
limitdoubleOptional
inodeIdstringOptional
teamIdstringOptional
userIdstringOptional
directGrantsOnlybooleanOptional

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldouble
Total number of results. Useful to determine if there is a need to paginate.
hasMoreboolean

[Deprecated] Indicates whether more results are available.