Away 7:50 PM

2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

User — cloud.docs

Represents any registered user of Roblox.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the user. Format: users/{user_id}
createTimestringfalseThe timestamp at which the user was created.
idstringfalseUnique ID that identifies a user in Roblox.
namestringfalseUnique username for a user in Roblox.
displayNamestringfalseDisplay name for the user.
aboutstringfalseUser-defined information about themselves.
localestringfalseCurrent locale selected by the user. Returns IETF language code.
premiumbooleanfalseWhether the user is a premium user.
idVerifiedbooleanfalseSpecifies if the user is identity-verified. Verification includes, but isn't limited to, non-VoIP phone numbers or government IDs. To access this data, you need an API key / OAuth token with the following scope: user.advanced:read
socialNetworkProfiles#/components/schemas/User_SocialNetworkProfilesfalseUser's social network profiles and visibility.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "users/123",
      "type": "string",
      "description": "The resource path of the user.\n\nFormat: `users/{user_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp at which the user was created.",
      "format": "date-time"
    },
    "id": {
      "readOnly": true,
      "example": "123456",
      "type": "string",
      "description": "Unique ID that identifies a user in Roblox."
    },
    "name": {
      "example": "exampleUser",
      "type": "string",
      "description": "Unique username for a user in Roblox."
    },
    "displayName": {
      "example": "userDefinedName",
      "type": "string",
      "description": "Display name for the user."
    },
    "about": {
      "example": "Example User's bio",
      "type": "string",
      "description": "User-defined information about themselves."
    },
    "locale": {
      "example": "en-US",
      "type": "string",
      "description": "Current locale selected by the user. Returns IETF language code."
    },
    "premium": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Whether the user is a premium user."
    },
    "idVerified": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Specifies if the user is identity-verified. Verification includes, but\nisn't limited to, non-VoIP phone numbers or government IDs.\n\nTo access this data, you need an API key / OAuth token with the following\nscope: user.advanced:read"
    },
    "socialNetworkProfiles": {
      "$ref": "#/components/schemas/User_SocialNetworkProfiles",
      "description": "User's social network profiles and visibility."
    }
  },
  "description": "Represents any registered user of Roblox.",
  "x-aep-resource": {
    "patterns": [
      "users/{user_id}"
    ],
    "plural": "users",
    "singular": "user"
  },
  "x-resource": true
}