UserRestriction

  • PERCORSI RISORSE
  • /cloud/v2/universes/{universe}/user-restrictions
  • /cloud/v2/universes/{universe}/places/{place}/user-restrictions

Attributi

pathstring
updateTimestring
Solo output
userstring
Solo output
gameJoinRestrictionobject
URL di base

https://apis.roblox.com/cloud
Risorsa 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
Campi
universe.user-restriction:read
RichiestaParametri percorso
universestring
Necessario
Parametri query
maxPageSizenumber
pageTokenstring
filterstring
Risposta
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}'
Risposta

{
"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}
Campi
universe.user-restriction:read
RichiestaParametri percorso
universestring
Necessario
user-restrictionstring
Necessario
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}'
Risposta

{
"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}
Campi
universe.user-restriction:write
RichiestaParametri percorso
universestring
Necessario
user-restrictionstring
Necessario
Parametri query
updateMaskstring
idempotencyKey.keystring
idempotencyKey.firstSentstring
Corpo della richiestaUserRestriction
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 \
} \
}'
Risposta

{
"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
Campi
universe.user-restriction:read
RichiestaParametri percorso
universestring
Necessario
Parametri query
maxPageSizenumber
pageTokenstring
filterstring
Risposta
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}'
Risposta

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