Away 11:52 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.

OpenCloudUsers.User — openapi

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. The field is omitted from the response when the caller is not authorized to read it.
socialNetworkProfilesfalseUser's social network profiles and visibility.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The resource path of the user.\r\n            \r\nFormat: `users/{user_id}`",
      "nullable": true
    },
    "createTime": {
      "type": "string",
      "description": "The timestamp at which the user was created.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true
    },
    "id": {
      "type": "string",
      "description": "Unique ID that identifies a user in Roblox.",
      "nullable": true,
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Unique username for a user in Roblox.",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "description": "Display name for the user.",
      "nullable": true
    },
    "about": {
      "type": "string",
      "description": "User-defined information about themselves.",
      "nullable": true
    },
    "locale": {
      "type": "string",
      "description": "Current locale selected by the user. Returns IETF language code.",
      "nullable": true
    },
    "premium": {
      "type": "boolean",
      "description": "Whether the user is a premium user.",
      "readOnly": true
    },
    "idVerified": {
      "type": "boolean",
      "description": "Specifies if the user is identity-verified. Verification includes, but\r\nisn't limited to, non-VoIP phone numbers or government IDs.\r\n            \r\nTo access this data, you need an API key / OAuth token with the following\r\nscope: user.advanced:read. The field is omitted from the response when the\r\ncaller is not authorized to read it.",
      "nullable": true,
      "readOnly": true
    },
    "socialNetworkProfiles": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OpenCloudUsers.User_SocialNetworkProfiles"
        }
      ],
      "description": "User's social network profiles and visibility.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Represents any registered user of Roblox."
}