Users

SERVER

Platform

Version

The Users service allows you to manage your project users. Use this service to search, block, and view your users' info, current sessions, and latest activity logs. You can also use the Users service to edit your users' preferences and personal info.

Base URL

https://cloud.appwrite.io/v1

List Users

Get a list of all the project's users. You can use the query params to filter your results.

Request
- search string
  
  Search term to filter your list results. Max length: 256 chars.
- limit integer
  
  Maximum number of users to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.
- offset integer
  
  Offset value. The default value is 0. Use this param to manage pagination. learn more about pagination
- cursor string
  
  ID of the user used as the starting point for the query, excluding the user itself. Should be used for efficient pagination when working with large sets of data. learn more about pagination
- cursorDirection string
  
  Direction of the cursor, can be either 'before' or 'after'.
- orderType string
  
  Order result by ASC or DESC order.
Response
- 200 application/json
  
  Users List

Endpoint

GET /users

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.list();

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Create User

Create a new user.

Request
- userId string
  required
  
  User ID. Choose your own unique ID or pass the string "unique()" to auto generate it. 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.
- email string
  required
  
  User email.
- password string
  required
  
  User password. Must be at least 8 chars.
- name string
  
  User name. Max length: 128 chars.
Response
- 201 application/json
  
  User

Endpoint

POST /users

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.create('[USER_ID]', 'email@example.com', 'password');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Get User

Get a user by its unique ID.

Request
- userId string
  required
  
  User ID.
Response
- 200 application/json
  
  User

Endpoint

GET /users/{userId}

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.get('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Delete User

Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the updateStatus endpoint instead.

Request
- userId string
  required
  
  User ID.
Response
- 204 application/json

Endpoint

DELETE /users/{userId}

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.delete('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update Email

Update the user email by its unique ID.

Request
- userId string
  required
  
  User ID.
- email string
  required
  
  User email.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/email

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updateEmail('[USER_ID]', 'email@example.com');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Get User Logs

Get the user activity logs list by its unique ID.

Request
- userId string
  required
  
  User ID.
- limit integer
  
  Maximum number of logs to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.
- offset integer
  
  Offset value. The default value is 0. Use this value to manage pagination. learn more about pagination
Response
- 200 application/json
  
  Logs List

Endpoint

GET /users/{userId}/logs

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.getLogs('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Get User Memberships

Get the user membership list by its unique ID.

Request
- userId string
  required
  
  User ID.
Response
- 200 application/json
  
  Memberships List

Endpoint

GET /users/{userId}/memberships

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.getMemberships('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update Name

Update the user name by its unique ID.

Request
- userId string
  required
  
  User ID.
- name string
  required
  
  User name. Max length: 128 chars.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/name

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updateName('[USER_ID]', '[NAME]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update Password

Update the user password by its unique ID.

Request
- userId string
  required
  
  User ID.
- password string
  required
  
  New user password. Must be at least 8 chars.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/password

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updatePassword('[USER_ID]', 'password');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update Phone

Update the user phone by its unique ID.

Request
- userId string
  required
  
  User ID.
- number string
  required
  
  User phone number.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/phone

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updatePhone('[USER_ID]', '');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Get User Preferences

Get the user preferences by its unique ID.

Request
- userId string
  required
  
  User ID.
Response
- 200 application/json
  
  Preferences

Endpoint

GET /users/{userId}/prefs

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.getPrefs('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update User Preferences

Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.

Request
- userId string
  required
  
  User ID.
- prefs object
  required
  
  Prefs key-value JSON object.
Response
- 200 application/json
  
  Preferences

Endpoint

PATCH /users/{userId}/prefs

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updatePrefs('[USER_ID]', {});

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Get User Sessions

Get the user sessions list by its unique ID.

Request
- userId string
  required
  
  User ID.
Response
- 200 application/json
  
  Sessions List

Endpoint

GET /users/{userId}/sessions

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.getSessions('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Delete User Sessions

Delete all user's sessions by using the user's unique ID.

Request
- userId string
  required
  
  User ID.
Response
- 204 application/json

Endpoint

DELETE /users/{userId}/sessions

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.deleteSessions('[USER_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Delete User Session

Delete a user sessions by its unique ID.

Request
- userId string
  required
  
  User ID.
- sessionId string
  required
  
  Session ID.
Response
- 204 application/json

Endpoint

DELETE /users/{userId}/sessions/{sessionId}

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.deleteSession('[USER_ID]', '[SESSION_ID]');

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update User Status

Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.

Request
- userId string
  required
  
  User ID.
- status boolean
  required
  
  User Status. To activate the user pass true and to block the user pass false.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/status

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updateStatus('[USER_ID]', false);

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update Email Verification

Update the user email verification status by its unique ID.

Request
- userId string
  required
  
  User ID.
- emailVerification boolean
  required
  
  User email verification status.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/verification

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updateEmailVerification('[USER_ID]', false);

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Update Phone Verification

Update the user phone verification status by its unique ID.

Request
- userId string
  required
  
  User ID.
- phoneVerification boolean
  required
  
  User phone verification status.
Response
- 200 application/json
  
  User

Endpoint

PATCH /users/{userId}/verification/phone

Deno

import * as sdk from "https://deno.land/x/appwrite/mod.ts";

// Init SDK
let client = new sdk.Client();

let users = new sdk.Users(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;


let promise = users.updatePhoneVerification('[USER_ID]', false);

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

Recommended