3.4 KiB
3.4 KiB
Users Service
List Users
GET https://appwrite.io/v1/users
** Get a list of all the project users. You can use the query params to filter your results. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
search | string | Search term to filter your list results. | |
limit | integer | Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request. | 25 |
offset | integer | Results offset. The default value is 0. Use this param to manage pagination. | 0 |
orderType | string | Order result by ASC or DESC order. | ASC |
Create User
POST https://appwrite.io/v1/users
** Create a new user. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
string | User email. | ||
password | string | User password. | |
name | string | User name. |
Get User
GET https://appwrite.io/v1/users/{userId}
** Get user by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. |
Get User Logs
GET https://appwrite.io/v1/users/{userId}/logs
** Get user activity logs list by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. |
Get User Preferences
GET https://appwrite.io/v1/users/{userId}/prefs
** Get user preferences by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. |
Update User Preferences
PATCH https://appwrite.io/v1/users/{userId}/prefs
** Update user preferences by its unique ID. You can pass only the specific settings you wish to update. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. | |
prefs | object | Prefs key-value JSON object. |
Get User Sessions
GET https://appwrite.io/v1/users/{userId}/sessions
** Get user sessions list by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. |
Delete User Sessions
DELETE https://appwrite.io/v1/users/{userId}/sessions
** Delete all user sessions by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. |
Delete User Session
DELETE https://appwrite.io/v1/users/{userId}/sessions/:session
** Delete user sessions by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. | |
sessionId | string | User unique session ID. |
Update User Status
PATCH https://appwrite.io/v1/users/{userId}/status
** Update user status by its unique ID. **
Parameters
Field Name | Type | Description | Default |
---|---|---|---|
userId | string | Required User unique ID. | |
status | string | User Status code. To activate the user pass 1, to block the user pass 2 and for disabling the user pass 0 |