## Integrate ServiceNow

URL: https://docs.atlan.com/product/integrations/project-management/servicenow/how-tos/integrate-servicenow

> If your Atlan admin has [enabled the governance workflows and inbox module](/product/capabilities/governance/stewardship/how-tos/automate-data-governance) in your Atlan workspace, you can create a ServiceNow integration to allow your users to [grant or revoke data access](/product/capabilities/governance/stewardship/how-tos/automate-data-governance) for governed assets in Atlan or any other data source.

:::warning Who can do this?
 You will need to be an [admin](https://docs.atlan.com/llms/governance/access-control/delegate-administration/llms.txt) in Atlan to configure the ServiceNow integration. You will also need inputs and approval from a System Administrator of your ServiceNow instance with a [security\_admin role](https://www.servicenow.com/docs/bundle/xanadu-platform-security/page/administer/security/concept/c_ElevatedPrivilege.html#d89862e100).

:::

:::warning

If your ServiceNow instance is behind a VPN or firewall, you must add the Atlan IP to your allowlist. Please raise a support ticket from within Atlan or [submit a request](https://docs.atlan.com/support/submit-request). (If you are not using the IP allowlist, you can skip this step.)

:::

If your Atlan admin has [enabled the governance workflows and inbox module](https://docs.atlan.com/llms/governance/stewardship/automate-data-governance/llms.txt) in your Atlan workspace, you can create a ServiceNow integration to allow your users to [grant or revoke data access](https://docs.atlan.com/llms/governance/stewardship/automate-data-governance/llms.txt) for governed assets in Atlan or any other data source.

This is only applicable if you:

- [Enable governance workflows](https://docs.atlan.com/llms/governance/stewardship/automate-data-governance/llms.txt)
- [Want to use the data access approval workflow](https://docs.atlan.com/llms/governance/stewardship/automate-data-governance/llms.txt)

To integrate ServiceNow and Atlan, follow these st

eps.

## Create an OAuth application in ServiceNow

You will need to create an OAuth application endpoint for Atlan to access your ServiceNow instance.

To [create an OAuth application](https://www.servicenow.com/docs/bundle/xanadu-platform-security/page/administer/security/task/t_CreateEndpointforExternalClients.html), from within ServiceNow:

1. Log in to your ServiceNow instance as a System Administrator with a security\_admin role.
2. From the address bar at the top of your browser window, copy the ServiceNow instance URL - for example, `https://<instance_name>.service-now.com`. This will be required to [connect Atlan to your ServiceNow instance](#connect-atlan-to-servicenow).
3. From the top header of your ServiceNow instance, click **All**. From the dropdown, search for and select **System OAuth** and then click **Application Registry**.
4. In the top-right corner of the _Application Registries_ page, click **New** to create a new OAuth application.
5. In the corresponding screen, for _What kind of OAuth application?_, click **Create an OAuth API endpoint for external clients**.
6. In the _Application Registries New record_ form, enter the following details: 
 1. For _Name_, enter `Atlan OAuth App`.
 2. For _Redirect URL_, enter the redirect URL in the following format - `https://<atlan_instance_name>/oauth-callback`. Replace `<atlan_instance_name>` with the name of your Atlan instance.
 3. For _Logo URL_, copy and paste `https://assets.atlan.com/assets/atlan-primary-logo-png.png`.
 4. Click **Submit** to create the OAuth application in ServiceNow.
7. From the _Application Registries_ page, select the OAuth application you created above. Copy the values for **Client ID** and **Client Secret** and store them in a secure location.

## Connect Atlan to ServiceNow

To connect Atlan to ServiceNow, you will need the following:

- ServiceNow instance URL - for example, `https://<instance_name>.service-now.com`
- Client ID and client secret of the OAuth application you created in ServiceNow

To connect Atlan to ServiceNow, from within Atlan:

1. Log in to your Atlan instance as an admin user.
2. In your Atlan workspace, click **Settings** from the left menu.

 If you are using the **Old UI (Classic)**, from the left menu, click **Admin**.

3. Click **Integrations**.
4. In the _ServiceNow_ tile, click the **Connect** button.
5. In the corresponding _Add to ServiceNow_ dialog, for _ServiceNow URL_, enter the [URL of your ServiceNow instance](#create-an-oauth-application-in-servicenow) - for example, `https://<instance_name>.service-now.com`.
6. Click **Next** to proceed.
7. This step requires the creation of an OAuth application in ServiceNow, [follow the steps to do so](#create-an-oauth-application-in-servicenow). If you have already created it, in the _Create OAuth app_ section, for _Copy the Client ID and Secret from the new OAuth app and paste below_, enter the following:
 - For _Client ID_, enter the [client ID you copied from ServiceNow](#create-an-oauth-application-in-servicenow).
 - For _Client Secret_, enter the [client secret you copied from ServiceNow](#create-an-oauth-application-in-servicenow).
8. Click **Next** to proceed.
9. In the _Commit update set_ section, click **Atlan Update Set.xml** to download the update set XML file from Atlan to [import and commit in ServiceNow](#import-and-commit-the-update-set-xml-file).

## Configure the Atlan integration in ServiceNow

To configure the Atlan integration in ServiceNow, your ServiceNow System Administrator with a security\_admin role will need to complete the following two steps:

1. [Import and commit the update set XML file](https://www.servicenow.com/docs/bundle/utah-it-service-management/page/product/site-reliability-ops/task/sro-update-set-quick-start.html) downloaded from Atlan to create an Atlan data access catalog and business rule in ServiceNow.
2. [Create a new user](https://www.servicenow.com/docs/fr-FR/bundle/xanadu-platform-administration/page/administer/users-and-groups/task/t_CreateAUser.html) in ServiceNow for the Atlan integration.

### Import and commit the update set XML file

To [import and commit the update set XML file](https://www.servicenow.com/docs/bundle/utah-it-service-management/page/product/site-reliability-ops/task/sro-update-set-quick-start.html), from within ServiceNow:

1. Log in to your ServiceNow instance as a System Administrator with a security\_admin role.
2. From the top header of your ServiceNow instance, click **All**. From the dropdown, search for and select **System Update Sets** and then click **Retrieved Update Sets**.
3. On the _Retrieved Update Sets_ page, under _Related Links_, click the **Import Update Set from XML** link.
4. On the _Import XML_ page, to upload the [update set XML file downloaded from Atlan](#import-and-commit-the-update-set-xml-file):
 1. For _Step 1: Choose file to upload_, click **Choose file** to upload the _Atlan Update Set.xml_ file.
 2. For _Step 2: Upload the file_, click the **Upload** button.
5. In the top-left corner of your screen, click the back button to return to the _Retrieved Update Sets_ page. The Atlan update set will appear on the _Retrieved Update Set_ list in a _Loaded_ state. Once the XML file has successfully loaded, select the **Atlan Update Set**.
6. Click **Preview Update Set** to preview the update set and address any issues. The update set includes the following:
 - _Atlan Data Access_ catalog - Atlan will create data access requests in this catalog.
 - _Atlan Business Rule_ - this is required for Atlan to receive events from your ServiceNow instance to detect any changes in the status of data access requests created in Atlan and automatically update governance workflow requests.
 - Atlan service role and access control list (ACL) updates - the Atlan service account requires a role with write access on the `sc_request` table to update specific fields such as `description`, `short_description`, and more. This operation especially requires the security\_admin role to commit the update set from Atlan in ServiceNow.
 - _Scripted REST API_ - this is initially required to retrieve the username and sys\_id of the Atlan user completing the ServiceNow integration. Atlan creates a Scripted REST API `/api/snc/oauth_userinfo` that returns the username and sys\_id for an authenticated user. Once the integration has been completed, Atlan will have the access token required for the integration to continue working.
7. Click **Commit Update Set**.

If the commit action fails, [contact Atlan support](https://docs.atlan.com/support/submit-request).

### Create a new user

To [create a new user](https://www.servicenow.com/docs/fr-FR/bundle/xanadu-platform-administration/page/administer/users-and-groups/task/t_CreateAUser.html), from within ServiceNow:

1. Log in to your ServiceNow instance as a System Administrator with a security\_admin role.
2. From the top header of your ServiceNow instance, click **All**. From the dropdown, search for and select **User Administration** and then click **Users**.
3. In the top-right corner of the _Users_ page, click **New** to create a new user.
4. In the _User New record_ form, enter the following details:
 1. For _User ID_, enter `atlan.service`.
 2. For _First name_ and _Last name_, enter `Atlan` and `Service`, respectively.
 3. Click **Submit** to create the new user.
5. From the _Users_ page, search for and select the `atlan.service` user you created.
6. On the _User atlan.service_ page, scroll down to the table at the bottom of the screen. In the table, change to the **Roles** tab and then click the **Edit** button.
7. On the _Edit Members_ page, configure the following:
 1. In the _Collection_ list, search for and select **atlan\_service\_account\_role**.
 2. Click the greater than icon to add the role to the `atlan.service` user you created.
 3. Click **Save** to save your role assignment for the new user.
8. In the _User atlan.service_ page, click the **Set Password** button to create a password for the new user.
9. In the _Set Password_ dialog, click the **Generate** button to generate a password. Once a password has been generated, click the clipboard icon to copy the value and store it in a secure location. Click **Save Password**. This password will be required to [configure the ServiceNow integration in Atlan](#configure-the-atlan-integration-in-servicenow).

## Configure the ServiceNow integration in Atlan

To configure the ServiceNow integration in Atlan, from within Atlan:

1. Log in to your Atlan instance as an admin user.
2. In your Atlan workspace, click **Settings** from the left menu.

 If you are using the **Old UI (Classic)**, from the left menu, click **Admin**.
3. Click **Integrations**.
4. Expand the _ServiceNow_ tile. 
5. In the _Commit update set_ section, for _Password_, enter the [password you copied from ServiceNow for the new user](#create-a-new-user).
6. Click the **Connect and test** button to test the ServiceNow integration. This ensures that the update set was committed successfully in ServiceNow and Atlan can receive webhook events. To test the latter, Atlan will create a sample request in ServiceNow, wait for a few seconds to receive a webhook event, and then display the status of the connection as _CONNECTED_.
7. (Optional) Under the _Configurations_ tab, for _Test Connection_, click the **Run test** button to verify that the ServiceNow integration is working properly in Atlan at any time.
8. (Optional) At any future time, you can review the **Overview** tab to see the number of linked issues between ServiceNow and Atlan.

Atlan is now connected to ServiceNow! 🎉

---