Oso Cloud · Schema

ListQuery

AuthorizationAccess ControlRBACReBACABACPermissionsPolicySecurityIdentity

Properties

Name	Type	Description
actor_type	string
actor_id	string
action	string
resource_type	string
context_facts	array
page_size	integer	Required. Page size for pagination. Must be at least 10,000. Results will be paginated and a `next_page_token` will be included in the response if more results are available. Ignored when `page_token`
page_token	string	Page token for fetching subsequent pages of results. Use the `next_page_token` from a previous response. When provided, `page_size` is ignored.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.osohq.com/schemas/ListQuery.json",
  "title": "ListQuery",
  "type": "object",
  "required": [
    "action",
    "actor_id",
    "actor_type",
    "resource_type",
    "page_size"
  ],
  "properties": {
    "actor_type": {
      "type": "string"
    },
    "actor_id": {
      "type": "string"
    },
    "action": {
      "type": "string"
    },
    "resource_type": {
      "type": "string"
    },
    "context_facts": {
      "default": [],
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Fact"
      }
    },
    "page_size": {
      "description": "Required. Page size for pagination. Must be at least 10,000. Results will be paginated and a `next_page_token` will be included in the response if more results are available. Ignored when `page_token` is provided, since the page size is determined by the original request.",
      "default": 10000,
      "type": "integer",
      "format": "uint",
      "minimum": 10000
    },
    "page_token": {
      "description": "Page token for fetching subsequent pages of results. Use the `next_page_token` from a previous response. When provided, `page_size` is ignored.",
      "default": null,
      "type": "string",
      "nullable": true
    }
  }
}