UserRestriction_GameJoinRestriction — openapi

A restriction means the affected user will not be able to join the parent universe or place, and will be kicked if currently joined.

Properties

Name	Type	Required	Description
active	boolean	false	By default, this is false since a user's access to an experience is not restricted to begin with. If this is set to true at the experience level, this becomes true automatically at the place level for all places in the experience.
startTime	string	false	The start time of the restriction.
duration	string	false	The duration of the restriction. If not specified, the restriction is permanent. If specified, the range must be from 1 second to 315,576,000,000 seconds, inclusive. Durations with sub-second precision are not permitted.
privateReason	string	false	The reason the restriction was created. This field is not displayed to the user. 1,000 character maximum.
displayReason	string	false	The user-facing reason the restriction was created. This field is displayed to the user. 400 character maximum.
excludeAltAccounts	boolean	false	When true, the restriction will not be be propagated to alt accounts. Defaults to false.
inherited	boolean	false	This is true when the restriction doesn't directly apply to the parent resource, but to some other ancestor resource. For example, if a user restriction exists on universes/123, then any places within that universe from which the user was not explicitly restricted will have an inherited restriction and this field will be `true`.

Complete Schema

{
  "type": "object",
  "properties": {
    "active": {
      "example": true,
      "type": "boolean",
      "description": "By default, this is false since a user's access to an experience\nis not restricted to begin with.\n\nIf this is set to true at the experience level, this becomes true\nautomatically at the place level for all places in the experience."
    },
    "startTime": {
      "readOnly": true,
      "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. If specified, the range\nmust be from 1 second to 315,576,000,000 seconds, inclusive. Durations\nwith sub-second precision are not permitted.",
      "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. 1,000 character maximum."
    },
    "displayReason": {
      "example": "some display reason",
      "type": "string",
      "description": "The user-facing reason the restriction was created.\n\nThis field *is* displayed to the user. 400 character maximum."
    },
    "excludeAltAccounts": {
      "example": true,
      "type": "boolean",
      "description": "When true, the restriction will not be be propagated to alt accounts.\n\nDefaults to false."
    },
    "inherited": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "This is true when the restriction doesn't directly apply to the parent\nresource, but to some other ancestor resource.\n\nFor example, if a user restriction exists on universes/123, then any\nplaces within that universe from which the user was not explicitly\nrestricted will have an inherited restriction and this field will be\n`true`."
    }
  },
  "description": "A restriction means the affected user will not be able to join the parent\nuniverse or place, and will be kicked if currently joined."
}