Away 11:53 PM

3 min read

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

UserRestrictionLog — openapi

An entity capturing a state change on a type of restriction.

Properties

NameTypeRequiredDescription
userstringfalseThe user to which this restriction update is applied.
placestringfalseThe place in which a user restriction was explicitly updated. This field is empty if the log captures a state change applied on the universe level.
moderator#/components/schemas/UserRestrictionLog_ModeratorfalseThe moderator who issued the state change.
createTimestringfalseWhen the change happened.
activebooleanfalseWhether the restriction was active after the action represented by this log.
startTimestringfalseThe start time of the restriction.
durationstringfalseThe duration of the restriction. If not specified, the restriction is permanent.
privateReasonstringfalseThe reason the restriction was created. This field is not displayed to the user.
displayReasonstringfalseThe user-facing reason the restriction was created. This field is displayed to the user.
restrictionType#/components/schemas/UserRestrictionLog_RestrictionTypefalseThe type of restriction for this log.
excludeAltAccountsbooleanfalseWhen true, the restriction will not be be propagated to alt accounts. Defaults to false.

Complete Schema

{
  "type": "object",
  "properties": {
    "user": {
      "example": "users/156",
      "type": "string",
      "description": "The user to which this restriction update is applied."
    },
    "place": {
      "example": "places/456",
      "type": "string",
      "description": "The place in which a user restriction was explicitly updated.\nThis field is empty if the log captures a state change applied on the\nuniverse level."
    },
    "moderator": {
      "$ref": "#/components/schemas/UserRestrictionLog_Moderator",
      "description": "The moderator who issued the state change."
    },
    "createTime": {
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "When the change happened.",
      "format": "date-time"
    },
    "active": {
      "example": true,
      "type": "boolean",
      "description": "Whether the restriction was active after the action\nrepresented by this log."
    },
    "startTime": {
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The start time of the restriction.",
      "format": "date-time"
    },
    "duration": {
      "example": "3s",
      "type": "string",
      "description": "The duration of the restriction.\n\nIf not specified, the restriction is permanent.",
      "format": "duration"
    },
    "privateReason": {
      "example": "some private reason",
      "type": "string",
      "description": "The reason the restriction was created.\n\nThis field *is not* displayed to the user."
    },
    "displayReason": {
      "example": "some display reason",
      "type": "string",
      "description": "The user-facing reason the restriction was created.\n\nThis field *is* displayed to the user."
    },
    "restrictionType": {
      "$ref": "#/components/schemas/UserRestrictionLog_RestrictionType",
      "description": "The type of restriction for this log."
    },
    "excludeAltAccounts": {
      "example": true,
      "type": "boolean",
      "description": "When true, the restriction will not be be propagated to alt accounts.\n\nDefaults to false."
    }
  },
  "description": "An entity capturing a state change on a type of restriction."
}