Setup & API Keys
Create your org, claim your Roblox places, get your API key, and configure departments so your staff team has the right access from day one.
Creating an organisation#
- 1
Sign in with Roblox
Go to the RoPerms homepage and click Sign in with Roblox. Authorise the app. You will land on the org selector page. - 2
Create a new org
Click New Organisation. Enter your community's name. An org is created and you are automatically assigned the ORG_ADMIN role. - 3
Configure branding
In Settings → Branding, upload a logo and set your primary and secondary brand colours. These appear throughout the dashboard for all members of your org.
Claiming places#
Every Roblox place that will use the SDK must be claimed by your org. The API key checks that requests come from a claimed place — unclaimed places are rejected.
- 1
Go to Settings → Places
In your org Settings, open the Places tab. - 2
Add a place
Click Claim Place and enter the numeric Roblox Place ID. You can find your Place ID in the Roblox Creator Dashboard under your experience. - 3
Repeat for each place
If your experience has multiple places (lobby, main game, etc.), claim each one. All claimed places share the same API key.
Getting your API key#
Navigate to Settings → API. Your API key is displayed here. Click Copy to copy it to the clipboard.
✕Keep your API key secret
If you believe your key has been compromised, click Regenerateto invalidate the old key and generate a new one. Update the key in your in-game scripts immediately after regenerating.
Configuring departments#
Departments are bundles of capabilities that you assign to staff members. A staff member's combined capabilities from all their departments determines what they can do in the dashboard.
Creating a department
- 1
Go to Settings → Departments
Click New Department. - 2
Name the department
Give it a descriptive name (e.g., "Moderator", "Trainer", "Senior Staff"). - 3
Select capabilities
Tick the capabilities this department should grant. Common setups:- Moderator:
users.ban,users.kick,users.warn,modcalls.handle - Trainer:
sessions.host,sessions.view - Senior: all of the above +
investigations.create
- Moderator:
- 4
Optional: auto-assign by rank
Set a minimum Roblox group rank to auto-assign this department when members join the org. Leave blank for manual assignment only.
Assigning staff to departments
Go to Team in the sidebar. Find the staff member and click their row. In the edit panel, add or remove departments. Changes take effect immediately.
Adding staff members#
Staff members must have a RoPerms account (they need to sign in with Roblox at least once). To add them to your org:
- 1
Go to Settings → Members
Click Invite Member. - 2
Enter their Roblox username
RoPerms will look up their account. If they have not signed in to RoPerms yet, the invite will be queued until they do. - 3
Choose a role
Staff for regular members or Org Admin for trusted managers who need full access. Org admins implicitly hold every capability.
Settings reference#
The full Settings page covers:
- Branding — logo, primary colour, secondary colour.
- Places — claimed place IDs.
- API — view, copy, and regenerate your API key.
- Departments — create, edit, delete departments and their capabilities.
- Members — invite, role-change, and remove staff.
- Session Types — define training session structures with phases and pass ranks.
- Payment Categories & Items — catalogue of items for payment links.
- Integrations — ranking credentials (Roblox cookie or Open Cloud OAuth).