ROroblox
Bans and blocks
Universes
Users

Get User Restriction

Changed on

Get the user restriction.

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

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe.user-restriction:read

Path parameters

universe_idstring required

The universe ID.

user_restriction_idstring required

The user-restriction ID.

Response

OK

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
  }
}

Changes

  • 5dcfa33df56aRevision changes
    • info

      the security scope universe.user-restriction:read was added to the endpoint's security scheme roblox-oauth2