> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rallied.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# IT Portal

> Connect IT Portal with an API key so the agent reads each client's KB articles, documents, devices, contacts and passwords. Writes and reveals need approval.

Connect IT Portal so the agent uses each client's KB articles, documents, devices, contacts and stored passwords while it works a ticket.

You need an IT Portal admin who can create an organization API key under **Admin → Security → API Keys**.

## How to connect

**1. Create an API key in IT Portal**

In IT Portal, open **Admin → Security → API Keys** and create an organization key for Rallied.

Give it read access to companies, sites, devices, contacts, accounts, KB articles, documents, interactions and the type lists. Add access to credentials so the agent can reveal passwords.

For the agent to write to IT Portal, also allow creating and updating devices, contacts, accounts, KB articles, documents and interactions. A missing scope doesn't block the connection. Only the tool that needs it fails when the agent calls it.

**2. Copy the key and the API endpoint**

Copy the key and the **API Endpoint** IT Portal shows with it, such as `https://yourcompany.itportal.com/p5/api/3.0/`. The endpoint can differ from the address you sign in at. It must be reachable over public HTTPS.

**3. Connect IT Portal**

In Rallied, go to **Settings → Integrations**, find the IT Portal card and click **Connect**. Fill in the form and click **Connect**.

| Field | Value |
| - | - |
| **API Key** | The key you created above. |
| **API endpoint** | The API endpoint IT Portal showed with the key. |

Rallied checks the key against your IT Portal instance and imports your IT Portal companies as candidate client mappings.

If the connection fails, check the key and that the address is the API endpoint IT Portal showed when you created the key, not your sign-in address.

## Mapping companies to clients

IT Portal stores documentation per **company**. Each IT Portal company maps to a Rallied client on the **Companies** tab of **Settings → Integrations → IT Portal**. Click **Sync companies** there to pull in new companies.

Every IT Portal tool takes the client's company and returns only that company's records, so the agent never uses another client's documentation. The agent can't use IT Portal for a client until its company is mapped.

## What the agent reads

Rallied indexes KB articles and documents for [documentation](https://docs.rallied.ai/dashboard/documentation.md) search, so the agent can answer "how do we do X for this client" with a cited source.

| Record | How the agent uses it |
| - | - |
| **KB articles** | Indexed for search. Articles of a mapped company apply to that client. Articles with no company, and articles of your own MSP company, apply to every client. |
| **Documents** | Indexed for search for the mapped client. A document that is only an uploaded file, with no body text, isn't indexed. |
| **Devices**, **contacts**, **sites** and **notes** | Read on demand through the IT Portal tools, for details such as a device's serial number or hostname or a contact's phone number. |
| **Passwords** | Never indexed. Read only through the password tools, which need approval. |

Rallied refreshes the index on a schedule. Deleted and archived KB articles and documents drop out of search.

## Passwords and approval

| Tool | Default policy | What it does |
| - | - | - |
| `itportal-list-passwords` | Approval needed | Lists a client's password entries with names, types, URLs and notes. Usernames and password values aren't included. |
| `itportal-get-password` | Approval needed | Reveals one password entry, including the value. IT Portal records every reveal in its audit log. |
| `itportal-create-password` | Approval needed | Adds a password entry for the client. |
| `itportal-update-password` | Approval needed | Changes a password entry, such as a rotated password. |

Revealing, creating and updating a password also go through [identity verification](https://docs.rallied.ai/agents/identity-verification.md). The agent puts a retrieved password only in an internal note, never in a message to the end user. 2FA codes are never available through Rallied.

> [!NOTE]
>
> If your IT Portal tenant protects stored passwords with a custom encryption key, Rallied can't read or change passwords there. A technician can still do it in IT Portal directly.

## Writing to IT Portal

Read tools default to **Auto** so the agent can consult your documentation during diagnosis. Every write tool defaults to **Approval needed**:

| Tool | What it does |
| - | - |
| `itportal-add-note` | Logs a note on a client's company, device or contact |
| `itportal-create-device`, `itportal-update-device` | Adds or edits a device |
| `itportal-create-contact`, `itportal-update-contact` | Adds or edits a contact |
| `itportal-create-kb-article`, `itportal-update-kb-article` | Adds or edits one of the client's KB articles |
| `itportal-create-document`, `itportal-update-document` | Adds or edits one of the client's documents |

Rallied has no tool that deletes IT Portal records. To change a default, open the **Policies** tab on **Settings → Integrations → IT Portal**. See [Approval settings](https://docs.rallied.ai/dashboard/policies.md).

## See also

* [Documentation](https://docs.rallied.ai/dashboard/documentation.md)
* [Approval settings](https://docs.rallied.ai/dashboard/policies.md)
* [Hudu](https://docs.rallied.ai/integrations/hudu.md)
* [IT Glue](https://docs.rallied.ai/integrations/itglue.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.