AlmondTill/G3N API

On this page

doomUser

mutation · in the family User

What it does

Permanently retire a staff user.

Doom a User by id; requires the unrestricted capability + the record's CURRENT revision (OCC). Sessions never block and never cascade (the RULED semantics): the doomed user's sessions go INERT at their next resolve and ride to their own natural terminal. An ACTIVE ApiKey minted by this user BLOCKS the doom → CONFLICT/REFERENCED naming the keys: ApiKey has no parent-doom cascade, so key disposition is explicit — doom the keys (or let them expire) first; terminal keys never block. The (account × group) userBinding marker stays with the doomed record as history and is taken over by a future re-add — dooming never permanently strands the pair. The optional reason rides the transition events.

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: Identity and access — Who can sign in and what each role allows — users, roles and their assignments.

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

User User! — A user — an Account AT an Organization Group, holding Roles per organization within the group; the principal a login resolves. Fully realized since: createUser binds an EXISTING Account into the caller's group (at most ONE User per account × group — the userBinding reservation that IS the login index; a doomed holder's binding is taken over on re-add, SL-d), and the lifecycle transitions ride the OPERATIONAL template with the RULED session semantics — sessions never block and never cascade; a non-active User's sessions go INERT at the next resolve (the live-status extension).

Example request

mutation ExampleDoomUser($id: ID!, $revision: ID!, $reason: String) {
  doomUser(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    accountId
  }
}

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": {
    "doomUser": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "US-EXMP-0000-000F",
      "type": "User",
      "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",
      "accountId": "01900000-0000-7000-8000-fec33a710000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer