# PostgreSQL

PostgreSQL databases are open-source relational database management systems emphasizing extensibility and SQL compliance.

Through this integration, Apono helps you securely manage access to your PostgreSQL instance.

To enable Apono to manage PostgreSQL user access, you must create a user and then configure the integration within the Apono UI.

{% hint style="info" %}
If your PostgreSQL instance runs on a cloud service, follow one of these guides:

* [Azure PostgreSQL](https://docs.apono.io/docs/azure-environment/azure-integrations/azure-postgresql)
* [CloudSQL PostgreSQL](https://docs.apono.io/docs/gcp-environment/gcp-integrations/cloudsql-postgresql)
* [RDS PostgreSQL](https://docs.apono.io/docs/aws-environment/aws-integrations/rds-postgresql)
  {% endhint %}

***

### Prerequisites

<table><thead><tr><th width="231">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 your PostgreSQL databases 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>Use the following steps to update an existing connector:</p><ul><li><a href="../../aws-environment/apono-connector-for-aws/updating-a-connector-in-aws">AWS</a></li><li><a href="../../azure-environment/apono-connector-for-azure/updating-a-connector-in-azure">Azure</a></li><li><a href="../../gcp-environment/apono-connector-for-gcp/updating-a-connector-in-google-cloud">GCP</a></li><li><a href="../../kubernetes-environment/apono-connector-for-kubernetes/updating-a-kubernetes-connector">Kubernetes</a></li></ul></td></tr><tr><td><strong>PostgreSQL Info</strong></td><td><p>Information for the database instance to be integrated:</p><ul><li>Hostname</li><li>Port number</li><li>Database Name</li></ul></td></tr></tbody></table>

***

### Create a PostgreSQL user

You must create a user in your PostgreSQL instance for the Apono connector.

{% hint style="warning" %}
You must use the admin account and password to connect to your database.
{% endhint %}

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

1. In your preferred client tool, create a new user. Use *apono\_connector* for the username. Be sure to set a strong password for the user.\
   \
   You must also grant the `SUPERUSER` role to the user in the database instance.

   ```sql
   CREATE USER apono_connector WITH ENCRYPTED PASSWORD 'password';
   ALTER USER apono_connector WITH SUPERUSER;  
   ```
2. Using the credentials from step **1**, [create a secret](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret) for the database instance.

{% hint style="success" %}
You can also input the user credentials directly into the Apono UI during the [integration process](https://docs.apono.io/docs/connectors-and-secrets/apono-secret-alternative).
{% endhint %}

***

### Integrate PostgreSQL

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-e665b5790ee040f3fdcc43c02ea67751baf925e8%2Fimage%20(54).png?alt=media" alt="" width="563"><figcaption><p>PostgreSQL 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=postgresql) tab, click **PostgreSQL**. The **Connect Integration** page appears.
2. Under **Discovery**, select one or multiple resource types for Apono to discover in all instances of the environment.
3. Click **Next**. The **Apono connector** section expands.
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="202">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Integration Name</strong></td><td>Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow</td></tr><tr><td><strong>Hostname</strong></td><td>Hostname of the PostgreSQL database instance to connect</td></tr><tr><td><strong>Port</strong></td><td><p>Port value for the instance</p><p>By default, Apono sets this value to <em>5432</em>.</p></td></tr><tr><td><strong>Database Name</strong></td><td><p>Name of the database to integrate</p><p>By default, Apono sets this value to <em>postgre.</em></p></td></tr><tr><td><strong>SSL Mode</strong></td><td><p>(Optional) Mode of Secure Sockets Layer (SSL) encryption used to secure the connection with the SQL database server</p><ul><li><strong>require</strong>: An SSL-encrypted connection must be used.</li><li><strong>allow</strong>: An SSL-encrypted or unencrypted connection is used. If an SSL encrypted connection is unavailable, the unencrypted connection is used.</li><li><strong>disable</strong>: An unencrypted connection is used.</li><li><strong>prefer</strong>: An SSL encrypted connection is attempted. If the encrypted connection is unavailable, the unencrypted connection is used.</li><li><strong>verify-ca</strong>: An SSL-encrypted connection must be used and a server certification verification against the provided CA certificates must pass.</li><li><strong>verify-full</strong>: An SSL-encrypted connection must be used and a server certification verification against the provided CA certificates must pass. Additionally, the server hostname is checked against the certificate's names.</li></ul></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="201">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/postgresql) 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 PostgreSQL instance.​


---

# 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.apono.io/docs/additional-integrations/databases-and-data-repositories/postgresql.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.