v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Bans and blocks

Universes

Users

Get User Restriction

Get the user restriction.

get/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}

Path parameters

universe_idstring required

The universe ID.

user_restriction_idstring required

The user-restriction ID.

Response

pathstring

The resource path of the user restriction.

Formats:

universes/{universe_id}/user-restrictions/{user_restriction_id}
universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}

updateTimestring date-time

The timestamp when the user restriction was last updated.

userstring

The affected user.

Example response

{
  "path": "universes/123/user-restrictions/123",
  "updateTime": "2023-07-05T12:34:56Z",
  "user": "users/156",
  "gameJoinRestriction": {
    "active": true,
    "startTime": "2023-07-05T12:34:56Z",
    "duration": "3s",
    "privateReason": "some private reason",
    "displayReason": "some display reason",
    "excludeAltAccounts": true,
    "inherited": true
  }
}