1 min read

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

UserRestriction — cloud.docs

Represents a restriction on a user.

Properties

Related Schemas

• UserRestriction_GameJoinRestriction

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "universes/123/user-restrictions/123",
      "type": "string",
      "description": "The resource path of the user restriction.\n\nFormats:\n* `universes/{universe_id}/user-restrictions/{user_restriction_id}`\n* `universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}`"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the user restriction was last updated.",
      "format": "date-time"
    },
    "user": {
      "readOnly": true,
      "example": "users/156",
      "type": "string",
      "description": "The affected user."
    },
    "gameJoinRestriction": {
      "$ref": "#/components/schemas/UserRestriction_GameJoinRestriction",
      "description": "The user is banned from the parent universe or place."
    }
  },
  "description": "Represents a restriction on a user.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}/user-restrictions/{user_restriction_id}",
      "universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}"
    ],
    "plural": "user-restrictions",
    "singular": "user-restriction"
  },
  "x-resource": true
}