Docs
Skip to content
post

Create user

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/users

Description

Create a new user.

Required scopes

users.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Parameters

string
Required

User ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string

User email.

string

Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.

string

Plain text user password. Must be at least 8 chars.

string

User name. Max length: 128 chars.

Status
Content type
201
application/json

User

Name
Type
Description
string

User ID.

string

User creation date in ISO 8601 format.

string

User update date in ISO 8601 format.

string

User name.

string

Hashed user password.

string

Password hashing algorithm.

object

Password hashing algorithm configuration.

string

User registration date in ISO 8601 format.

boolean

User status. Pass true for enabled and false for disabled.

arrayof string

Labels for the user.

string

Password update time in ISO 8601 format.

string

User email address.

string

User phone number in E.164 format.

boolean

Email verification status.

string

Canonical form of the user email address.

boolean

Whether the user email is from a free email provider.

boolean

Whether the user email is from a disposable email provider.

boolean

Whether the user email is from a corporate domain.

boolean

Whether the user email is in its canonical form.

boolean

Phone verification status.

boolean

Multi factor authentication status.

object

User preferences as a key-value object

arrayof Target

A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.

Object type

string

Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.

boolean

Whether the user can impersonate other users.

string

ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.

HTTP
POST /v1/users HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
Accept: application/json
X-Appwrite-Response-Format: 1.9.5
X-Appwrite-Project: <YOUR_PROJECT_ID>


{
  "userId": "<USER_ID>",
  "email": "email@example.com",
  "phone": "+12065550100",
  "password": "password",
  "name": "<NAME>"
}


{
  "userId": "<USER_ID>",
  "email": "email@example.com",
  "phone": "+12065550100",
  "password": "password",
  "name": "<NAME>"
}