> For the complete documentation index, see [llms.txt](https://documentation.immuta.com/saas/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.immuta.com/saas/configuration/integrations/custom-integrations.md).

# Custom Integrations

Learn how to register data from any platform as a custom securable

This page describes the recommended workflow for setting up Immuta with [custom securables](https://documentation.immuta.com/saas/configuration/integrations/custom-integrations/custom-securables-reference-guide.md). Following these steps connects your data, registers users, and enables governance through global policies and access requests.

## Before you begin

To complete this workflow, ensure you have

* An Immuta application administrator who can register the custom connection

For the recommended implementation described on this page, you should also have

* Identified owners or stewards for your major data domains
* An understanding of the metadata maintained in your external catalog, if you use one

{% hint style="info" icon="lightbulb" %}
Completing this workflow typically requires coordination among an Immuta application administrator, governance users, and data stewards.
{% endhint %}

{% stepper %}
{% step %}

## **Register your custom securables**

1. [Register a custom connection](https://documentation.immuta.com/saas/configuration/integrations/custom-integrations/manage-custom-securables.md#register-a-custom-connection).
2. [Add custom securables to that connection](https://documentation.immuta.com/saas/configuration/integrations/custom-integrations/manage-custom-securables.md#add-securables-to-a-custom-connection).
3. After registering the connection, [organize your custom securables into domains](https://documentation.immuta.com/saas/configuration/domains/configure-domains.md). Domains assign ownership of data to the appropriate teams and determine who can manage policies and access workflows for those data sources.
   {% endstep %}

{% step %}

## **Register users**

[Connect your organization's identity provider](https://documentation.immuta.com/saas/configuration/people/section-contents/how-to-guides.md) and configure SSO so that users can authenticate with their existing credentials and be automatically registered in Immuta.

If your identity provider supports SCIM, [enable provisioning to synchronize users, groups, and attributes](https://documentation.immuta.com/saas/configuration/people/section-contents/scim-protocol.md). These attributes can then be used when authoring policies so access automatically changes as the user information in the IAM is synced with Immuta.

{% hint style="info" icon="lightbulb" %}
If your identity provider supports SCIM, synchronize the user attributes that you plan to reference in policies, such as `department`, `region`, or `employment type`. These attributes provide a strong foundation for reusable global policies.
{% endhint %}
{% endstep %}

{% step %}

## **Add metadata to your data**

Metadata allows you to author subscription policies that automatically apply across your securables instead of managing individual objects.

[Add tags to your custom securables](https://documentation.immuta.com/saas/configuration/integrations/custom-integrations/manage-custom-securables.md#manage-custom-securables). Once your data sources are tagged, you can author global subscription policies based on those tags that will automatically apply to the data sources.
{% endstep %}

{% step %}

## **Configure automated subscription policies**

1. Optionally author [global subscription](https://documentation.immuta.com/saas/govern/authoring-policies-in-secure/section-contents/how-to-guides/subscription-policy-tutorial.md) policies that grant access to the securables. Author global policies using metadata and user attributes instead of individual custom securables or users. This allows the same policies to automatically apply as new custom securables are registered and tagged and as users are updated in Immuta.
2. Immuta will not enforce policies on custom securables. You can enforce access controls in your environment using these methods:
   1. Use the Immuta API: Call the [`/dataSource/{dataSourceId}/users/{profileId}/policyInfo`](https://documentation.immuta.com/saas/developer-guides/api-intro/immuta-v1-api/data-sources/get-data-sources.md#get-datasource-datasourceid-users-profileid-policyinfo) endpoint to determine if a specific user should have access to the data object. Contact your Immuta representative for guidance.
   2. [Create a webhook](https://documentation.immuta.com/saas/govern/detect-introduction/notifications/how-to-guides/create-a-webhook.md): Set up your webhook listener to receive notifications for access change events. Contact your Immuta representative for guidance.

For details about policy enforcement options for custom securables, see the [governing custom securables section](https://documentation.immuta.com/saas/configuration/integrations/custom-integrations/custom-securables-reference-guide.md#governing-custom-securables).
{% endstep %}

{% step %}

## **Configure access requests**

Subscription policies can grant access when users meet the required conditions. For access that requires review, configure the [Request app](https://documentation.immuta.com/saas/request/introduction.md).

1. A governance user will [create request forms](https://documentation.immuta.com/saas/request/review-access-requests/how-to-guides/manage-request-forms.md) and attach them to assets so users can request access to the securable.
2. Data stewards can then [review and respond to access requests](https://documentation.immuta.com/saas/request/review-access-requests.md).
   {% endstep %}
   {% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.immuta.com/saas/configuration/integrations/custom-integrations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
