createUser

mutation · in the family User

What it does

Create a new staff user at your organization.

Create a User in the caller's org group; requires the unrestricted capability.

Who may call it

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

• Owner
• System Administrator
• An API key whose scope allows api:createUser

Arguments

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 ExampleCreateUser($input: NewUserInput!) {
  createUser(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    accountId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "accountId": "01900000-0000-7000-8000-fec33a710000",
    "orgRoles": [
      {
        "org": "01900000-0000-7000-8000-9c1df0590000",
        "roles": [
          "01900000-0000-7000-8000-98bc5cde0000"
        ]
      }
    ]
  }
}

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

Example response

{
  "data": {
    "createUser": {
      "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

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Bring someone onto the team