User Identity

social.plus SDK identifies each user by a userId that your app provides. The userId should be stable, unique, and non-sensitive because it becomes the SDK identity used by login, profile, search, permission, and moderation APIs.

Keep your source-of-truth account record, credentials, email address, and private profile data in your own system. Send social.plus only the stable userId and the social profile fields your experience needs.

User ID Rules

Rule	Recommendation
Stable	Use an ID that will not change for the lifetime of the account.
Unique	Use a value already guaranteed unique by your backend.
Non-sensitive	Avoid emails, phone numbers, or other personal identifiers.
Reusable across SDK calls	Use the same value for login, profile reads, search results, and moderation actions.

Recommended IDs

Recommended
Avoid

Use database primary keys, UUIDs, or another immutable ID from your backend.

userId: "12345"
userId: "user_abc123"
userId: "4f8b4c2d-9e1a-4f3a-8b7c-6d5e4f3a9910"

Do not use identifiers that may change or expose private information.

userId: "john.doe@example.com"
userId: "johndoe123"
userId: "john_doe"

After a user is created in social.plus, treat the userId as immutable.

social.plus stores social profile and moderation fields that support SDK features. Avoid putting sensitive personal data in these fields.

Field	Description
`userId`	Stable identifier supplied by your app.
`displayName`	User-facing profile name.
`description`	User-facing profile description or bio.
`metadata`	Custom social metadata. Do not store sensitive personal data here.
`avatarFileId` / `avatarCustomUrl`	Avatar image reference.
`roles`	Assigned roles for permissions and moderation workflows.
`flagCount` / `isFlaggedByMe`	Moderation reporting state.
`isGlobalBan` / `isDeleted`	Account moderation or deletion state exposed by SDK query results where available.

Parameters

Operation	Input	Required	Platforms	Description
Initialize user repository	Initialized SDK client	Yes	TypeScript, iOS, Android, Flutter	The SDK must be initialized before user repository APIs are used.
Initialize user repository	User repository object or import	Yes	TypeScript, iOS, Android, Flutter	Platform-specific entry point for user reads, search, updates, and moderation operations.
Use user operation APIs	`userId`, display-name keyword, sort option, or paging control	Operation-dependent	TypeScript, iOS, Android, Flutter	Use the operation pages for method-specific inputs and result shapes.

Initialize the user repository

Initialize the user repository before calling user read, search, update, or moderation APIs.

import { UserRepository } from '@amityco/ts-sdk';

let userRepository = AmityUserRepository()

fun initUserRepository() {
    val userRepository = AmityCoreClient.newUserRepository()
}

void initUserRepository() {
  final userRepository = AmityCoreClient.newUserRepository();
}

Create User

User Operations

Choose the right SDK operation for user reads, updates, search, moderation, and tokens.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

User ID Rules

Recommended IDs

Parameters

Initialize the user repository

Create User

User Operations

​User ID Rules

​Recommended IDs

​Stored Social Profile Fields

​Parameters

​Initialize the user repository

​Related topics

Create User

User Operations

User ID Rules

Recommended IDs

Stored Social Profile Fields

Parameters

Initialize the user repository

Related topics