Manage user restrictions using the Ban API, which includes real-time alt account detection. [Universe-level bans](#Cloud_UpdateUserRestriction__Using_Universes) affect all places, while [place-level bans](#Cloud_UpdateUserRestriction__Using_Universes_Places) allow granular control. Bans can also be managed via the Creator Hub dashboard.

Ban users with customizable duration and reasons, and [review moderation history](#Cloud_ListUserRestrictionLogs) for any banned users.


Returns a list of change logs applied to UserRestriction resources.

The UserRestrictionLogs from the specified Universe.

A token that you can send as a `pageToken` parameter to retrieve the next
page. If this field is omitted, there are no subsequent pages.

A list of UserRestrictions in the parent collection.

The UserRestrictions from the specified Universe or Place.

Total number of active keywords in the group

The role color. ['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]

Whether or not the role is the base role for the group

A model representing data about an Roblox.Platform.Membership.IUser

The resource path of the user restriction.

Formats:
* `universes/{universe_id}/user-restrictions/{user_restriction_id}`
* `universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}`

The timestamp when the user restriction was last updated.

An entity capturing a state change on a type of restriction.

Whether the restriction was active after the action
represented by this log.

The user-facing reason the restriction was created.

This field *is* displayed to the user.

The duration of the restriction.

If not specified, the restriction is permanent.

When true, the restriction will not be be propagated to alt accounts.

Defaults to false.

The place in which a user restriction was explicitly updated.
This field is empty if the log captures a state change applied on the
universe level.

The reason the restriction was created.

This field *is not* displayed to the user.

The user to which this restriction update is applied.

An entity capturing the author of a state change.

A moderator identified by the User resource.

Represents a user-written Lua script executed on game server.

A restriction means the affected user will not be able to join the parent
universe or place, and will be kicked if currently joined.

By default, this is false since a user's access to an experience
is not restricted to begin with.

If this is set to true at the experience level, this becomes true
automatically at the place level for all places in the experience.

The user-facing reason the restriction was created.

This field *is* displayed to the user. 400 character maximum.

The duration of the restriction.

If not specified, the restriction is permanent. If specified, the range
must be from 1 second to 315,576,000,000 seconds, inclusive. Durations
with sub-second precision are not permitted.

This is true when the restriction doesn't directly apply to the parent
resource, but to some other ancestor resource.

For example, if a user restriction exists on universes/123, then any
places within that universe from which the user was not explicitly
restricted will have an inherited restriction and this field will be
`true`.

The reason the restriction was created.

This field *is not* displayed to the user. 1,000 character maximum.

A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.

x-api-key

A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.

.ROBLOSECURITY

Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.

The Roblox API. See https://create.roblox.com/docs/cloud/open-cloud for more details.

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

List changes to UserRestriction resources within a given universe.
This includes both universe-level and place-level restrictions.

For universe-level restriction logs, the `place` field will be empty.

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

This field may be set to filter the logs returned.

The `filter` field supports a very small number of CEL:

* `user`
* `place`
* The `==` comparison operator is available.
* The `&&` logical operator is also supported.

As an example, filtering for a user and a place takes the form
`filter="user == 'users/123'" && "place == 'places/456'"`

filter

groupId

limit

The paging cursor for the previous or next page.

cursor

sortOrder

0: Authorization has been denied for this request.

19: You have insufficient permissions for this request.

1: The group is invalid or does not exist.

18: The operation is temporarily unavailable. Please try again later.

userId

29: The user is not banned from the group.

0: Token Validation Failed
19: You have insufficient permissions for this request.

1: The group is invalid or does not exist.
3: The user is invalid or does not exist.

Fetch the group ban of a user from a group

28: The user is already banned from the group.
31: You cannot perform this action against the group owner.

1: The group is invalid or does not exist.
3: The user is invalid or does not exist.
3: The user is invalid or does not exist.
15: User is not a member of the group.

1: Group is invalid or does not exist.
6: Limit is invalid.

9: User is invalid or does not exist.
10: Insufficient permissions to complete the request.

Retrieves a paginated list of blocked keywords for a specific Group.

1: Group is invalid or does not exist.
2: One or more keywords are invalid.
4: Invalid request.
12: The provided content was moderated.

0: Token Validation Failed
8: Insufficient permissions to complete the request.
9: User is invalid or does not exist.
10: Insufficient permissions to complete the request.

11: There was a conflict in your request.

Adds new blocked keyword(s) to the specified Group.

keywordId

1: Group is invalid or does not exist.
3: KeywordId is invalid.
4: Invalid request.

0: Token Validation Failed
9: User is invalid or does not exist.
10: Insufficient permissions to complete the request.

Deletes a specific blocked keyword from the specified Group.

1: Group is invalid or does not exist.
3: KeywordId is invalid.
4: Invalid request.
12: The provided content was moderated.

Updates an existing blocked keyword for the specified Group.

Bans and blocks

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Courses

Learn

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

The following scopes are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

The following scopes are required to call this endpoint.

Resource Paths

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing asset permissions for subjects (including groups and experiences) and assets your account has access to.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

Bans and blocks

Groups

Places

Universes