Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Resource Grants

This endpoint allows you to Retrieve a list of resource grants with pagination and filter parameters.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available resource grants, not the number of resource grants resulting from the query string.

get/resourceGrants

Query parameters

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

resourceType'layout' | 'camera' | 'location' | 'account' | 'speaker' | 'multiCamera' required
Example:account

Filter to get the grants with the specified resource type

userId__instring[]

Filter to get the grants whose userId is on the provided list. The lookup is exact but case insensitive

resourceId__instring[]

Filter to get the grants whose resourceId is on the provided list. The lookup is exact but case insensitive

Response

OK

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "resourceType": "account",
      "createTimestamp": "2023-04-04T09:38:37.372Z",
      "options": {
        "expirationTimestamp": "2023-04-04T09:38:37.372Z"
      }
    }
  ]
}