Create a setting lock

Módulo Settings

POST/setting-lockssettingLocks.create

A lock that stops lower scopes from overriding a setting. Creates a setting lock. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad org.security.write.
Alcances de OAuth: org.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: SettingLockCreate

settingLocks.create: SettingLockCreate
Campo	Tipo	Obligatorio	Descripción
setting_key	string	Sí	Setting key.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "setting_key": "security.mfa_required"
}

Respuesta 201: SettingLock

settingLocks.create: SettingLock
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the setting lock.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
setting_key	string	Sí	Setting key.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "setting_key": "security.mfa_required"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/setting-locks" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"setting_key":"security.mfa_required"}'

const { data } = await xos.settingLocks.create({
    "setting_key": "security.mfa_required"
  });

response = xos.setting_locks.create({"setting_key": "security.mfa_required"})

xos setting-locks create --data '{"setting_key":"security.mfa_required"}'