createUser

Requires permission users:user:create.

Creates a user in your organization. The organization always comes from the signed-in user, never from the input. Naming a role also needs the role update permission. Needs users:user:create.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CreateUser($input: CreateUserInput!) {
  createUser(input: $input) {
    id
    postalCode
    name
    firstName
    lastName
    status
    directPermissions {
      id
      name
      createdAt
      action
      description
      direct
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CreateUser($input: CreateUserInput!) {\n  createUser(input: $input) {\n    id\n    postalCode\n    name\n    firstName\n    lastName\n    status\n    directPermissions {\n      id\n      name\n      createdAt\n      action\n      description\n      direct\n    }\n  }\n}",
  "variables": {
    "input": {
      "email": "string",
      "firstName": "string",
      "lastName": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "email": "string",
    "firstName": "string",
    "lastName": "string"
  }
}

Response:

{
  "data": {
    "createUser": {
      "id": "id",
      "postalCode": "string",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "status": "ACTIVE",
      "directPermissions": [
        {
          "id": "id",
          "name": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "action": "string",
          "description": "string",
          "direct": true
        }
      ]
    }
  }
}

createUser(
  input: CreateUserInput!
): User!

Arguments

createUser.input ● CreateUserInput! non-null input

The new user's details. Any organization in the input is ignored.

Type

User object

A user of the organization.