*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

UserRestriction

Representa uma restrição a um usuário.

ENDEREÇOS DE RECURSOS
/cloud/v2/universes/{universe_id}/user-restrictions
/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Atributos

pathstring

O caminho de recursos da restrição do usuário.

Formatos:

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

updateTimestring

Apenas saída

O timestamp quando a restrição do usuário foi atualizada pela última vez. Esta cadeia de caracteres é formatada como um Timestamp.

userstring

Apenas saída

O usuário afetado.

gameJoinRestrictionobject

O usuário é banido do universo ou local pai.

URL base

https://apis.roblox.com

O recurso 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_id}/user-restrictions

Lista restrições de usuário para usuários que já foram banidos em um universo ou em um local específico.

Escopos

universe.user-restriction:read

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

Parâmetros da consulta

maxPageSizenumber

O número máximo de restrições de usuário a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 restrições de usuário são retornadas.O valor máximo é 100 e valores mais altos são definidos como 100.

pageTokenstring

Um token de página, recebido de uma chamada anterior, para recuperar uma página posterior.

Ao paginar, todos os outros parâmetros fornecidos à chamada posterior devem corresponder à chamada que forneceu o token da página.

Resposta

Uma lista de Restrições de Usuário na coleçõespai.

userRestrictionsarray<UserRestriction>

As restrições de usuário do universo ou local especificado.

nextPageTokenstring

Um token que você pode enviar como um parâmetro pageToken para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.

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

Resposta

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

Obtenha a restrição do usuário.

Escopos

universe.user-restriction:read

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

user_restriction_idstring

Obrigatório

O ID de restrição do usuário.

RespostaUserRestriction

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

Resposta

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

Atualize a restrição do usuário.

Escopos

universe.user-restriction:write

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

user_restriction_idstring

Obrigatório

O ID de restrição do usuário.

Parâmetros da consulta

updateMaskstring

A lista de campos para atualização.

O campo game_join_restriction deve ser atualizado atomicamente; máscaras de campo que indexam em game_join_restriction (como "game_join_restriction.active" ) não são suportadas. Esta cadeia de caracteres está formatada como um FieldMask.

idempotencyKey.keystring

A chave única para usar para a impossibilidade.

idempotencyKey.firstSentstring

O horário em que a primeira solicitação foi sentença / frase

Se isso está mais no passado do que a vida útil da chave de impossibilidade (que pode exceder a vida útil mínima anotada), o servidor deve retornar um erro. Esta cadeia de caracteres é formatada como um Timestamp.

Requisitar corpoUserRestriction

RespostaUserRestriction

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

Resposta

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

Lista as alterações nos recursos de Restrição de Usuário dentro de um universo dado. Isso inclui restrições de nível de universo e de nível de local.

Para registros de restrição de nível do universo, o campo place será vazio.

Escopos

universe.user-restriction:read

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

Parâmetros da consulta

maxPageSizenumber

O número máximo de UserRestrictionLogs a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 Logs de Restrição de Usuário são retornados.O valor máximo é 100 e valores mais altos são definidos como 100.

pageTokenstring

Um token de página, recebido de uma chamada anterior, para recuperar uma página posterior.

Ao paginar, todos os outros parâmetros fornecidos à chamada posterior devem corresponder à chamada que forneceu o token da página.

filterstring

Este campo pode ser definido para filtrar os registros retornados.

O campo filter suporta um número muito pequeno de CEL:

user
place
O operador de comparação == está disponível.
O operador lógico && também é suportado.

Como exemplo, filtrar por um usuário e um local toma a forma filter="user == 'users/123'" && "place == 'places/456'".

Resposta

Retorna uma lista de registros de alterações aplicados a recursos de Restrição de Usuário.

logsarray<object>

Os Logs de Restrição de Usuário do universo especificado.

nextPageTokenstring

Um token que você pode enviar como um parâmetro pageToken para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.

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

Resposta

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

Atributos

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