User
Module endpoints
GET /users
GET /users
GET
https://api.slyk.io/users
Returns a paginated list of users
.
Name | Type | Example |
approved |
|
|
blocked |
|
|
|
| |
id |
|
|
name |
|
|
phone |
|
|
primaryWalletId |
|
|
referralCode |
|
|
referralUserId |
|
|
role |
|
|
verified |
|
|
The name
filter performs a SQL
query using the like
operator.
GET /users/:id
GET /users/:id
GET
https://api.slyk.io/users/:id
Gets the user details of the given id
.
PATCH /users/:id
PATCH /users/:id
PATCH
https://api.slyk.io/users/:id
Patches the user
details of the given id
.
Field | Type | Required | Description |
customData |
|
| Can store any additional information about the user. |
locale |
|
| User locale. |
name |
|
| User name. |
POST /users
POST /users
POST
https://api.slyk.io/users
Creates an user.
Field | Type | Required | Description |
approved |
|
| If provided, user is created already approved. |
blocked |
|
| If provided, user is created as blocked. |
code |
|
| Either a |
customData |
|
| May store any additional information about the user. |
|
| User email. | |
locale |
|
| User locale. |
name |
|
| User name. |
password |
|
| Login password. It must contain: 1 capital letter; 1 lower letter; 1 digit; at least 8 characters. |
primaryWalletId |
|
| User main wallet. Format: |
verified |
|
| If provided, user is created already verified. |
POST /users/:id/approve
POST /users/:id/approve
POST
https://api.slyk.io/users/:id/approve
Approves the user of the given id
.
A user that is not approved is unable to login.
204
No Content
POST /users/:id/block
POST /users/:id/block
POST
https://api.slyk.io/users/:id/block
Blocks the user of the given id
.
A user that is blocked is unable to login.
204
No Content
POST /users/:id/change-password
POST /users/:id/change-password
POST
https://api.slyk.io/users/:id/change-password
Changes the password of the user of the given id
.
Field | Type | Required | Description |
password |
|
| New password. It must contain: 1 capital letter; 1 lower letter; 1 digit; at least 8 characters. |
POST /users/:id/unblock
POST /users/:id/unblock
POST
http://api.slyk.io/users/:id/unlock
Unblocks the user of the given id
.
204
No Content
Last updated