Microsoft SQL Server

Create an integration to manage access to a Microsoft SQL Server database

Microsoft SQL Server is a reliable and secure relational database management system. It can be used as the main data store for various applications, websites, and products.

Microsoft enables developers to create cloud-hosted SQL Server databases.

Through this integration, Apono helps you securely manage access to your Microsoft SQL Server database.

Prerequisites

Item
Description

Apono Connector

On-prem connection serving as a bridge between a Microsoft SQL Server database instance and Apono:

Microsoft SQL Server Info

Information for the database instance to be integrated:

  • Hostname

  • Port number

Create a Microsoft SQL Server user

You must create a user in your Microsoft SQL Server instance for the Apono connector.

Use the following steps to create a user and grant it permissions to your databases:

  1. In your preferred client tool, create a new user. Be sure to set a strong password for the user.

The password must be a minimum of 8 characters and include characters from at least three of these four categories:

  • Uppercase letters

  • Lowercase letters

  • Digits (0-9)

  • Symbols

CREATE LOGIN apono_connector WITH PASSWORD = 'password';

  1. Expose databases to the user. This allows Apono to view database names without accessing the contents of each database.

GRANT VIEW ANY DATABASE TO apono_connector;

  1. Grant the ALTER ANY LOGIN database permissions to the user in all the databases.

 USE master GRANT ALTER ANY LOGIN TO apono_connector;

  1. Grant the user ADMIN permissions: Allows Apono to grant users administrative-level access, including the ability to execute and drop tables\

USE master GRANT CONTROL SERVER TO apono_connector;

Grant and revoke server-level roles with Apono

To use Apono for MS SQL server-level roles, you must assign the Apono connector user the securityadmin role.

USE master ALTER SERVER ROLE securityadmin ADD MEMBER server_principal

Members of the securityadmin fixed server role can GRANT, DENY, and REVOKE server-level permissions. They can also GRANT, DENY, and REVOKE database-level permissions if they have access to a database. Additionally, they can reset passwords for SQL Server logins.

  1. Using the credentials from step 1, create a secret for the database instance.

You can now integrate Microsoft SQL Server.

Integrate Microsoft SQL Server

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.

Follow these steps to complete the integration:

  1. On the Catalog tab, click Microsoft SQL Server. The Connect Integration page appears.

  2. Under Discovery, click one or more resource types to sync with Apono.

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flow to these resources.

  1. Click Next. The Apono connector section expands.

  2. 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.

If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).

  1. Click Next. The Integration Config section expands.

  2. Define the Integration Config settings.

    Setting
    Description

    Integration Name

    Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow

    Hostname

    Hostname of the Microsoft SQL Server instance to connect

    Port

    Port value for the instance By default, Apono sets this value to 1433.

    Database Name

    Name of the database By default, Apono sets this value to master.

  3. Click Next. The Secret Store section expands.

  4. Associate the secret or credentials.

  5. Click Next. The Get more with Apono section expands.

  6. Define the Get more with Apono settings.

    Setting
    Description

    Credential Rotation

    (Optional) Number of days after which the database credentials must be rotated

    Custom Access Details

    (Optional) Instructions explaining how to access this integration's resources 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 400 characters. To view the message as it appears to end users, click Preview.

    Integration Owner

    1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.

    2. From the Value dropdown menu, select one or multiple users or groups.

    NOTE: When Resource Owner is defined, an Integration Owner must be defined.

    Resource Owner

    1. Enter a Key name. This value is the name of the tag created in your cloud environment.

    2. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. 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.

    NOTE: When this setting is defined, an Integration Owner must also be defined.

  7. Click Confirm.

💡Are you integrating with Apono using Terraform?

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 for more details about the schema definition.

Now that you have completed this integration, you can create access flows that grant permission to your Microsoft SQL Server database.

PreviousElasticsearchNextMongoDB

Last updated