LogoLogo
SupportServer Hosting
  • Sonoran CMS
  • 📱Download the App
  • Other Products
    • 🖥️ FiveM Hosting
    • ⌨️ Sonoran CAD
    • 📡Sonoran Radio
  • Why choose Sonoran CMS?
    • 🏆Why Choose Sonoran CMS?
  • Tutorials
    • Getting Started
      • Account Registration
      • Community Registration
      • Inviting Users
      • Troubleshooting
    • User Management
      • Creating Ranks
      • Setting User Ranks
      • Community Profile
      • Creating Rosters
    • Community Website
      • Website Builder
      • Toolbar Customization
      • Forums
      • Image Gallery
      • Navigation Permissions
    • Customization
      • Community Branding and Settings
      • Custom Domain / Vanity URL
      • Profile Fields
    • Calendar Events
    • Drive & Documents
    • Forms and Applications
      • Creating Forms
      • Form Submissions
      • Clock In/Out System
    • Administrative
      • Archive Community Member
      • Delete & Transfer Community
      • Delete User Account
      • View Your Limits
      • Growth and Discovery
        • Growth Panel
        • Discovery
      • Security Center
        • Account Flags
        • Logging Center
      • Disciplinary Panel
      • URL Shortener
  • Integration Capabilities
    • Sonoran CAD Sync
    • Sonoran Radio Sync
    • Discord Bot Integration
    • TeamSpeak 3 Role Sync
      • Getting Started
      • Adding Ranks
      • Adding your TeamSpeak UID
    • Discord Rich Presence
    • Discord Webhooks
    • FiveM Game Panel
      • Installation
      • QBCore & Qbox Panel
        • Dashboard
        • Players
        • Vehicles
        • Whitelist
        • Logs
        • Resources
        • Aces & Principals
        • Characters
        • Items
        • Jobs
        • Gangs
        • Job Sync
        • Environment
      • vMenu Panel
        • Dashboard
        • Players
        • Vehicles
        • Environment
        • Whitelist
        • Logs
        • Resources
        • Aces & Principals
    • Sonoran Shield
    • In-Game Integration Resources
      • FiveM Installation
        • FiveM Installation - Next Steps
        • FiveM Submodules
          • Clock In
          • Ace Permission Sync
          • Whitelist
          • Job Sync
      • Minecraft Integrations
        • Minecraft Resource Installation
        • Available Resources
          • Whitelist
      • Roblox Integrations
        • Roblox Resource Installation
        • Available Resources
          • Whitelist
      • IP Whitelisting
  • Developer API Documentation
    • 📖API Integration
      • Getting Started
        • Retrieving Your Credentials
        • API ID System
      • Push Events
        • Account Updated
        • Account Kicked
        • Account Banned
      • API Endpoints
        • General
          • Get Sub Version
          • Check Com API ID
          • Get Com Account
          • Get Current Clock In
          • Get Accounts
          • Get Departments
          • Get Profile Fields
          • Get Account Ranks
          • Set Account Ranks
          • Clock In Out
          • Kick Account
          • Ban Account
          • Edit Account Profile Fields
        • Servers
          • Get Game Servers
          • Set Game Servers
          • Verify Whitelist
          • Full Whitelist
        • Events
          • RSVP
        • Rosters
          • Get Roster Contents
        • Disciplinary
          • Get Member Points
          • Get Member Records
          • Add Member Record
          • Update Member Record Points
          • Update Member Record Reason
    • 🌎Translation Support
  • Roadmap
    • 📋Changelog
  • Other
    • Sonoran CMS
    • AI QA
    • Contact Us
    • Policy
      • Terms of Service
      • Privacy Policy
      • Refund and Purchase Policy
      • Promotions
        • 03/10/25-03/17/25 Suggestions
  • Pricing
    • Pricing FAQ
      • Branding Removal
      • Military and First Responder Discount
      • Expert Installation
      • Free Plugin Installation and Discount - Sonoran Servers
      • Accessing the Payment Center
      • Create and Manage a Subscription
      • Request Discord Role
    • View and Compare Plans
Powered by GitBook
On this page
  • Installation
  • 1. Download the Resource
  • 2. Install the Resource
  • 3. Setup Whitelist Permissions
  • 4. Add your API ID
  • Configuration

Was this helpful?

Edit on GitHub
  1. Integration Capabilities
  2. In-Game Integration Resources
  3. Minecraft Integrations
  4. Available Resources

Whitelist

A whitelist system that utilizes Sonoran CMS's game whitelist system.

PreviousAvailable ResourcesNextRoblox Integrations

Last updated 1 year ago

Was this helpful?

All players of your server must have their setup and must be given a rank that has whitelist permissions for the specified server.

Looking for VPS, web, or dedicated hosting? Check out our official !

This resource is a whitelist system that utilizes Sonoran CMS's game whitelist system by checking against that whitelist upon each player connection.

Installation

1. Download the Resource

Ensure that you download the one that has forge in the name.

Ensure that you download the one that has fabric in the name.

Ensure that you download the one that has plugin in the name.

2. Install the Resource

3. Setup Whitelist Permissions

Navigate to the Rank Manager within the Administrative Panel.

Administrative Panel > Ranks

For users in your Sonoran CMS community to be accepted through the whitelist, they'll need to be granted permission for the whitelist through rank permissions. You will need to grant each rank the permission of Allow Whitelist that you want to be allowed through the whitelist. You will want to grant each rank with the permission of Block Whitelist if you want them to be blocked from passing through the whitelist.

Block Whitelist will ALWAYS overrule Allow Whitelist If a user is granted both Block Whitelist and Allow Whitelist through various ranks they will be blocked from the whitelist. Block will always overrule allow.

4. Add your API ID

Configuration

The config file is called cmswhitelist-common.toml in the config folder of your Minecraft server folder.

[SonoranCMS]
	#This is your SonoranCMS Community ID.
	"Community ID" = ""
	#This is your SonoranCMS API key.
	"Community API Key" = ""
	#Which identifier to use, either UUID or Username. UUID is preferred.
	"Identifier Type" = "UUID"
	#The server ID found in SonoranCMS that this whitelist should check against.
	"Server ID" = 1
Value Name
Description
Default

Server ID

This is the game server ID set in the CMS management panel.

1

Community ID

This is the community ID that is found in the API Integration section of the management panel.

""

Community API Key

This is the API key listed in the API Integration section of the management panel.

""

Identifier Type

This controls whether a player's UUID or username is used for identifying.

"UUID" (Recommended)

The config file is called sonorancms.json in the config folder of your Minecraft server folder.

{
  "CMS_Settings": {
    "Community_ID": "",
    "Community_API_Key": "",
    "Identifier": "UUID",
    "Server_ID": 1
  }
}
Value Name
Description
Default

Server_ID

This is the game server ID set in the CMS management panel.

1

Community_ID

This is the community ID that is found in the API Integration section of the management panel.

""

Community_API_Key

This is the API key listed in the API Integration section of the management panel.

""

Identifier

This controls whether a player's UUID or username is used for identifying.

"UUID" (Recommended)

The config file is called config.yml in the plugins/SonoranCMSWhitelist folder of your Minecraft server folder.

CommunityID: ''
CommunityAPIKey: ''
Identifier: UUID
ServerID: 1
Value Name
Description
Default

ServerID

This is the game server ID set in the CMS management panel.

1

CommunityID

This is the community ID that is found in the API Integration section of the management panel.

''

CommunityAPIKey

This is the API key listed in the API Integration section of the management panel.

''

Identifier

This controls whether a player's UUID or username is used for identifying.

UUID (Recommended)

You can download a copy .

You can download a copy .

You can download a copy .

Follow the standard resource installation guide for the whitelist resource, available .

Ensure all players have added their to the CMS!

here
here
here
here
API ID
API ID
server hosting
Sonoran CMS Departments & Ranks
Sonoran CMS - Rank Manager Server Permissions