kf identity

Create parties, addresses, and contact points for the tenant.

kf identity assign-party-role

Assign a role such as CUSTOMER, SUPPLIER, CARRIER, or BUYER_CONTACT to a Party within a tenant, channel, location, order, or app scope.

Assign a role such as CUSTOMER, SUPPLIER, CARRIER, or BUYER_CONTACT to a Party within a tenant, channel, location, order, or app scope. Emits identity.party_role.assigned with ids and role facts only.

FlagRequiredDescription
--tenant <id>yesTarget tenant id.
--environment <id>noTarget environment id; defaults to the active profile environment.
--actor-type <type>yesActor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE).
--actor-id <id>yesActor id.
--idempotency-key <key>noIdempotency key for safe retries. Generated when omitted.
--party-id <value>yesParty id.
--role-type <value>yesRole type.
--scope-type <value>yesScope type.
--scope-id <value>noScope id.
--valid-from <value>noISO date/time
--valid-to <value>noISO date/time

Example

kf identity assign-party-role --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id <value> --role-type <value> --scope-type <value>

kf identity create-address

Insert one addresses row at status=ACTIVE attached to a parent Party.

Insert one addresses row at status=ACTIVE attached to a parent Party. Address values stay on the row; identity.address.created references address + party by id only.

FlagRequiredDescription
--tenant <id>yesTarget tenant id.
--environment <id>noTarget environment id; defaults to the active profile environment.
--actor-type <type>yesActor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE).
--actor-id <id>yesActor id.
--idempotency-key <key>noIdempotency key for safe retries. Generated when omitted.
--party-id <value>yesParty id.
--kind <value>yesKind.
--line1 <value>yesLine1.
--line2 <value>noLine2.
--line3 <value>noLine3.
--city <value>noCity.
--region <value>noRegion.
--region-code <value>noRegion code.
--postal-code <value>noPostal code.
--country-code <value>yesCountry code.

Example

kf identity create-address --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id <value> --kind <value> --line1 <value> --country-code <value>

kf identity create-contact-point

Insert one contact_points row at status=ACTIVE attached to a parent Party.

Insert one contact_points row at status=ACTIVE attached to a parent Party. The raw value (email, phone, webhook URL) stays on the row; identity.contact_point.created carries party + contact-point ids only.

FlagRequiredDescription
--tenant <id>yesTarget tenant id.
--environment <id>noTarget environment id; defaults to the active profile environment.
--actor-type <type>yesActor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE).
--actor-id <id>yesActor id.
--idempotency-key <key>noIdempotency key for safe retries. Generated when omitted.
--party-id <value>yesParty id.
--contact-type <value>yesContact type.
--value <value>yesValue.
--value-normalized <value>noValue normalized.
--preferred <value>noPreferred.
--preferred-language <value>noPreferred language.
--preferred-locale <value>noPreferred locale.

Example

kf identity create-contact-point --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id <value> --contact-type <value> --value <value>

kf identity create-party

Insert one parties row at status=ACTIVE.

Insert one parties row at status=ACTIVE. PII (legal_name, given_name, family_name) lives only on the row; the emitted identity.party.created event references the party by id only.

FlagRequiredDescription
--tenant <id>yesTarget tenant id.
--environment <id>noTarget environment id; defaults to the active profile environment.
--actor-type <type>yesActor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE).
--actor-id <id>yesActor id.
--idempotency-key <key>noIdempotency key for safe retries. Generated when omitted.
--party-type <value>yesParty type.
--legal-name <value>noLegal name.
--display-name <value>noDisplay name.
--given-name <value>noGiven name.
--family-name <value>noFamily name.
--external-ref <value>noExternal ref.

Example

kf identity create-party --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-type <value>

kf identity erase-party

GDPR-style erasure of a Party plus all child Addresses and ContactPoints.

GDPR-style erasure of a Party plus all child Addresses and ContactPoints. Pseudonymizes PII columns in place to preserve referential integrity for orders and fulfillments. Requires an APPROVED approval_request scoped to (Party, partyId, EraseParty). Risk class R4, irreversible.

FlagRequiredDescription
--tenant <id>yesTarget tenant id.
--environment <id>noTarget environment id; defaults to the active profile environment.
--actor-type <type>yesActor type (USER, SYSTEM, CONNECTOR, AGENT, SERVICE).
--actor-id <id>yesActor id.
--idempotency-key <key>noIdempotency key for safe retries. Generated when omitted.
--party-id <value>yesParty id.
--approval-request-id <value>yesApproval request id.
--reason <value>noReason.

Example

kf identity erase-party --tenant tnt_demo --actor-type USER --actor-id usr_sam --party-id <value> --approval-request-id <value>
Privacy choices

This controls app-managed marketing analytics: cookie-free Plausible, optional Cloudflare Web Analytics, and first-party event logs with session-only UTM attribution. The site works without it.

Read the privacy notice