# MySQL

The MySQL integration enables you to securely manage just-in-time (JIT) access to your MySQL instance.

***

### Prerequisites

<table><thead><tr><th width="258">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>Apono Connector</strong></td><td><p>On-prem connection serving as a bridge between a MySQL instance and Apono:</p><ul><li><a href="../../aws-environment/apono-connector-for-aws">AWS</a></li><li><a href="../../azure-environment/apono-connector-for-azure">Azure</a></li><li><a href="../../gcp-environment/apono-connector-for-gcp">GCP</a></li><li><a href="../../kubernetes-environment/apono-connector-for-kubernetes">Kubernetes</a></li></ul><p><strong>Minimum Required Version</strong>: 1.3.0<br><br>Learn how to update an existing <a href="../../aws-environment/apono-connector-for-aws/updating-a-connector-in-aws">AWS</a>, <a href="../../azure-environment/apono-connector-for-azure/updating-a-connector-in-azure">Azure</a>, <a href="../../gcp-environment/apono-connector-for-gcp/updating-a-connector-in-google-cloud">GCP</a>, or <a href="../../kubernetes-environment/apono-connector-for-kubernetes/updating-a-kubernetes-connector">Kubernetes</a> connector.</p></td></tr><tr><td><strong>MySQL Information</strong></td><td><p>Information for the database instance to be integrated:</p><ul><li>Hostname</li><li>Port</li></ul></td></tr></tbody></table>

***

### Create MySQL user

You must create a user in your MySQL instance for the Apono connector and grant that user permissions to your databases.

Follow these steps to create a user and grant it database permissions:

1. In your MySQL client tool, create a new user. Use *apono\_connector* or another name of your choosing for the username. Be sure to set a strong password for the user.

```sql
CREATE USER 'apono_connector'@'%' IDENTIFIED BY 'password';
```

2. Grant the following access to the user. These permissions allow the connector to list databases, manage users, update internal tables, monitor sessions, reload privileges, and handle connection-related operations.

```sql
GRANT SHOW DATABASES ON *.* TO 'apono_connector'@'%';
GRANT CREATE USER ON *.* TO 'apono_connector'@'%';  
GRANT UPDATE ON mysql.* TO 'apono_connector'@'%';  
GRANT PROCESS ON *.* TO 'apono_connector'@'%';
GRANT RELOAD ON *.* TO 'apono_connector'@'%';
GRANT CONNECTION ADMIN ON *.* TO 'apono_connector'@'%';
```

{% hint style="warning" %}
If the Apono integration needs to manage MySQL users who have the `SYSTEM_USER` privilege, you must also grant `SYSTEM_USER` to the Apono connector user.

```sql
GRANT SYSTEM_USER ON *.* TO 'apono_connector'@'%';
```

Without this permission, operations such as granting roles or modifying such users will fail with an `Access denied` error.
{% endhint %}

3. Grant the user **only one** of the following sets of permissions. The chosen set defines the highest level of permissions to provision with Apono.\
   \
   Click on each tab to reveal the SQL commands.

{% tabs %}
{% tab title="READ\_ONLY" %}
Allows Apono to read data from databases

```sql
GRANT SELECT ON *.* TO 'apono_connector'@'%';  
GRANT GRANT OPTION ON *.* TO 'apono_connector'@'%';
```

{% endtab %}

{% tab title="READ\_WRITE" %}
Allows Apono to read and modify data

{% code overflow="wrap" %}

```sql
GRANT SELECT,ALTER,ALTER ROUTINE,CREATE,CREATE ROUTINE,CREATE TEMPORARY TABLES,CREATE VIEW,DELETE,INDEX,INSERT,TRIGGER,UPDATE ON *.* TO 'apono_connector'@'%';  
GRANT GRANT OPTION ON *.* TO 'apono_connector'@'%';
```

{% endcode %}
{% endtab %}

{% tab title="ADMIN" %}
Allows Apono administrative-level access, including the ability to execute and drop tables

{% code overflow="wrap" %}

```sql
GRANT EXECUTE,DROP,SELECT,ALTER,ALTER ROUTINE,CREATE,CREATE ROUTINE,CREATE TEMPORARY TABLES,CREATE VIEW,DELETE,INDEX,INSERT,TRIGGER,UPDATE ON *.* TO 'apono_connector'@'%';  
GRANT GRANT OPTION ON *.* TO 'apono_connector'@'%';
```

{% endcode %}
{% endtab %}
{% endtabs %}

4. (MySQL 8.0+) Grant the user the authority to manage other roles. This enables Apono to create, alter, and drop roles. However, this role does not inherently grant specific database access permissions.

```sql
GRANT ROLE_ADMIN on *.* to apono_connector;
```

5. [Create a secret](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret) with the credentials from step **1**.\
   \
   Use the following key-value pair structure when generating the secret. Be sure to replace `#PASSWORD` with the actual value. If you used a different name for the user, replace `apono-connector` with the name you assigned to the user.

```
"username": "apono-connector",
"password": "#PASSWORD"
```

{% hint style="success" %}
You can also input the user credentials directly into the Apono UI during the integration process.
{% endhint %}

You can now [integrate your MySQL database.](#integrate-mysql)

***

### Integrate MySQL

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-bed4036852c74af0bf41d6ef09343bab4d886b3f%2Fintegrate-mysql.png?alt=media" alt="" width="375"><figcaption><p>MySQL tile</p></figcaption></figure>

{% hint style="success" %}
You can also use the steps below to integrate with Apono using Terraform.

In step **11**, instead of clicking **Confirm**, follow the **Are you integrating with Apono using Terraform?** guidance.
{% endhint %}

Follow these steps to complete the integration:

1. On the [**Catalog**](https://app.apono.io/catalog?search=mysql) tab, click **MySQL**. The **Connect Integration** page appears.
2. Under **Discovery**, click one or more resource types to sync with Apono.

{% hint style="info" %}
Apono automatically discovers and syncs all the resources in the environment. After syncing, you can manage access flows to these resources.
{% endhint %}

3. Click **Next**. The **Apono connector** section appears.
4. From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

{% hint style="success" %}
If the desired connector is not listed, click **+ Add new connector** and follow the instructions for creating a connector ([AWS](https://docs.apono.io/docs/aws-environment/apono-connector-for-aws), [Azure](https://docs.apono.io/docs/azure-environment/apono-connector-for-azure), [GCP](https://docs.apono.io/docs/gcp-environment/apono-connector-for-gcp), [Kubernetes](https://docs.apono.io/docs/kubernetes-environment/apono-connector-for-kubernetes)).
{% endhint %}

5. Click **Next**. The **Integration Config** section expands.
6. Define the **Integration Config** settings.

   <table><thead><tr><th width="229">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Integration Name</strong></td><td>Unique, alphanumeric, user-friendly name used to identify the integration when constructing an access flow</td></tr><tr><td><strong>Hostname</strong></td><td>Hostname of the MySQL database to connect</td></tr><tr><td><strong>Port</strong></td><td>Port value for the instance<br><br><strong>Default Value</strong>: <em>3306</em>.</td></tr></tbody></table>
7. Click **Next**. The **Secret Store** section expands.
8. [Associate the secret or credentials](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret).
9. Click **Next**. The **Get more with Apono** section expands.
10. Define the **Get more with Apono** settings.

    <table><thead><tr><th width="231">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Credential Rotation</strong></td><td>(Optional) Number of days after which the database credentials must be rotated<br><br>Learn more about the <a href="../../architecture-and-security/credentials-rotation-policy">Credentials Rotation Policy</a>.</td></tr><tr><td><strong>User cleanup after access is revoked (in days)</strong></td><td><p>(Optional) Defines the number of days after access has been revoked that the user should be deleted</p><p><br>Learn more about <a href="../../architecture-and-security/periodic-user-cleanup-and-deletion">Periodic User Cleanup &#x26; Deletion</a>.</p></td></tr><tr><td><strong>Custom Access Details</strong></td><td>(Optional) Instructions explaining how to access this integration's resources<br><br>Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to <strong>400 characters</strong>.<br><br>To view the message as it appears to end users, click <strong>Preview</strong>.</td></tr><tr><td><strong>Integration Owner</strong></td><td><p>(Optional) Fallback approver if no <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owner</a> is found<br><br>Follow these steps to define one or several integration owners:</p><ol><li>From the <strong>Attribute</strong> dropdown menu, select <strong>User</strong> or <strong>Group</strong> under the relevant identity provider (IdP) platform.</li><li>From the <strong>Value</strong> dropdown menu, select one or multiple users or groups.</li></ol><p><br><strong>NOTE</strong>: When <strong>Resource Owner</strong> is defined, an <strong>Integration Owner</strong> must be defined.</p></td></tr><tr><td><strong>Resource Owner</strong></td><td><p>(Optional) Group or role responsible for managing access approvals or rejections for the resource<br><br>Follow these steps to define one or several <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owners</a>:</p><ol><li>Enter a <strong>Key name</strong>. This value is the name of the tag created in your cloud environment.</li><li>From the <strong>Attribute</strong> dropdown menu, select an attribute under the IdP platform to which the key name is associated.<br><br>Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.</li></ol><p><br><strong>NOTE</strong>: When this setting is defined, an <strong>Integration Owner</strong> must also be defined.</p></td></tr></tbody></table>
11. Click **Confirm**.

<details>

<summary>💡Are you integrating with Apono using Terraform?</summary>

If you want to integrate with Apono using Terraform, follow these steps instead of clicking **Confirm**:

1. At the top of the screen, click **View as Code**. A modal appears with the completed Terraform configuration code.
2. Click to copy the code.
3. Make any additional edits.
4. Deploy the code in your Terraform.

Refer to [Integration Config Metadata](https://docs.apono.io/metadata-for-integration-config/integration-metadata/mysql) for more details about the schema definition.

</details>

Now that you have completed this integration, you can [create access flows](https://docs.apono.io/docs/access-flows/access-flows) that grant permission to your MySQL database.