Saltar al contenido principal
PATCH
Actualizar una Regla

Autorizaciones

X-API-Key
string
header
requerido

Autenticación por API Key. Utilizada por los despliegues de inquilino único (MULTI_TENANT_ENABLED=false). Se envía en cada solicitud /v1/*.

Encabezados

Content-Type
string
requerido

El tipo de medio del recurso. Debe ser application/json.

X-API-Key
string
requerido

La clave API para autenticacion. Este encabezado es requerido para todos los endpoints excepto verificaciones de salud.

X-Request-Id
string<uuid>

Un identificador unico usado para rastrear y seguir cada solicitud.

Parámetros de ruta

id
string<uuid>
requerido

El identificador unico de la regla que desea recuperar, actualizar o eliminar.

Cuerpo

application/json

Entrada para actualizar una regla. Al menos un campo debe ser proporcionado.

name
string
Required string length: 1 - 255
description
string
Maximum string length: 1000
expression
string

Expresion CEL (solo modificable para reglas DRAFT).

Required string length: 1 - 5000
action
enum<string>
Opciones disponibles:
ALLOW,
DENY,
REVIEW
scopes
object[]
Maximum array length: 100

Respuesta

Indica que la regla fue actualizada exitosamente.

Regla de validacion.

ruleId
string<uuid>

Identificador unico de la regla.

name
string

Nombre de regla legible para humanos (globalmente unico).

Maximum string length: 255
description
string

Proposito y explicacion de la logica de la regla.

Maximum string length: 1000
expression
string

Expresion CEL que debe evaluar a booleano.

Maximum string length: 5000
action
enum<string>

Accion tomada cuando la expresion de la regla evalua a verdadero.

Opciones disponibles:
ALLOW,
DENY,
REVIEW
scopes
object[]

Alcances que determinan a que transacciones aplica esta regla.

status
enum<string>

Estado del ciclo de vida de la regla.

Opciones disponibles:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
createdAt
string<date-time>

Cuando se creo la regla.

updatedAt
string<date-time>

Cuando se modifico la regla por ultima vez.

activatedAt
string<date-time> | null

Cuando la regla fue activada por ultima vez (null si nunca fue activada).

deactivatedAt
string<date-time> | null

Cuando la regla fue desactivada por ultima vez (null si nunca fue desactivada).

deletedAt
string<date-time> | null

Cuando la regla fue eliminada (null si no fue eliminada).