User overview
A user in the Chat SDK is an app user who holds a valid access token issued by the server and connects to the messaging service.
Register a user
Your app server provides a user ID (userId) to the server to obtain an access token. This step — called "registering a user" — must be done via the Server API.
The client must hold a valid access token to connect to the server.
Registration limits:
- Development environment: max 100 registered users.
- Production environment: unlimited users with Starter or Pro plan.
Deactivate a user
Deactivation deletes user data from the server. Use this feature to implement account deletion for compliance requirements. After deactivation, user-related data is permanently removed. You can query all deactivated user IDs and reactivate them if needed (personal data cannot be recovered).
Only the Server API provides deactivation capabilities.
User profiles
User profile APIs are available by default. You can call the related profile APIs to store user profile data (such as names and avatars) on the server. The server does not automatically import your app-side profile data, so your app remains responsible for writing and maintaining that data through these APIs.
Friendships
Friend management APIs are available by default. You can call the related friendship APIs to maintain friend relationships on the server. The server does not automatically import or sync friendship data from your app, so your app server must create and maintain that data through these APIs.
Without the managed friendship service, your app server must enforce any additional direct-message restrictions on its own.
User management APIs
| Feature | Client API | Server API |
|---|---|---|
| Register user | N/A | Register user |
| Invalidate token | N/A | Invalidate token |
| Deactivate user | N/A | Deactivate user |
| Query deactivated users | N/A | Query deactivated users |
| Reactivate user | N/A | Reactivate user |
| Get/set user info | N/A | Get/Modify user info |
| Ban user | N/A | Ban/Unban/Query banned users |
| Check online status | N/A | Check online status |
| Blocklist | Add/Remove/Query/List | Add/Remove/Query |