Roblox Engine API · Schema

Roblox User

Schema for a Roblox user resource from the Open Cloud API.

GamingGame DevelopmentMetaverseRobloxOpen Cloud

Properties

Name Type Description
path string Resource path in format users/{userId}
createTime string Account creation timestamp
id string Unique Roblox user identifier
name string Unique username
displayName string Display name shown in-game
about string User profile bio
locale string User locale setting
premium boolean Whether the user has Roblox Premium
idVerified boolean Whether the user's identity has been verified
View JSON Schema on GitHub

JSON Schema

roblox-user-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/roblox-engine-api/json-schema/roblox-user-schema.json",
  "title": "Roblox User",
  "description": "Schema for a Roblox user resource from the Open Cloud API.",
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "Resource path in format users/{userId}"
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "Account creation timestamp"
    },
    "id": {
      "type": "string",
      "description": "Unique Roblox user identifier"
    },
    "name": {
      "type": "string",
      "description": "Unique username"
    },
    "displayName": {
      "type": "string",
      "description": "Display name shown in-game"
    },
    "about": {
      "type": "string",
      "description": "User profile bio"
    },
    "locale": {
      "type": "string",
      "description": "User locale setting"
    },
    "premium": {
      "type": "boolean",
      "description": "Whether the user has Roblox Premium"
    },
    "idVerified": {
      "type": "boolean",
      "description": "Whether the user's identity has been verified"
    }
  },
  "required": ["id", "name"]
}