AlmondTill/G3N API

On this page

eraseCollaborator

mutation · in the family Collaborator

What it does

Erase a collaborator’s personal data — the right-to-be-forgotten act, and the permanent end of their access.

Erase a Collaborator: active|inactive → doomed, the DE-IDENTIFICATION terminal. The (group × email) identity marker BURNS within the group (the email does NOT re-register — re-invite as a NEW Collaborator); sessions go INERT at their next resolve; doomed drops from listings + search. v1 dooms the record + burns the marker; the PII scrub rides the ONE shared machinery (the Consumer posture VERBATIM — the erase failure form is EVENTED + retryable: CONFLICT/ERASE_FAILED). Requires the current revision (OCC) + the unrestricted capability; template class (privacy & compliance — the eraseConsumer class).

What happens

Personal fields are irreversibly anonymized while their action history stays lawful and intact; their email never registers again in this group — re-engage them as a NEW collaborator.

Careful

PERMANENT. There is no un-erase — this is the privacy law’s one-way door.

Who may call it

Capability area: Privacy and compliance — Tax and fiscal configuration, certificates and privacy requests.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

Collaborator Collaborator! — A Collaborator — the strictly-scoped NON-ACCOUNT access identity: the User-adjacent NEVER-OWNER identity for EXTERNALLY-ORIGINATED parties (outside accountant/bookkeeper, agency, consultant, an integration partner's human operator, a scoped helper) granted limited access to ONE org group without being a merchant Account. Group-scoped like the Consumer (parentId === rootId — per-group NOT global; the same firm at two merchant groups = two records; federated identity is the lock's flagged-not-now). THE THREE DISTINCTIONS FROM A USER: (1) no merchant Account (its own identity + credential + session class) · (2) NO OWNERSHIP EVER (owners are Account-only structural links — there is no Collaborator state in which ownership is permitted) · (3) externally-originated (invited, not part of the merchant's principal hierarchy). Access = STRICTLY the Roles-per-org mechanism Users ride. the identity-marker rule (the Consumer burn class): the (group × normalized email) UNIQ marker IS the login index — a live/inactive holder refuses CONFLICT/IDENTITY_TAKEN; on erase (doom) the identifiers BURN within the group. Credentials NEVER ride this record: a created Collaborator is born active but CREDENTIAL-LESS — issueCollaboratorInvite mints the show-once bootstrap token, acceptCollaboratorInvite redeems it into the argon2id credential (the invite handshake is a credential-store bootstrap, NOT an FSM state — the lock's chosen lean; NO staff password-set lane EVER — recovery = re-invite rotation). Self-service rides the COLLABORATOR SESSION channel (collaboratorLogin + descriptor-gated ops); staff manage via THIS face. SEARCHABLE (the book law).

Example request

mutation ExampleEraseCollaborator($id: ID!, $revision: ID!, $reason: String) {
  eraseCollaborator(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    email
    displayName
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "eraseCollaborator": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CX-EXMP-0000-000F",
      "type": "Collaborator",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "email": "<the person’s email address>",
      "displayName": "Blue jeans"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer