使用禁止API管理用戶限制，包括即時替代帳戶檢測。[宇宙級禁止](#Cloud_UpdateUserRestriction__Using_Universes)影響所有場所，而[場所級禁止](#Cloud_UpdateUserRestriction__Using_Universes_Places)允許細粒度控制。禁止可以通過創作者中心儀表板管理。

禁止用戶的持續期間和原因是可自訂的，並且可以[查看任何被禁止用戶的管理歷史](#Cloud_ListUserRestrictionLogs)。

返回對UserRestriction資源施加的更改日誌的列表。

你可以作為`pageToken`參數發送的令牌，以檢索下一頁。如果此字段省略，則沒有後續頁。

指定宇宙或地點的UserRestrictions。

角色顏色。 ['Invalid' = 0, 'Blue' = 1, 'Green' = 2, 'Purple' = 3, 'Yellow' = 4, 'Orange' = 5, 'Red' = 6, 'Magenta' = 7, 'Teal' = 8, 'Turquoise' = 9, 'Rust' = 10, 'Pistachio' = 11, 'Midnight' = 12, 'Lavender' = 13, 'Pink' = 14, 'Crimson' = 15, 'Plum' = 16]

一個表示 Roblox.Platform.Membership.IUser 資料的模型

用戶限制的資源路徑。

格式：
* `universes/{universe_id}/user-restrictions/{user_restriction_id}`
* `universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}`

捕獲限制類型狀態變更的實體。

此日誌所表示的操作後限制是否仍然有效。

創建限制的面向用戶的原因。

此字段 *會* 顯示給用戶。

限制的持續時間。

如果未指定，則限制是永久的。

當為 true 時，限制不會傳播到替代帳戶。

默認為 false。

用戶限制明確更新的地點。
如果日誌捕獲在宇宙層級施加的狀態變更，則此字段為空。

創建限制的原因。

此字段 *不會* 顯示給用戶。

表示執行在遊戲伺服器上的用戶自寫的 Lua 腳本。

一項限制意味著受到影響的用戶無法加入父宇宙或地點，並且如果目前已加入，將被踢出。

默認為 false，因為用戶對體驗的訪問最初未受到限制。

如果在體驗層級設置為 true，則在所有涉及體驗的地方層級，該屬性將自動為 true。

創建限制的面向用戶的原因。

此字段 *會* 顯示給用戶。最大 400 個字元。

限制的持續時間。

如果未指定，限制為永久。如果指定，範圍必須包括 1 秒到 315,576,000,000 秒，包含範圍內的所有數值。小數精度不予許可。

當限制不直接應用於父資源時為 true，而是應用於某個其他祖先資源。

例如，如果在 universes/123 上存在用戶限制，那麼該宇宙中的任何地點，該用戶未明確受到限制，都將有一個繼承的限制，且該字段將為 `true`。

創建限制的原因。

此字段 *不會* 顯示給用戶。最大 1000 個字元。

可配置的密鑰，允許對 Roblox 資源進行細粒度訪問。詳細信息請參見 https://create.roblox.com/docs/cloud/auth/api-keys。

x-api-key

表示 Roblox 用戶身份的瀏覽器 Cookie。請勿分享此物。分享此物會允許他人以您的身份登錄，並竊取您的 Robux 和物品。我們不建議使用 Cookie 來調用端點。在可能的情況下，請改用帶有 x-api-key 標頭的 API 密鑰或 OAuth 2.0 進行身份驗證。

.ROBLOSECURITY

構建或授權應用程序以訪問 Roblox 資源。詳細信息請參見 https://create.roblox.com/docs/cloud/auth/oauth2-overview。

Roblox API。詳情請參見 https://create.roblox.com/docs/cloud/open-cloud。

Roblox API

List user restrictions for users that have ever been banned in either a
universe or a specific place.

universe_id

place_id

The maximum number of user restrictions to return. The service might return
fewer than this value. If unspecified, at most 10 user restrictions are
returned. The maximum value is 100 and higher values are set to 100.

maxPageSize

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must
match the call that provided the page token.

pageToken

UserRestriction

User Restrictions are subject to the additional rate limits, applied per universe

* Get User Restriction: 50 req/s
* List User Restrictions: 50 req/s
* Update User Restrictions: 10 req/s
* List User Restriction Logs: 50 req/s

Additionally, we impose the following rate limit for the same user within a universe:

* Update User Restriction: 2 req/min

For example, Update User Restriction may not be called for user 123 more than twice every minute.

universe.user-restriction:read

user_restriction_id

The list of fields to update.

The `game_join_restriction` field must be updated atomically; field masks
that index into `game_join_restriction` (such as
`"game_join_restriction.active"`) are not supported.

updateMask

idempotencyKey.key

The timestamp at which the first request was sent.

If this is further in the past than the lifetime of the idempotency key
(which *may* exceed the annotated minimum lifetime), the server *must*
return an error.

idempotencyKey.firstSent

universe.user-restriction:write

列出曾經在宇宙或特定地點被禁止的用戶的限制。

返回的用戶限制的最大數量。服務可能返回少於此值的限制。如果未指定，最多返回 10 條用戶限制。最大值為 100，超過的值將設置為 100。

從先前調用中接收的頁面令牌，用於檢索後續頁面。

當進行分頁時，所有提供給後續調用的其他參數必須與提供頁面令牌的調用相匹配。

用戶限制受額外速率限制的影響，應用於每個宇宙

* 獲取用戶限制：50 req/s
* 列出用戶限制：50 req/s
* 更新用戶限制：10 req/s
* 列出用戶限制日誌：50 req/s

此外，我們對同一用戶在宇宙內施加以下速率限制：

* 更新用戶限制：2 req/min

例如，更新用戶限制對用戶 123 的調用每分鐘不超過兩次。

要更新的欄位列表。

`game_join_restriction` 欄位必須以原子方式更新；不支持索引 `game_join_restriction` 的欄位掩碼（例如 `"game_join_restriction.active"`）。

第一次請求發送的時間戳。

如果這比冪等鍵的壽命更早（其壽命可能超過經註釋的最低壽命），服務器必須返回錯誤。

列出給定宇宙內 UserRestriction 資源的變更。
這包括宇宙級和地點級限制。

對於宇宙級限制日誌，`place` 欄位將為空。

返回的 UserRestrictionLogs 的最大數量。服務可能返回少於此值。如果未指定，最多返回 10 條 UserRestrictionLogs。最大值為 100，超過的值將設置為 100。

可以設置此欄位以過濾返回的日誌。

`filter` 欄位支持非常少量的 CEL：

* `user`
* `place`
* 可用 `==` 比較運算符。
* 也支持 `&&` 邏輯運算符。

例如，針對用戶和地點的過濾形式為 `filter="user == 'users/123'" && "place == 'places/456'"`

filter

groupId

limit

cursor

sortOrder

18: 該操作暫時無法使用。請稍後再試。

userId

0: 令牌驗證失敗
19: 您無權執行此請求。

1: 群組無效或不存在。
3: 用戶無效或不存在。

28: 該用戶已經被禁止加入群組。
31: 您無法針對群組擁有者執行此操作。

1: 群組無效或不存在。
3: 用戶無效或不存在。
3: 用戶無效或不存在。
15: 用戶不是該群組的成員。

1: 群組無效或不存在。
6: 限制無效。

9: 用戶無效或不存在。
10: 完成請求的權限不足。

檢索指定群組的被阻止關鍵字的分頁列表。

1: 群組無效或不存在。
2: 一個或多個關鍵字無效。
4: 請求無效。
12: 提供的內容被監管。

0: 令牌驗證失敗
8: 完成請求的權限不足。
9: 用戶無效或不存在。
10: 完成請求的權限不足。

向指定群組添加新的被遮擋關鍵字。

keywordId

1: 群組無效或不存在。
3: 關鍵字 Id 無效。
4: 請求無效。

0: 令牌驗證失敗
9: 用戶無效或不存在。
10: 完成請求的權限不足。

從指定群組中刪除特定的被過濾關鍵字。

1: 群組無效或不存在。
3: 關鍵字 Id 無效。
4: 請求無效。
12: 提供的內容被監管。

11: There was a conflict in your request.

更新指定群組的現有被過濾關鍵字。

Bans and blocks

体验

虚拟形象

素材

范例和项目

引擎 API

Open Cloud API

Studio

分析

平台

教程

创作者计划

教育

课程

学习

此方法是异步的，会返回一个`Operation`对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅[文档]({longRunningOperationsLink})。

以下部分描述了操作完成时提供的响应和元数据对象。

Beta 测试终点已准备好公开使用。可能出现导致功能无法正常运作的更改，但几率极低。

这些 Open Cloud 文档页面将于 2026 年 3 月 31 日移除。届时你将被自动重定向到新的 Open Cloud 文档。{linkStart}了解更多{linkEnd}

这些旧 Open Cloud 页面将于 2026 年 3 月 31 日移除并重定向。{linkStart}了解更多{linkEnd}

实验性终端节点已准备好供公众使用，但随着 API 协定的最终确定，可能偶尔会出现重大变更。

此终端节点可通过使用 API 密钥的 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 在体验中调用。

此字段可能在创建资源时被设置，但可能无法在后续请求中修改。

这些字段可能在创建资源时被设置，但可能无法在后续请求中修改。

此字段可以在请求中提供，但永远不会包括在答复中。

旧版验证方法。始终首选使用 API 密钥或 OAuth 2.0（如有）。

每个 API 密钥：每个 IP 地址每 {periodInSeconds} 秒有 {maxInPeriod} 次请求

无需身份验证即可调用。通常会显著降低速率限制。始终首选使用 API 密钥或 OAuth 2.0（如有）。

对于每个分组，只需提供架构中的以下字段之一，其余字段可以排除。

你可以随时重新选择加入。{linkStart}提供反馈。{linkEnd}

你正在查看旧版文档。{linkStart}提供反馈。{linkEnd}

你可以随时退出，并重定向回旧的引用页面。{linkStart}在这里提供反馈。{linkEnd}

你正在查看全新改版的文档。{linkStart}提供反馈。{linkEnd}

此字段可能被设置为响应，但在请求中将被忽略。

注意：在高流量期间，速率限制可能会更低。某些终端节点有额外的速率限制。[进一步了解速率限制]({link})。

用户或群组所有 API 密钥每天 {limit} 个请求

用户或群组所有 API 密钥每小时 {limit} 个请求

用户或群组所有 API 密钥每分钟 {limit} 个请求

用户或群组所有 API 密钥每秒 {limit} 个请求

每个 API 密钥所有者每分钟 {limit} 个请求

每个 App 用户每天 {limit} 个请求

每个 App 用户每小时 {limit} 个请求

每个 App 用户每分钟 {limit} 个请求

每个 App 用户每秒 {limit} 个请求

每个 API 密钥所有者每秒 {limit} 个请求

范围可以控制你的凭据拥有哪些权限。你的凭据只能访问你所选范围支持的终端节点。

稳定终端节点已准备好投入生产使用，在其生命周期内几乎不会发生重大变更。

此目标允许你将密钥的访问权限限制为选定的{requiredParts}

此目标允许你将密钥的访问权限限制为选定的{requiredParts}和{optionalParts}

目标类型用于限制你的凭据可操作的资源。即使你的帐户拥有其他资源的权限，也只能处理选定的资源。某些范围没有目标部件，在这种情况下，你的所有相关资源都可进行操作。

对于用户拥有的 API 密钥，无需选择宇宙顶级部件。在这种情况下，你的 API 密钥可以访问你拥有的所有个人体验，以及你在群组中拥有相应权限的群组体验。

尚不支持试用需要 API 密钥或 OAuth 2.0 验证的终端节点

为了安全起见，已停用高风险操作的 Cookie 验证。

关键风险终端节点非常敏感，为了安全起见，已停用“试用”

注意：此代码示例中不包含验证标头。你可能需要添加验证标头，以便此命令能够正常运作。

这是会修改或删除关键数据的高风险终端节点。测试时要格外小心。

此 API 终端节点已被归类为高风险，可能会影响实时数据或用户帐户。

对高风险 API 的已验证请求可能会进行无法撤销的更改。请在继续之前仔细查看你的请求参数。

这是会取回数据的低风险终端节点。通常可以安全测试。

这是会修改数据的中风险终端节点。请使用非关键帐户仔细测试，因为更改可能是永久性的。

为了确保你帐户的安全，请不要在此处粘贴来自其他来源的文本，或将此页面的信息发送给其他人。

你即将使用实际帐户凭据测试实时 API 终端节点。

只有在你了解即将进行的 API 调用的影响后才能继续。在测试之前，请仔细查看 API 文档。

将使用已验证的会话进行 API 调用

这些是可能影响你帐户或数据的真实 API 调用

某些操作可能会修改或删除数据

此终端节点已被以下推荐的替代终端节点取代：

调用此终端节点需要以下范围。如需
有关生成正确密钥的更多信息，请参阅 [管理 API 密钥]({apiKeyReferenceDocLink})。

如需有关生成密钥的更多信息，请参阅 [管理 API 密钥]({apiKeyReferenceDocLink})。

相对于基础 URL 的路径，下列端点是可用的。

此字符串格式为 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可以是 “null”、“boolean”、“string”、“number”、“array” 或 “object”。

你的 OAuth 2.0 应用程序需要以下范围才能使用此终端节点。如需进一步了解如何注册 OAuth 2.0 应用程序，请参阅 [App 注册和审核]({oauth2ReferenceDocLink})。

如需进一步了解如何注册 OAuth 2.0 应用程序，请参阅 [App 注册和审核]({oauth2ReferenceDocLink})。

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

调用此终端节点需要以下范围。

资源路径

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】({oauth2ReferenceDocLink})。

不推荐

你正在查看更新后的 Open Cloud 引用。

你已退出新的 Open Cloud 引用。

创建、更新和管理你的广告活动。

这将允许查看关于你素材的信息。

这将允许在 Roblox 上传或更新素材。

允许查看你的帐户有权访问的主体（包括群组和体验）和素材。

这将允许向你帐户有权访问的任何主体（包括群组和体验）和素材授予素材权限。

允许代表你查看虚拟形象自动设置任务的状态和结果。

允许代表你创建和管理虚拟形象自动设置任务。

授予更新用户拥有的徽章的能力。

这将允许查看有关你商业项目的信息。

这将允许更改你的同步商业项目。

这将允许查看有关你商户联结平台的信息。

这将允许编辑你的商户联结平台。

这将允许你查看关于你创作者商店产品的信息。

这将允许你修改关于你创作者商店产品的信息。

这将允许你查看关于你创作者商店保存的信息。

这将允许你修改关于你创作者商店保存的信息。

授予代表你创建数据存储的权限。

授予代表你删除数据存储的权限。

授予读取数据存储列表的权限。

授予拍摄数据存储快照的权限。

授予在数据存储中创建条目的权限。

授予标记要删除的指定条目的权限。

授予列出数据存储条目的权限。

授予读取数据存储中指定条目的权限。

授予更新条目的值、属性和用户的权限。

授予删除数据存储条目修订的权限。

授予列出数据存储条目修订的权限。

授予读取数据存储条目修订的权限。

授予查看授权用户的开发者产品配置详细信息的权限。

授予编辑授权用户的开发者产品的权限。

这将允许查看有关你宇宙环境的信息。

授予查看授权用户的游戏通行证配置详细信息的权限。

授予编辑授权用户的游戏通行证的权限。

授予查看你的帐户社区论坛信息的权限。

授予访问权限，允许管理你的帐户对应的社区论坛信息。

这将允许查看有关你社区的信息。

这将允许你管理社区加入请求，并处理你帐户中低级别社区成员的角色更新。

允许你修改实例的属性数据（目前仅支持脚本）。

这将允许查看你的道具栏信息。

授予权限，以管理你的徽章并使用 Robux。

授予更新授权用户徽章的权限。

授予读取你已开启通知的体验信息的权限。

授予代表你开启或关闭体验通知的权限。

授予读取和写入本地化表格的权限

授予为你拥有的所有体验管理团队协作的权限。

授予管理体验和与体验相关的某些信息（例如本地化信息）的权限。

授予读取体验本地化信息的权限。

授予修改体验本地化偏好设置的权限。

授予修改用户本地化偏好设置的权限。

允许你查看关联场景的 Luau 执行任务的状态、日志和结果。

允许你为关联场景创建新的 Luau 执行任务。

授予异步清空宇宙中所有数据结构的权限。

授予从队列前端丢弃已读项目的权限。

授予读取队列前端项目的权限。

授予读取记忆存储项目的权限。

授予创建、更新和删除地图项目的权限。

授予代替用户发布信息的权力。

这将允许从你的体验向用户发送通知。

（已弃用）授予读取有序数据存储中条目列表的权限。

（已弃用）授予在有序数据存储中创建新条目的权限。

授予从有序数据存储中列出条目的权限。

授予在有序数据存储中创建条目的权限。

这将允许列出与你的作品相关联的密钥。

这将允许创作和更新与你的作品相关联的密钥。

此权限允许你提交评估工作并查看工作结果。

授予读取订阅产品信息的权限。

授予在 Roblox 上发布新版本体验的权限。

授予编辑授权用户体验的权限。

允许你查看体验中的用户限制。

允许你编辑体验中的用户限制。

允许查看发送至你帐户的通知。

授予读取用户 Premium 和验证状态的能力。

这将允许你查看授权用户的社交帐户。

这将授予读取你的个人资料信息的权限。

Bans and blocks

Groups

Places

Universes