Hyphenate Docs

Start Chatting with Hyphenate!

Welcome to the Hyphenate docs portal. Here you'll find comprehensive guides and technical documentation to help you integrate Hyphenate In-App Chat.

Get Started

User Account Management

The User Entity


Name Type Description
uuid String User ID, a unique identifier, generated by the Hyphenate server
username String The username for this Hyphenate user account (Hyphenate ID)
password String The password for this Hyphenate user account
nickname String The display name used for iOS push notifications
activated Boolean Current activation status for the user


  "nickname":"Super Apple",

Hyphenate User Account

To integrate with Hyphenate's service, you need to create a Hyphenate user account, then add and match it to your backend user database. Hyphenate ID naming rules

The username (Hyphenate ID) is the primary key to access Hyphenate's service on behalf of a user. It must be unique for each individual user. A simple way is to mirror the same user account ID that you created for your existing app users.

The password is only used for logging into the Hyphenate server, and should not be the same as the user's password to log into your app.

To enhance security, use the hash of the user's username and password, or apply encryption instead of using those properties as strings directly.

See case study Bind Existing User Data with Hyphenate ID if you already have existing users on your application backend server.

Updated 2 years ago

User Account Management

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.