Unkey · Schema

V2PermissionsListRolesRequestBody

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name Type Description
limit integer Maximum number of roles to return in a single response. Use smaller values for faster response times and better UI performance. Use larger values when you need to process many roles efficiently. Resul
cursor string Pagination cursor from a previous response to fetch the next page of roles. Include this when you need to retrieve additional roles beyond the first page. Each response containing more results will in
View JSON Schema on GitHub

JSON Schema

unkey-v2permissionslistrolesrequestbody-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2PermissionsListRolesRequestBody",
  "title": "V2PermissionsListRolesRequestBody",
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 100,
      "description": "Maximum number of roles to return in a single response.\nUse smaller values for faster response times and better UI performance.\nUse larger values when you need to process many roles efficiently.\nResults exceeding this limit will be paginated with a cursor for continuation.\n",
      "example": 50
    },
    "cursor": {
      "type": "string",
      "maxLength": 1024,
      "description": "Pagination cursor from a previous response to fetch the next page of roles.\nInclude this when you need to retrieve additional roles beyond the first page.\nEach response containing more results will include a cursor value that can be used here.\nLeave empty or omit this field to start from the beginning of the role list.\n",
      "example": "eyJrZXkiOiJyb2xlXzEyMzQifQ=="
    }
  },
  "additionalProperties": false
}