> For the complete documentation index, see [llms.txt](https://docs.elimity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elimity.com/ivanti-neurons-for-itsm/step-by-step-deployment-guide.md). # Step-by-step deployment guide The Ivanti Neurons for ITSM connector imports employees, roles and role assignments from your Ivanti Neurons for ITSM tenant into Elimity Insights. ### 1. Which data is imported from Ivanti Neurons for ITSM? The connector imports two entity types and the link between them. {% code overflow="wrap" %} ```mermaid graph TD;Employee[Employee]; Role[Role];Employee --> Role; ``` {% endcode %} **Employees** (Ivanti business object `Employee`). Every Employee record is imported, without a filter, with these attributes: Login ID, Email, Status, Team. **Roles** (Ivanti business object `frs_def_role`), with their `DisplayName` as name. **Role assignments**: each employee is linked to the roles they hold, read from the `RoleAssignedUsers` relationship of every role. The connector calls the Ivanti OData REST API: * `GET /api/odata/businessobject/employees` * `GET /api/odata/businessobject/frs_def_roles` * `GET /api/odata/businessobject/frs_def_roles('{RecId}')/RoleAssignedUsers`, once per role All requests page with `$top`/`$skip` in pages of 100, the maximum Ivanti allows. A role assignment that points at a record which is not an Employee is skipped and reported as an alert in the **Logs** tab. ### 2. Create a REST API key in Ivanti The connector authenticates with a **REST API key**, sent on every request as the header `Authorization: rest_api_key=`. An Ivanti administrator creates the key under **Configure > Security Controls > API Keys**. Please see Ivanti's [Using the REST API Key](https://docs.ivanti.com/neurons-for-itsm/admin-user-help/enu/latest/using-the-rest-api-key) guide. In short: 1. Select the key group for REST API in the **Key Groups** section, or click **Add Key Group** to create one. 2. Click **Add API Key** and make sure **Activated** is checked. 3. Set **On Behalf Of** and **In Role**: the key acts as that user in that role, so the role needs **read** access to the `Employee` and `frs_def_role` business objects and their `RoleAssignedUsers` relationship. 4. Click **Save Key** and copy the **Reference ID**: this is the API key the connector needs. REST API keys are static and do not expire. In the end you should have the following configuration values: * The tenant **base URL** (`base_url`), e.g. `https://your-tenant.saasiteu.com` * The **API key** (`api_key`) > **Tip:** before continuing, check that the key can read roles: a GET on `https:///api/odata/businessobject/frs_def_roles?$top=1&$select=RecId,DisplayName` with that header should return one role. A `400` with `No such entry exists` means the key's role cannot read `frs_def_role`. ### 3. Configure the source in Elimity Insights You can now register the connector in Elimity Insights: 1. Go to **Sources** in the left navigation bar and click **Add Source**. 2. Search for **Custom** and click **Set Up**. 3. Click **Set Up** again and give the source a name (e.g. `Ivanti Neurons for ITSM`). 4. Select **Upload export file**, click **Continue** and upload the data model file: `insights-client-ivanti-data-model-export.json` {% file src="/files/DQPIjv93VtB9rvMA0ise" %} 5. Open the **Config** tab and click **Edit**. 6. Check **Enable automatic imports via custom gateway** and fill in the **Gateway URL**: [`https://ivanti-gateway-1027270379075.europe-west1.run.app`](https://ivanti-gateway-1027270379075.europe-west1.run.app). Use SDK version 1. If you host the gateway yourself, use the URL of your own deployment instead (see [Installation](/ivanti-neurons-for-itsm/installation.md)). 7. Click **Add configuration value** and add the two entries below.
KeyType
base_urlText
api_keyPassword
`base_url` and `api_key` are required. If either is missing or incorrect, the connector cannot authenticate against Ivanti and the import will not start. 8. Click **Save and run** to launch your first import. You can monitor the progress in the **Logs** tab, and the **Imports** tab will show the summary for each run. --- # 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://docs.elimity.com/ivanti-neurons-for-itsm/step-by-step-deployment-guide.md?ask=&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.