Roblox Cloud icon

Roblox Cloud

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

Actions94

Universe → Get Place User Restriction

AI-generated

Overview

This node operation retrieves a specific user restriction applied to a user within a particular place in a Roblox universe. It is useful for administrators or developers managing user permissions and restrictions in their Roblox game environments. For example, it can be used to check if a user is banned or restricted from accessing certain features or areas within a game place.

Use Case Examples

  1. Retrieve a user restriction to verify if a player is banned from a specific place in a Roblox universe.
  2. Check user restrictions before allowing access to certain game features or content.

Properties

Name Meaning
Universe ID The unique identifier of the Roblox universe where the place and user restriction exist.
Place ID The unique identifier of the place within the universe for which the user restriction is being retrieved.
User Restriction ID The unique identifier of the specific user restriction to retrieve.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to customize the API request behavior.

Output

JSON

  • userRestrictionId - The unique identifier of the user restriction retrieved.
  • placeId - The unique identifier of the place associated with the user restriction.
  • universeId - The unique identifier of the universe associated with the place and user restriction.
  • restrictionDetails - Details about the user restriction, such as type, duration, and reason.

Dependencies

  • An API key credential for Roblox Cloud API authentication

Troubleshooting

  • Ensure that the Universe ID, Place ID, and User Restriction ID are correctly provided and valid; otherwise, the API may return errors or no data.
  • Check network connectivity and proxy settings if the request times out or fails to connect.
  • If SSL certificate validation fails and the option to ignore SSL issues is not enabled, the request will be rejected.
  • Verify that the API key credential has the necessary permissions to access user restriction data in the Roblox Cloud API.

Discussion