Resource Restrictions

List resource restrictions the caller is permitted to manage.

Changed on

List active resource restrictions the authenticated user is permitted to manage. A restriction is returned only if the caller can manage it — i.e. an account/org admin (via admin escalation), a holder of the correct permissions in the parent resource or a holder of the correct permissions granted directly on the resource.

Results are paginated; use limit and cursor for subsequent pages. Because entries are authorization-filtered after a page is read, a page may contain fewer items than limit (or be empty) while has_more is still true. Clients MUST keep paging until has_more is false — do not stop on an empty page.

Use the optional resource_type query param to filter to a single resource type. When omitted, restrictions of all supported types are returned in one merged list.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/resource-restrictions

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/resource-restrictions
  • Auth
    HTTP bearer

Query parameters

resource_type'PROJECT' | 'DASHBOARD' | 'PROMPT'

Type of the restricted resource.

  • PROJECT - A project within a space.
  • DASHBOARD - A dashboard within a space.
  • PROMPT - A prompt within a space.
Example:PROJECT

Filter restrictions to a single resource type.

  • PROJECT — Return only restricted projects.
  • DASHBOARD — Return only restricted dashboards.
  • PROMPT — Return only restricted prompts.

When not specified, restrictions of all supported types are returned in one merged list.

limitinteger

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

A list of resource restriction records.

Example response

{
  "resource_restrictions": [
    {
      "resource_type": "PROJECT",
      "resource_id": "TW9kZWw6MTIxOmFCY0Q="
    }
  ]
}

Changes

    • warning

      added the new PROMPT enum value to the // response property for the response status

    • info

      added the new enum value PROMPT to the query request parameter resource_type

    • warning

      added the new DASHBOARD enum value to the // response property for the response status

    • info

      added the new enum value DASHBOARD to the query request parameter resource_type