UserRestriction

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

Atribut

pathstring
updateTimestring
Hanya Output
userstring
Hanya Output
gameJoinRestrictionobject
Base URL
https://apis.roblox.com/cloud
Resource UserRestriction
{

  "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 Restrictions
Beta

GET /cloud/v2/universes/{universe}/user-restrictions
Cakupan
universe.user-restriction:read
PermintaanParameter Jalur
universestring
Diperlukan
Parameter Kueri
maxPageSizenumber
pageTokenstring
filterstring
Respons
nextPageTokenstring
GET /cloud/v2/universes/{universe}/user-restrictions
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/user-restrictions?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Respons
{

  "userRestrictions": [

    {

      "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

      }

    }

  ],

  "nextPageToken": "string"

}

UserRestriction

Get User Restriction
Beta

GET /cloud/v2/universes/{universe}/user-restrictions/{user-restriction}
Cakupan
universe.user-restriction:read
PermintaanParameter Jalur
universestring
Diperlukan
user-restrictionstring
Diperlukan
ResponsUserRestriction
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}'
Respons
{

  "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
Beta

PATCH /cloud/v2/universes/{universe}/user-restrictions/{user-restriction}
Cakupan
universe.user-restriction:write
PermintaanParameter Jalur
universestring
Diperlukan
user-restrictionstring
Diperlukan
Parameter Kueri
updateMaskstring
idempotencyKey.keystring
idempotencyKey.firstSentstring
Request BodyUserRestriction
ResponsUserRestriction
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 \

  } \

}'
Respons
{

  "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
Beta

GET /cloud/v2/universes/{universe}/user-restrictions:listLogs
Cakupan
universe.user-restriction:read
PermintaanParameter Jalur
universestring
Diperlukan
Parameter Kueri
maxPageSizenumber
pageTokenstring
filterstring
Respons
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}'
Respons
{

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

}