# Ace Permission Sync

This module manages player's in-game permissions right from the CMS!

![Sonoran CMS - ACE Permission Sync](/files/wnqtr7N7LsP0Yor3uBPb)

{% embed url="<https://www.youtube.com/watch?v=4PAtKYQokXE>" %}

### Installation / Configuration

{% hint style="info" %}
With core version `v1.4.0` the Ace Permission Sync resource was converted to a core module and no longer requires manual installation just configuration.
{% endhint %}

### 1. Ensure Resource Has Permissions

Ensure you have the following in your `server.cfg` (if you don't permissions won't be able to be granted)

```
add_ace resource.sonorancms command allow
```

### 2. Configure Rank Mappings via UI

Navigate to either game panel's within your Sonoran CMS community and open up the *Aces & Principals* tab.

This is where you can configure ranks to principal groups, simply select the ranks you want to map to individual groups.

<figure><img src="https://i.imgur.com/j5XTpYT.png" alt=""><figcaption></figcaption></figure>

### 3. Configure Aces & Principals via Server.CFG

Locate and open up your `server.cfg`

Configure your aces and principals to how you desire while following the syntax for [proper ace & principal commands](https://forum.cfx.re/t/basic-aces-principals-overview-guide/90917)

### 4. Add your API ID

Ensure all players have added their [API ID](/cms/developer-api-documentation/api-integration/getting-started/api-id-system.md) to the CMS!

## Functionality

### Permissions On Join

When a player joins the server, the resource will ask the CMS for the players ranks. ACE permissions will be assigned based on the configuration.

### Permissions on Push Event

{% hint style="info" %}
Due to restrictions in the way that some resources like vMenu are programmed, you must relog for the CMS permissions to take effect if they are altered for a user while they are online.
{% endhint %}

For communities on the **Plus** plan or higher, permissions can be synced instantly in-game when ranks are updated.

Simply add your FiveM server's public IP address and at `Administrative Panel` > `Integrations` > `Sonoran CMS API` > `Servers`.

![Sonoran CMS - API Integration Servers Tab](/files/EpFNb4xrZ9U9b3uq5Yov)

### Manual Sync

{% hint style="info" %}
Due to restrictions in the way that some resources like vMenu are programmed, you must relog for the CMS permissions to take effect if they are altered for a user while they are online.
{% endhint %}

Individual players can run the `/refreshpermissions` command in-game to force a permissions update.

## Example Configuration

### Game Panel -> Aces & Principals

<figure><img src="https://i.imgur.com/D3T5ZYw.png" alt=""><figcaption></figcaption></figure>

### permissions.cfg/server.cfg

{% hint style="warning" %}
This example is just an example of how you may setup ace permissions and it is unlikely to work just copy and pasted.
{% endhint %}

```markdown
### Ace Permissions

## Inheritance
add_principal group.admin group.mod
add_principal group.policesup group.police

## Permissions
add_ace group.admin command allow
add_ace group.mod admin.kick allow
add_ace group.policesup police.supcar allow
add_ace group.police police.car allow
```

## Reliability Notice

In the event that the CMS API is temporarily unavailable, this resource utilizes a local backup cache. The resource will automatically fall back to the latest saved version of the permissions list, allowing members to access permissions as normal.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sonoransoftware.com/cms/integration-capabilities/in-game-integration-resources/core/core-submodules/ace-permission-sync.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.