HomePricingLogin

Users

Web API References for User Management Service

Explore the Web APIs available for managing users, including detailed descriptions and usage examples.

To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header.

Logs in a user with an email address.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
emailstring · min: 1Required
passwordstring · min: 1Required
Responses
200
OK
post
POST /api/auth/email/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 871

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "email": "text",
  "password": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Registers a new user with an email address.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
namestring · min: 1Required
emailstring · min: 1Required
passwordstring · min: 1Required
Responses
200
OK
post
POST /api/auth/email/register HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 885

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "name": "text",
  "email": "text",
  "password": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Logs in a user using an authentication token.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
tokenstring · min: 1Required
Responses
200
OK
post
POST /api/auth/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 853

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "token": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Logs in a user with a Google account.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
access_tokenstring · min: 1Required
Responses
200
OK
post
POST /api/auth/oauth/google HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 860

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "access_token": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Logs in a user with Steam account.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
steam_idstring · min: 1Required
app_idstring · min: 1Required
namestring · min: 1Required
Responses
200
OK
post
POST /api/auth/oauth/steam HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 886

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "steam_id": "text",
  "app_id": "text",
  "name": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Sends a One-Time Authentication (OTA) token to the user.

post
Body
phone_numberstring · min: 1Required
Responses
200
OK
Responseboolean
post
POST /api/auth/ota HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "phone_number": "text"
}
200

OK

true

Verifies the One-Time Authentication (OTA) token.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
phone_numberstring · min: 1Required
namestring | nullableOptional
tokenstring · min: 1Required
Responses
200
OK
post
POST /api/auth/ota/verify HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 889

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "phone_number": "text",
  "name": "text",
  "token": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Checks if One-Time Authentication (OTA) is ready.

get
Responses
200
OK
Responseboolean
get
GET /api/auth/ota HTTP/1.1
Host: 
Accept: */*
200

OK

true

Logs in a user as a guest.

post
Body
versioninteger · int32 | nullableOptional
client_idstring | nullableOptional
client_secretstring | nullableOptional
namestring | nullableOptional
usernamestring | nullableOptional
phoneNumberstring | nullableOptional
emailstring | nullableOptional
Responses
200
OK
post
POST /api/auth/guest HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 906

{
  "version": 1,
  "client_id": "text",
  "client_secret": "text",
  "name": "text",
  "username": "text",
  "phoneNumber": "text",
  "email": "text",
  "device_info": {
    "id": 1,
    "user": 1,
    "device_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z",
    "package_name": "text",
    "sdk_version": "text",
    "version_name": "text",
    "version_code": "text",
    "os_api_lavel": "text",
    "device": "text",
    "from": "text",
    "model": "text",
    "product": "text",
    "carrier_name": "text",
    "manufacturer": "text",
    "other_tags": "text",
    "screen_width": "text",
    "screen_height": "text",
    "sdcard_state": "text",
    "game_orientation": "text",
    "network_type": "text",
    "mac_address": "text",
    "ip_address": "text",
    "device_name": "text",
    "device_model": "text",
    "device_type": "text",
    "operating_system": "text",
    "processor_type": "text",
    "processor_count": "text",
    "processor_frequency": "text",
    "graphics_device_name": "text",
    "graphics_device_vendor": "text",
    "graphics_memory_size": "text"
  }
}
200

OK

{
  "user": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text",
    "is_ban": true,
    "is_tester": true,
    "is_guest": true,
    "google_token": "text",
    "fcm_id": "text",
    "steam_id": "text",
    "steam_app_id": "text",
    "first_login": "2025-07-03T11:48:26.340Z",
    "last_login": "2025-07-03T11:48:26.340Z"
  },
  "token": "text",
  "connection": {
    "endpoint": "text",
    "protocol": "text",
    "version": "text"
  }
}

Finds a user by their unique identifier.

get
Path parameters
userIdinteger · int32Required
Responses
200
OK
get
GET /api/table/services/users/{userId} HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "row": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phoneNumber": "text",
    "image": "text",
    "username": "text",
    "steamId": "text",
    "steamAppId": "text",
    "label": "text",
    "tags": "text",
    "isBan": true,
    "isTester": true,
    "isGuest": true,
    "googleToken": "text",
    "fcmId": "text",
    "firstLogin": "2025-07-03T11:48:26.340Z",
    "lastLogin": "2025-07-03T11:48:26.340Z"
  }
}

Retrieves the currently logged-in user.

get
Responses
200
OK
get
GET /api/table/services/users HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "row": {
    "id": 1,
    "name": "text",
    "email": "text",
    "phoneNumber": "text",
    "image": "text",
    "username": "text",
    "steamId": "text",
    "steamAppId": "text",
    "label": "text",
    "tags": "text",
    "isBan": true,
    "isTester": true,
    "isGuest": true,
    "googleToken": "text",
    "fcmId": "text",
    "firstLogin": "2025-07-03T11:48:26.340Z",
    "lastLogin": "2025-07-03T11:48:26.340Z"
  }
}

Find users based on the provided parameters.

post
Query parameters
skipinteger · int32OptionalDefault: 0
limitinteger · int32OptionalDefault: 25
Body
Responses
200
OK
post
POST /api/table/services/users/find HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "query": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "email": "text",
      "phoneNumber": "text",
      "image": "text",
      "username": "text",
      "steamId": "text",
      "steamAppId": "text",
      "label": "text",
      "tags": "text",
      "isBan": true,
      "isTester": true,
      "isGuest": true,
      "googleToken": "text",
      "fcmId": "text",
      "firstLogin": "2025-07-03T11:48:26.340Z",
      "lastLogin": "2025-07-03T11:48:26.340Z"
    }
  ],
  "totalCount": 1
}

Updates the details of the currently logged-in user.

put
Body
Responses
200
OK
put
PUT /api/table/services/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "data": {
    "name": "text",
    "email": "text",
    "phone_number": "text",
    "image": "text",
    "username": "text",
    "label": "text",
    "tags": "text"
  }
}
200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "email": "text",
      "phoneNumber": "text",
      "image": "text",
      "username": "text",
      "steamId": "text",
      "steamAppId": "text",
      "label": "text",
      "tags": "text",
      "isBan": true,
      "isTester": true,
      "isGuest": true,
      "googleToken": "text",
      "fcmId": "text",
      "firstLogin": "2025-07-03T11:48:26.340Z",
      "lastLogin": "2025-07-03T11:48:26.340Z"
    }
  ],
  "totalCount": 1
}
PreviousInstallationNextCloud Tables

Last updated