Comprehensive user management API for profiles, authentication, roles, and administrative operations

👥 USER MANAGEMENT API

User API

Complete user management system with profile operations, role-based access control, and administrative tools.

Overview

The User API provides comprehensive functionality for managing user accounts, profiles, authentication, and administrative operations. Access is role-based with separate endpoints for regular users and administrators.

User Type Schema

type User {
  id: Int
  regDate: Float
  updateDate: Float
  deleted: Int
  email: String
  name: String
  country: String
  phone: String
  birthday: Float
  lastLoginDate: Float
  role: [String]
  tierLevel: Int
  tierPoint: Float
  provider: String
  providerId: String
  notifySetting: Int
  avatar: UserAvatar
  security: [UserSecurity]
  verify: UserVerify
}

Core Fields

id

Unique user identifier

email

User email address

name

Full name or username

role

Array of assigned roles

tierLevel

User tier/level status

country

User country code

UserAvatar

type UserAvatar {
  id: Int
  prefix: String
  name: String
  purchased: String
  selected: String
}

Avatar customization data including prefix, name, purchased components, and selected appearance.

UserSecurity

type UserSecurity {
  id: Int
  type: String
  value: String
  verified: Int
}

Security settings including 2FA methods (app, email, SMS) and verification status.

UserVerify

type UserVerify {
  id: Int
  email: Int
  identity: Int
  address: Int
  bank: Int
}

Verification statuses for email, identity documents, address, and banking information.

Available Operations

User Operations

Get User

Get authenticated user's profile

Change Password

Update user password

Request Email Change

Request email address change

Confirm Email Change

Verify new email address

Delete Account

Permanently delete user account

Admin Operations

Get User by ID

Retrieve specific user by ID

Get Paginated Users

List users with pagination

Get Users Count

Get total user count

Create User

Create new user account

Reset Password

Admin reset user password

Change Role

Modify user roles

Suspend User

Suspend user account

Release User

Restore suspended account

Country Restrictions

Manage geographic restrictions

Location Access

Configure location permissions

Role-Based Access

USER

User Role

Standard user operations for managing own profile and account settings

• View own profile

• Update password & email

• Delete own account

• Manage avatar settings

ADMIN

Admin Role

Administrative operations for managing all users and system settings

• View any user profile

• Create & manage users

• Modify roles & permissions

• Suspend/restore accounts

Common Use Cases

👤

Profile Management

Users view and update their personal information, preferences, and account settings

🔐

Security Settings

Manage passwords, 2FA methods, and email verification for account security

⚙️

Admin Dashboard

Administrative interface for user management, role assignment, and system monitoring

📊

User Analytics

Track user growth, activity patterns, tier distribution, and engagement metrics

🌍

Geographic Control

Manage location-based access restrictions and country-specific permissions

🔄

Account Lifecycle

Handle account creation, suspension, restoration, and deletion workflows

Best Practices

🔒 Authorization

Always verify user roles before allowing access to admin operations. Use JWT tokens with proper role claims.

📧 Email Verification

Require email verification before granting full access to platform features.

🛡️ Security

Implement rate limiting on sensitive operations like password changes and user lookups.

💾 Data Privacy

Only return necessary user data in responses. Filter sensitive fields based on requester's role.

User API Overview