Saltar para o conteúdo principal
POST
Criar Escopo

Criar Escopo

POST /v1/scopes Cria um escopo de permissão personalizado para o inquilino autenticado. Escopos personalizados estendem o registro de escopo integrado com permissões específicas do inquilino. A string do escopo é composta automaticamente dos campos resource e action no formato resource:action. Escopos personalizados são validados contra as regras de formato de escopo MAIP: apenas caracteres alfanuméricos, pontos, sublinhados, hífens e asteriscos.
Escopos personalizados são isolados por locatário. Eles não aparecem nos escopos de outros locatários registros. Escopos de plataforma integrados não podem ser substituídos ou duplicados.

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

string
UUID da definição de escopo recém-criada.
string
UUID do locatário proprietário.
string
A string de escopo composta no formato resource:action.
string
O componente de recurso.
string
O componente de ação.
string
Nome do escopo legível por humanos.
string
Descrição do escopo.
string
Categoria de escopo.
boolean
Sempre false para escopos criados pelo locatário.
string
Carimbo de data/hora de criação ISO 8601.

Exemplo


Atribuindo Escopos Personalizados a Agentes

Após criar um escopo personalizado, atribua-o aos agentes durante o registro ou via delegação:

Autorizações

X-API-Key
string
header
obrigatório

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

Corpo

application/json
action
string
obrigatório

Componente de ação do escopo (por exemplo, "ler", "aprovar", "*")

resource
string
obrigatório

Componente de recurso do escopo (por exemplo, "crm", "payment")

category
string

Categoria organizacional (padrão "custom")

description
string

Descrição detalhada do que o escopo concede

display_name
string

Nome legível por humanos para o escopo

Resposta

Escopo criado

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