*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

UserRestriction

Représente une restriction pour un utilisateur.

CHEMINS POUR RESSOURCES
/cloud/v2/universes/{universe_id}/user-restrictions
/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Attributs

pathstring

Le chemin de ressource de la restriction d'utilisateur.

Formats :

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

updateTimestring

Sortie seule

La date et l'heure de la dernière mise à jour de la restriction d'utilisateur. Ce string est formatée en tant que Timestamp.

userstring

Sortie seule

L'utilisateur affecté.

gameJoinRestrictionobject

L'utilisateur est banni de l'univers parent ou de l'emplacement.

URL de base

https://apis.roblox.com

La ressource 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
Bêta

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

Listez les restrictions d'utilisation pour les utilisateurs qui ont déjà été bannis dans un univers ou un emplacementspécifique.

Périmètres d'application

universe.user-restriction:read

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

Paramètres de requête

maxPageSizenumber

Le nombre maximum de restrictions d'utilisateur à renvoyer.Le service peut retourner moins que cette valeur.Si non spécifié, au maximum 10 restrictions d'utilisateur sont retournées.La valeur maximale est de 100 et les valeurs plus élevées sont réglées sur 100.

pageTokenstring

Un jeton de page, reçu d'un appel précédent, pour récupérer une page suivante.

Lors de la pagination, tous les autres paramètres fournis à l'appel suivant doivent correspondre à l'appel qui a fourni le jeton de page.

Réponse

Une liste de restrictions d'utilisateur dans la collectionsparent.

userRestrictionsarray<UserRestriction>

Les restrictions d'utilisateur de l'univers ou de l'endroit spécifié.

nextPageTokenstring

Un jeton que vous pouvez envoyer en tant que pageToken paramètre pour récupérer la page suivante. Si ce champ est omis, il n'y a pas de pages suivantes.

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éponse

{
  "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
Bêta

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

Obtenez la restriction d'utilisateur.

Périmètres d'application

universe.user-restriction:read

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

user_restriction_idstring

Requis

L'ID de restriction d'utilisateur.

RéponseUserRestriction

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éponse

{
  "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
Bêta

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

Mise à jour de la restriction d'utilisateur.

Périmètres d'application

universe.user-restriction:write

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

user_restriction_idstring

Requis

L'ID de restriction d'utilisateur.

Paramètres de requête

updateMaskstring

La liste des champs à mettre à mise à jour.

Le champ game_join_restriction doit être mis à jour atomiquement ; les masques de champ qui indexent dans game_join_restriction (comme "game_join_restriction.active" ) ne sont pas pris en charge. Cette chaîne est formatée comme un FieldMask.

idempotencyKey.keystring

La clé unique à utiliser pour l'idéité.

idempotencyKey.firstSentstring

L'horodatage à laquelle la première demande a été envoyée.

Si cela est plus ancien que la durée de vie de la clé d'idéntité (qui peut dépasser la durée de vie minimale annotée,) le serveur doit retourner une erreur. Ce string est formatée en tant que Timestamp.

Corps de la requêteUserRestriction

RéponseUserRestriction

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éponse

{
  "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
Bêta

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

Listez les modifications des ressources de restriction d'utilisateur dans un univers donné. Cela inclut les restrictions à niveau d'univers et à niveau de lieu.

Pour les journaux de restriction au niveau de l'univers, le champ place sera vide.

Périmètres d'application

universe.user-restriction:read

RequêteParamètres du chemin

universe_idstring

Requis

L'ID de l'univers.

Paramètres de requête

maxPageSizenumber

Le nombre maximum de UserRestrictionLogs à renvoyer.Le service peut retourner moins que cette valeur.Si non spécifié, au maximum 10 journaux de restriction d'utilisateur sont retournés.La valeur maximale est de 100 et les valeurs plus élevées sont réglées sur 100.

pageTokenstring

Un jeton de page, reçu d'un appel précédent, pour récupérer une page suivante.

Lors de la pagination, tous les autres paramètres fournis à l'appel suivant doivent correspondre à l'appel qui a fourni le jeton de page.

filterstring

Ce champ peut être défini pour filtrer les journaux renvoyés.

Le champ filter supporte un très petit nombre de CEL :

user
place
L'opérateur de comparaison == est disponible.
L'opérateur logique && est également pris en charge.

Par exemple, le filtrage pour un utilisateur et un lieu prend la forme filter="user == 'users/123'" && "place == 'places/456'".

Réponse

Renvoie une liste de journaux de modifications appliqués aux ressources de restriction d'utilisateur.

logsarray<object>

Les journaux de restriction d'utilisateur de l'univers spécifié.

nextPageTokenstring

Un jeton que vous pouvez envoyer en tant que pageToken paramètre pour récupérer la page suivante. Si ce champ est omis, il n'y a pas de pages suivantes.

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éponse

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

Attributs

UserRestriction

List User RestrictionsBêta

UserRestriction

Get User RestrictionBêta

UserRestriction

Update User RestrictionBêta

UserRestriction

List User Restriction LogsBêta

List User Restrictions
Bêta

Get User Restriction
Bêta

Update User Restriction
Bêta

List User Restriction Logs
Bêta