Skip to main content
GET
List Scopes

List Scopes

GET /v1/scopes Returns all permission scopes available to the authenticated tenant. This includes platform-defined built-in scopes and any custom scopes created by the tenant. Scopes follow the resource:action format defined by the MAIP protocol.

Authentication

Requires X-API-Key header or Bearer JWT token. The workspace is derived from the authenticated credential; do not send X-Tenant-ID.

Response

Returns an array of scope definition objects.
string
UUID of the scope definition.
string
UUID of the tenant that owns this scope. null for platform-level built-in scopes.
string
The full scope string in resource:action format (e.g., "data:read", "model:train").
string
The resource component of the scope (e.g., "data", "model", "tool").
string
The action component of the scope (e.g., "read", "write", "*").
string
Human-readable name for the scope.
string
Detailed description of what the scope grants access to.
string
Scope category for organizational purposes.
boolean
true for platform-defined scopes, false for tenant-created custom scopes.
string
ISO 8601 creation timestamp.

Example


Built-in Scope Categories

The platform provides 25+ built-in scopes across 6 categories:

Scope Format Reference

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Query Parameters

category
enum<string>

Filter scopes by category

Available options:
data,
model,
tool,
agent,
admin,
receipt,
custom

Response

Available scopes

id
string<uuid>
tenant_id
string<uuid> | null
scope
string
resource
string
action
string
display_name
string
description
string
category
string
is_builtin
boolean
created_at
string<date-time>