Skip to content

GDPR & privacy

Built-in tooling to honour data-subject rights — export, erasure and consent — for both administrators and end users.

What it is

HelixIAM ships the operations you need to meet data-subject requests under GDPR and comparable privacy regimes:

  • Right to access / portability — export everything HelixIAM holds about a user as a structured file.
  • Right to erasure — anonymize a user (the default, keeping an anonymized audit record) or delete them and their data.
  • Consent ledger — view the consent grants and withdrawals recorded for a user.

These actions are available to administrators through the admin API and console, and to end users directly through the account console for self-service.

31 seconds, no sound. Pick a user, assemble the data export, see the consent ledger and anonymize the user. Recorded on the current release in a test realm.

In the console

GDPR has its own page, not a tab on the user: open GDPR / Privacy (under Compliance & security). Under Data subject, search for and select the user, then:

  1. Under Data export (Art. 15 / 20), click Assemble export, then Download JSON, for a portability or access request.
  2. Under Consent ledger (Art. 7), review the consent grants and withdrawals recorded for the user. The ledger is read-only; users withdraw a consent themselves in the account console.
  3. Under Erasure (Art. 17), choose the Erasure mode — Anonymize (keeps audit tombstone), the default, or Hard delete (removes all data) — and click Anonymize user or Erase user. Confirm in the dialog.

Erasure is irreversible

Both modes cannot be undone: anonymizing scrubs all personal data and keeps an anonymized audit record; a hard delete removes the account and associated records. Confirm the request and your retention obligations first — and ensure the action is captured in your audit log for accountability.

Over the API

Data-subject operations are realm- and user-scoped under /admin/realms/{realm}/users/{userId}/gdpr. The examples below assume you have set $HELIX_URL / $REALM and logged in — see Authenticating to the API.

Export a user's data — GET …/gdpr/export

Satisfies a right-to-access / portability request. The response is a structured, versioned document (schema: helix.gdpr.export/v1) covering profile, attributes, roles, memberships, credentials, federated links, consents and login events:

USER_ID=684db0eb-4afe-44f9-ad16-37a64f3496ea
curl -s -b cookies.txt \
  "$HELIX_URL/admin/realms/$REALM/users/$USER_ID/gdpr/export"
{
  "generatedAt": 1783341227374,
  "schema": "helix.gdpr.export/v1",
  "realmId": "acme",
  "userId": "684db0eb-4afe-44f9-ad16-37a64f3496ea",
  "profile": { "username": "alice", "email": null, "enabled": true, "createdAt": 1783001276475 },
  "attributes": {},
  "roles": ["user"],
  "realmMemberships": [ { "realmId": "acme", "joinedAt": null } ],
  "organizations": [],
  "credentials": [],
  "federatedLinks": [],
  "consents": [],
  "loginEvents": []
}

curl -s -b cookies.txt \
  "$HELIX_URL/admin/realms/$REALM/users/$USER_ID/gdpr/consents"
[]

Erase a user — DELETE …/gdpr

Satisfies a right-to-erasure request. ?mode=anonymize (the default) scrubs the personal data and keeps an anonymized audit record; ?mode=hard deletes everything. Either way the user's sessions are ended. This is a write, so refresh the CSRF token first:

curl -s -b cookies.txt -c cookies.txt "$HELIX_URL/admin/realms/$REALM/users" >/dev/null
CSRF=$(awk '($6=="__Host-XSRF-TOKEN"||$6=="XSRF-TOKEN")&&$7~/^r1\./{t=$7} END{print t}' cookies.txt)

curl -s -b cookies.txt -X DELETE -H "X-XSRF-TOKEN: $CSRF" \
  "$HELIX_URL/admin/realms/$REALM/users/$USER_ID/gdpr?mode=anonymize"
Method & path (under /admin/realms/{realm}) Purpose
GET /users/{userId}/gdpr/export Export everything held about a user (access / portability)
GET /users/{userId}/gdpr/consents Read the user's consent records
DELETE /users/{userId}/gdpr?mode=anonymize\|hard Anonymize (default) or hard-delete the user (right to erasure)

End-user self-service

End users can exercise their own rights from the account console without contacting an administrator — authenticated by the user's own session, not an admin session:

Method & path Purpose
GET /account/gdpr/export Download my own data
GET /account/gdpr/consents List consents I've granted
DELETE /account/gdpr/consents/{clientId} Revoke consent for one application

This keeps routine privacy requests off your support desk while staying fully auditable.

See also