*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

UserRestriction

Stellt eine Einschränkung für einen Benutzer dar.

RESSOURCEN-PFADE
/cloud/v2/universes/{universe_id}/user-restrictions
/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Attribute

pathstring

Der Ressourcenpfad der Benutzerbeschränkung.

Formen:

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

updateTimestring

Nur Ausgabe

Der Zeitstempel, als die Benutzerbeschränkung zuletzt aktualisiert wurde. Dieser String ist als Zeitstempel formatiert.

userstring

Nur Ausgabe

Der betroffene Benutzer.

gameJoinRestrictionobject

Der Benutzer ist vom Elternuniversum oder vom Ort ausgeschlossen.

Basis-URL

https://apis.roblox.com

Die UserRestriction-Ressource

{
  "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_id}/user-restrictions

Liste Benutzeinschränkungen für Benutzer, die jemals in einem Universum oder an einem bestimmten Ort gebannt wurden.

Bereiche

universe.user-restriction:read

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

Anfrageparameter

maxPageSizenumber

Die maximale Anzahl von Benutzeinschränkungen, die zurückzukehren sind.Der Dienst könnte weniger als diesen Wert zurückgeben.Wenn nicht spezifiziert, werden höchstens 10 Benutzeinschränkungen zurückgegeben.Der maximale Wert beträgt 100, und höhere Werte werden auf 100 festgelegt.

pageTokenstring

Ein Seiten-Token, das von einer früheren Anruf erhalten wurde, um eine nachfolgende Seite abzurufen.

Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die der nachfolgenden Anruf bereitgestellt hat, dem Anruf entsprechen, der das Seiten-Token bereitgestellt hat.

Rückmeldung

Eine Liste von Benutzeinschränkungen in der übergeordneten Sammlungen.

userRestrictionsarray<UserRestriction>

Die Benutzeinschränkungen aus dem angegebenen Universum oder Platz.

nextPageTokenstring

Ein Token, das du als pageToken-Parameter senden kannst, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

GET /cloud/v2/universes/{universe_id}/user-restrictions

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

Rückmeldung

{
  "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_id}/user-restrictions/{user_restriction_id}

Holen Sie sich die Benutzeinschränkung.

Bereiche

universe.user-restriction:read

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

user_restriction_idstring

Erforderlich

Die Benutzer-Einschränkungs-ID.

RückmeldungUserRestriction

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

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

Rückmeldung

{
  "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_id}/user-restrictions/{user_restriction_id}

Aktualisieren Sie die Benutzerbeschränkung.

Bereiche

universe.user-restriction:write

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

user_restriction_idstring

Erforderlich

Die Benutzer-Einschränkungs-ID.

Anfrageparameter

updateMaskstring

Die Liste der zu UpdateFelder.

Das Feld game_join_restriction muss atomar aktualisiert werden; Feldfmasken, die in game_join_restriction indexieren (z. B. "game_join_restriction.active" ), werden nicht unterstützt. Dieser String ist als FieldMask formatiert.

idempotencyKey.keystring

Der einzigartige Schlüssel, den man für die Unveränderlichkeit verwenden kann.

idempotencyKey.firstSentstring

Der Zeitstempel, in dem die erste Anfrage gesendet wurde.

Wenn dies weiter in der Vergangenheit liegt als die Lebensdauer des Idempotenzschlüssels (der möglicherweise die angegebene Mindestlebensdauer überschreitet), muss der Server einen Fehler zurückgeben. Dieser String ist als Zeitstempel formatiert.

Text anfordernUserRestriction

RückmeldungUserRestriction

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

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}?updateMask={string}&idempotencyKey.key={string}&idempotencyKey.firstSent={string}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "gameJoinRestriction": {
    "active": true,
    "duration": "3s",
    "privateReason": "some private reason",
    "displayReason": "some display reason",
    "excludeAltAccounts": true
  }
}'

Rückmeldung

{
  "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_id}/user-restrictions:listLogs

Liste Änderungen an Ressourcen von UserRestriction innerhalb eines bestimmten Universums. Dies beinhaltet sowohl universelle als auch platzspezifische Einschränkungen.

Für Logs von Einschränkungen auf Universumebene wird das Feld place leer sein.

Bereiche

universe.user-restriction:read

AnfragePfadparameter

universe_idstring

Erforderlich

Die Universum-ID.

Anfrageparameter

maxPageSizenumber

Die maximale Anzahl von UserRestrictionLogs, die zurückzukehren sind.Der Dienst kann weniger als diesen Wert zurückgeben.Wenn nicht spezifiziert, werden höchstens 10 Benutzer-Einschränkungsprotokolle zurückgegeben.Der maximale Wert beträgt 100, und höhere Werte werden auf 100 festgelegt.

pageTokenstring

Ein Seiten-Token, das von einer früheren Anruf erhalten wurde, um eine nachfolgende Seite abzurufen.

Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die der nachfolgenden Anruf bereitgestellt hat, dem Anruf entsprechen, der das Seiten-Token bereitgestellt hat.

filterstring

Dieses Feld kann so eingestellt werden, dass die zurückgegebenen Protokolle gefiltert werden.

Das Feld filter unterstützt eine sehr kleine Anzahl von CEL:

user
place
Der Vergleichsoperator == ist verfügbar.
Der logische Operator && wird ebenfalls unterstützt.

Als Beispiel filtert die Suche nach einem Benutzer und einem Ort die Form filter="user == 'users/123'" && "place == 'places/456'".

Rückmeldung

Gibt eine Liste der Änderungsprotokolle zurück, die auf Ressourcen von UserRestriction angewendet wurden.

logsarray<object>

Die Benutzerrestriktionsprotokolle aus dem angegebenen Universum.

nextPageTokenstring

Ein Token, das du als pageToken-Parameter senden kannst, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

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

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

Rückmeldung

{
  "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",
      "restrictionType": {
        "gameJoinRestriction": {}
      },
      "excludeAltAccounts": true
    }
  ],
  "nextPageToken": "string"
}

UserRestriction

Attribute

UserRestriction

List User RestrictionsBeta

UserRestriction

Get User RestrictionBeta

UserRestriction

Update User RestrictionBeta

UserRestriction

List User Restriction LogsBeta

List User Restrictions
Beta

Get User Restriction
Beta

Update User Restriction
Beta

List User Restriction Logs
Beta