Roblox Cloud icon

Roblox Cloud

Access Roblox Open Cloud APIs for groups, users, universes, places, storage, and more

Actions94

Universe → Update Universe User Restriction

AI-generated

Overview

This node operation updates a user restriction within a Roblox Universe. It allows modifying specific fields of a user restriction, such as activation status, display reason, duration, exclusion of alternate accounts, private reason, and start time. This is useful for managing user access and restrictions dynamically in a Roblox game universe, for example, to temporarily ban or restrict users from joining the game under certain conditions.

Use Case Examples

  1. Updating a user's game join restriction to temporarily ban them from joining a universe.
  2. Changing the display reason for a user restriction to inform the user why they are restricted.
  3. Setting a restriction duration to automatically lift the restriction after a certain time.

Properties

Name Meaning
Universe ID The unique identifier of the Roblox Universe where the user restriction exists. Required to specify which universe to update the restriction in.
User Restriction ID The unique identifier of the user restriction to update within the specified universe. Required to identify the specific restriction to modify.
Idempotency Key A unique key used to ensure the update request is idempotent, preventing duplicate updates if the request is retried.
Idempotency Key First Sent The ISO timestamp indicating when the first idempotent request was sent, used for idempotency control.
Update Mask Specifies which fields of the user restriction to update. Typically set to 'game_join_restriction' as nested fields are not supported.
Update Fields A collection of fields within the game join restriction to update, including active status, display reason, duration, exclusion of alternate accounts, private reason, and start time.
Request Options Node-level settings for request behavior, including batching, SSL certificate validation, proxy usage, and timeout settings.

Output

JSON

  • userRestrictionId - The identifier of the updated user restriction.
  • universeId - The identifier of the universe where the restriction was updated.
  • gameJoinRestriction
    • active - Indicates if the user restriction is active.
    • displayReason - The public reason displayed to the user for the restriction.
    • duration - Duration of the restriction if set.
    • excludeAltAccounts - Whether alternate accounts are excluded from the restriction.
    • privateReason - The private reason for the restriction.
    • startTime - The start time of the restriction.

Dependencies

  • Roblox Open Cloud API access with an API key credential

Troubleshooting

  • Ensure the Universe ID and User Restriction ID are correct and exist in Roblox Cloud to avoid 'not found' errors.
  • Verify that the idempotency key is unique for each distinct update request to prevent unintended duplicate updates.
  • Check that the update mask is correctly set to 'game_join_restriction' as nested fields are not supported, otherwise the update may fail.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors can occur if the server is slow to respond; adjust the timeout setting accordingly.

Links

Discussion