Pular para o conteúdo principal
POST
Criar uma Regra

Autorizações

X-API-Key
string
header
obrigatório

Autenticação por API Key. Usada por implantações single-tenant (MULTI_TENANT_ENABLED=false). Enviada em todas as requisições /v1/*.

Cabeçalhos

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Corpo

application/json

Entrada para criar uma nova regra.

name
string
obrigatório

Nome legível da regra (deve ser globalmente único).

Required string length: 1 - 255
expression
string
obrigatório

Expressão CEL que deve avaliar para booleano.

Required string length: 1 - 5000
action
enum<string>
obrigatório

Ação tomada quando a expressão da regra avalia como verdadeira.

Opções disponíveis:
ALLOW,
DENY,
REVIEW
description
string

Propósito e explicação da lógica da regra.

Maximum string length: 1000
scopes
object[]

Escopos que determinam a quais transações esta regra se aplica.

Maximum array length: 100

Resposta

Indica que a regra foi criada com sucesso com status DRAFT.

Regra de validação.

ruleId
string<uuid>

Identificador único da regra.

name
string

Nome legível da regra (globalmente único).

Maximum string length: 255
description
string

Propósito e explicação da lógica da regra.

Maximum string length: 1000
expression
string

Expressão CEL que deve avaliar para booleano.

Maximum string length: 5000
action
enum<string>

Ação tomada quando a expressão da regra avalia como verdadeira.

Opções disponíveis:
ALLOW,
DENY,
REVIEW
scopes
object[]

Escopos que determinam a quais transações esta regra se aplica.

status
enum<string>

Status do ciclo de vida da regra.

Opções disponíveis:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
createdAt
string<date-time>

Quando a regra foi criada.

updatedAt
string<date-time>

Quando a regra foi modificada pela última vez.

activatedAt
string<date-time> | null

Quando a regra foi ativada pela última vez (nulo se nunca ativada).

deactivatedAt
string<date-time> | null

Quando a regra foi desativada pela última vez (nulo se nunca desativada).

deletedAt
string<date-time> | null

Quando a regra foi excluída (nulo se não excluída).