SocialluxSociallux
Toggle navigation menu
Docs navigationv

Primitive

secret.reveal

BETA

Short name: reveal

Version: 1.0.0

Authorizes and decrypts a single sensitive field on a single atom. Emits a `secret.revealed` audit event.

Back to primitive library

Inputs

KeyTypeRequiredDescription
atomIdobjectIdtrueAtom whose sensitive field is being revealed.
fieldPathstringtrueDotted path to the envelope (must start with 'data.'). Example: 'data.ssn.value'.

Outputs

KeyTypeRequiredDescription
grantIdstring|undefinedfalseGrant atom id, present when via === 'grant'.
valueanyfalseDecrypted JSON value. Transient — not persisted.
viastringfalseAuthorization channel: 'owner' or 'grant'.