Homepage

UserImport

Last edit: Oct 13, 2026

A user to import

type UserImport {
  created_at: JSONDate
  email: String!
  encrypted_password: String
  external_id: ID
  first_name: String
  id: ID
  last_name: String
  middle_name: String
  name: String
  password: String
  profiles: [UserProfileImportType!]
  properties: HashObject
  slug: String!
  updated_at: JSONDate
}

Fields

created_at (JSONDate)

Creation time to set; only used for new users

email (String)

Email of the user; must be unique within the import

encrypted_password (String)

Already hashed password copied from another instance, used instead of password

external_id (ID)

Identifier of the user in an external system

first_name (String)

First name

id (ID)

Id of the object in the source system, stored as external_id; generated when
empty. With _id_remap, other imported objects refer to this object by it

last_name (String)

Last name

middle_name (String)

Middle name

name (String)

Full name

password (String)

Plain-text password, stored hashed

profiles (UserProfileImportType)

Deprecated. User profiles to import with the user

properties (HashObject)

Property values of the user schema, for example { "color": "red" }; merged into the properties of an existing user

slug (String)

Slug of the user; must be unique within the import

updated_at (JSONDate)

Last update time to set; only used for new users

Questions?

We are always happy to help with any questions you may have.

contact us