Saltar para o conteúdo principal
GET
Listar Escopos

Listar Escopos

GET /v1/scopes Retorna todos os escopos de permissão disponíveis para o locatário autenticado. Isso inclui escopos internos definidos pela plataforma e quaisquer escopos personalizados criados pelo locatário. Os escopos seguem o formato resource:action definido pelo protocolo MAIP.

Autenticação

Requer cabeçalho X-API-Key ou token JWT de portador. O espaço de trabalho é derivado da credencial autenticada; não envie X-Tenant-ID.

Resposta

Retorna um array de objetos de definição de escopo.
string
UUID da definição de escopo.
string
UUID do locatário que possui este escopo. null para incorporado no nível da plataforma escopos.
string
A string de escopo completa no formato resource:action (por exemplo, "data:read", "model:train").
string
O componente de recurso do escopo (por exemplo, "data", "model", "tool").
string
O componente de ação do escopo (por exemplo, "read", "write", "*").
string
Nome legível por humanos para o escopo.
string
Descrição detalhada do que o escopo concede acesso.
string
Categoria de escopo para fins organizacionais.
boolean
true para escopos definidos pela plataforma, false para escopos personalizados criados pelo locatário.
string
Carimbo de data/hora de criação ISO 8601.

Exemplo


Categorias de Escopo Integradas

A plataforma oferece mais de 25 escopos integrados em 6 categorias:

Referência de Formato de Escopo

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticação máquina a máquina

Parâmetros de consulta

category
enum<string>

Filtrar âmbitos por categoria

Opções disponíveis:
data,
model,
tool,
agent,
admin,
receipt,
custom

Resposta

Escopos disponíveis

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>