# Permissions

### Permissions: Defining User Actions

Permissions are the rules that specify the actions users within each group are allowed to perform. They ensure users interact with the application in a way that aligns with their assigned roles and responsibilities, maintaining security and organizational structure.

### Accessing Permissions in the Admin Console

To view and manage permissions:

1. Open the **Admin Console**.
2. Navigate to **Groups & Permissions** and select the **Permissions** tab from the left-hand menu.
3. On the **Permissions** page, you will see a card-based view, with each card representing a specific permission.

### Searching for Permissions

To locate specific permissions:

1. Use the **Search** box at the top of the permissions page.
2. Enter a relevant keyword related to the permission you're looking for.
3. Click the **Search** button to display matching permissions.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FJDFJBlpeOXn7iPFiS3od%2Fpr%201.png?alt=media&#x26;token=c007a8a5-3549-41bb-87bb-fe8f0699aeef" alt=""><figcaption></figcaption></figure>

#### Create Permission&#x20;

To create a new permission:

1. Click the **Create Permission** button.
2. Fill in the required fields as described below.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FfYxpkSLeAczDHpEuOgpu%2Fpr%202.png?alt=media&#x26;token=eacbfc9f-9922-4ddb-a9ac-a80c3f8d8c60" alt=""><figcaption></figcaption></figure>

3. Need to fill below fields,&#x20;

### Permission Details

***Permission Key:*** A unique identifier for the permission. This ensures each permission is distinct within the system.

***Permission Name:*** A human-readable label that describes the permission's purpose, making it easy to identify and manage.&#x20;

***Permission Description:*** Additional context about the permission's purpose and scope. Use this field to clarify its role and any specific use cases.&#x20;

***Metadata Fields (Optional):*** Metadata allows you to attach extra information to the permission in the form of **Key-Value pairs**.

* **Key**: Represents the name of the metadata field.
* **Value**: Provides the specific information or functionality associated with the key.\
  Use metadata to enhance the flexibility and functionality of your permissions.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2Fmc1Wc9eZgc34KjProp3B%2Fpr%203.png?alt=media&#x26;token=006842d1-c919-4135-8697-e02fb06d2c91" alt=""><figcaption></figcaption></figure>

3. After filling in all mandatory fields, click the **Save** button to create the new permission.

The permission will be added to the system and available for assignment or further configuration.

### Editing Permission&#x20;

To edit an existing permission:

1. Navigate to the **Permissions** page and locate the permission you wish to edit.
2. Click the **Edit** icon on the permission's table.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FXL8KxBp3ZHiHv7P3HLgh%2Fpr%204.png?alt=media&#x26;token=d813a12b-b9c4-4563-b530-0adefc16ceef" alt=""><figcaption></figcaption></figure>

3. In the **Edit Permission** modal, make the desired changes, including the permission's **key**, **name**, **description**, and **metadata**.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FWJil4hPQ8B7xCzxhnilD%2Fpr%205.png?alt=media&#x26;token=e916a524-bc2e-43fb-a641-1e5224341ba3" alt=""><figcaption></figcaption></figure>

4. Once you've updated the necessary fields, click the **Save** button to apply the changes.

#### Delete Permission&#x20;

To delete a permission:

1. While in the **Edit Permission** modal, locate the **Delete** button.
2. Click the **Delete** button to initiate the deletion process.
3. A confirmation prompt will appear. Review the details carefully and confirm your decision to permanently delete the permission.

<figure><img src="https://1757876898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNHJr75kSc6HL16U7k3F6%2Fuploads%2FLQY4Xh5U7PFVhCmw1cw9%2Fpr%206.png?alt=media&#x26;token=e1fbc816-d215-4997-ad55-b6baae6e7a2b" alt=""><figcaption></figcaption></figure>

Once deleted, the permission will be permanently removed from the system and cannot be recovered.&#x20;
