Skip to main content

enableBYOKLite

Enable BYOK Lite by uploading a customer-supplied 32-byte key (hex or base64 string). Server wraps the org KW under the key, persists the wrapped row, and discards the plaintext key. Fails with extensions.code:

BYOK_TIER_NOT_ENTITLED — org subscription below configured min price ID BYOK_INVALID_KEY_FORMAT — key doesn't decode to exactly 32 bytes BYOK_INVARIANT_VIOLATED — escrow already active for the org

Admin-only via the manage-byok scope.

enableBYOKLite(
  orgID: String!
  key: String!
): Boolean!

Arguments​

enableBYOKLite.orgID ● String! non-null scalar​

enableBYOKLite.key ● String! non-null scalar​

Type​

Boolean scalar​

The Boolean scalar type represents true or false.