UserRestriction

RESOURCE PATHS
/cloud/v2/universes/{universe}/user-restrictions
/cloud/v2/universes/{universe}/places/{place}/user-restrictions

Attributes

pathstring

updateTimestring

Output Only

userstring

Output Only

gameJoinRestrictionobject

Base URL

https://apis.roblox.com/cloud

The UserRestriction Resource

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

UserRestriction

Get User Restriction

GET /cloud/v2/universes/{universe}/user-restrictions/{user-restriction}

Scopes

universe.user-restriction:read

RequestPath Parameters

universestring

Required

user-restrictionstring

Required

ResponseUserRestriction

GET /cloud/v2/universes/{universe}/user-restrictions/{user-restriction}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/user-restrictions/{user-restriction}' \
  -H 'x-api-key: {your-api-key}'

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

UserRestriction

Update User Restriction

PATCH /cloud/v2/universes/{universe}/user-restrictions/{user-restriction}

Scopes

universe.user-restriction:write

RequestPath Parameters

universestring

Required

user-restrictionstring

Required

Query Parameters

updateMaskstring

idempotencyKey.keystring

idempotencyKey.firstSentstring

Request BodyUserRestriction

ResponseUserRestriction

PATCH /cloud/v2/universes/{universe}/user-restrictions/{user-restriction}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}/user-restrictions/{user-restriction}?updateMask={string}&idempotencyKey.key={string}&idempotencyKey.firstSent={string}' \
  -H 'x-api-key: {your-api-key}' \
  --data '{ \
  "gameJoinRestriction": { \
    "active": true, \
    "startTime": "2023-07-05T12:34:56Z", \
    "duration": "3s", \
    "privateReason": "some private reason", \
    "displayReason": "some display reason", \
    "excludeAltAccounts": true, \
    "inherited": true \
  } \
}'

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

UserRestriction

List User Restriction Logs

GET /cloud/v2/universes/{universe}/user-restrictions:listLogs

Scopes

universe.user-restriction:read

RequestPath Parameters

universestring

Required

Query Parameters

maxPageSizenumber

pageTokenstring

filterstring

Response

logsarray<object>

nextPageTokenstring

GET /cloud/v2/universes/{universe}/user-restrictions:listLogs

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/user-restrictions:listLogs?maxPageSize=10&pageToken={string}&filter={string}' \
  -H 'x-api-key: {your-api-key}'

Response

{
  "logs": [
    {
      "user": "users/156",
      "place": "places/456",
      "moderator": {
        "robloxUser": "users/156"
      },
      "createTime": "2023-07-05T12:34:56Z",
      "active": true,
      "startTime": "2023-07-05T12:34:56Z",
      "duration": "3s",
      "privateReason": "some private reason",
      "displayReason": "some display reason",
      "excludeAltAccounts": true
    }
  ],
  "nextPageToken": "string"
}