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

# Addigy

> Connect Addigy with one API key so the agent reads each client's Macs, alerts, software and audit log, and restarts or changes a Mac only after approval.

Connect Addigy so the agent can check a client's Macs and act on them through Addigy MDM.

One API key from your top-level Addigy organization covers every client. The agent reads device data on its own. It restarts a Mac, deploys a profile or deletes a user account only after a technician approves.

## Prerequisites

* You need to be an owner of your top-level organization in Addigy.
* Your Addigy organization needs at least one policy or one device. Rallied reads the organization from them when you connect.

## How to connect

**1. Create an API key in Addigy**

Sign in to Addigy and open **Account → Integrations → API**. Create an API key named Rallied and give it these permissions:

| Permission | What it's for |
| - | - |
| **View Devices** | Required. Reading devices, profiles, alerts, software and other device data |
| **View System Events** | Required. Reading a Mac's audit log |
| **Execute commands** | Optional. Approved restarts, profile deploys and user account deletes |

Leave **Execute commands** off to keep the agent read-only.

**2. Connect Addigy**

In Rallied, go to **Settings → Integrations**, find the Addigy card, and click **Connect**. Paste the key into **API Key**. There is no organization ID to enter.

**3. Confirm the connection**

Rallied checks the key's permissions and refuses a key without **View Devices** and **View System Events**. If a permission is missing, add it to the key in Addigy and connect again.

## Mapping policies and organizations to clients

When you connect, Rallied syncs the top-level policies and child organizations in your Addigy account. Match each one to a Rallied client on the **Companies** tab of the integration's detail page. Click **Sync from Addigy** to pick up policies and organizations you've added since.

The agent can't read a client's Macs until its policy or organization is matched. On a client's ticket, the agent reads and acts on that client's Macs only.

> [!NOTE]
>
> A Mac that sits in policies of two different clients is shown to neither client. Fix the Mac's policy in Addigy to make it visible again.

## How the agent uses it

For a request like "Sarah's MacBook keeps freezing", the agent finds the Mac by name, serial number, hostname or current user. It then checks when the Mac last checked in, reads its alerts and installed software, and looks through its audit log. If a restart would help, the agent proposes one in its plan and waits for approval.

Restarting a Mac doesn't warn the user first, so unsaved work is lost. Deleting a user account also removes its home folder.

## Tools

Reads default to **Auto**. Actions default to **Approval needed**. To change a default, open the **Policies** tab on **Settings → Integrations → Addigy**. See [Approval settings](https://docs.rallied.ai/dashboard/policies.md).

| Tool | Default policy | Description |
| - | - | - |
| `addigy-search-devices` | Auto | Find a client's Macs by device name, serial number, hostname or current user, or list them all |
| `addigy-get-device` | Auto | Get one Mac's name, serial, OS version, model, current user and last check-in |
| `addigy-get-mdm-device-info` | Auto | Get one Mac's MDM enrollment, last MDM response and APN certificate |
| `addigy-list-profiles` | Auto | List the MDM configuration profiles assigned to the client's Addigy policies |
| `addigy-list-device-users` | Auto | List the local user accounts Addigy has recorded on one Mac |
| `addigy-list-monitoring-items` | Auto | List the organization-wide monitoring rules that apply to the client |
| `addigy-list-alerts` | Auto | List the alerts Addigy raised on the client's Macs, optionally filtered by status |
| `addigy-list-maintenance-items` | Auto | List the scheduled maintenance assigned to the client's Addigy policies |
| `addigy-query-system-events` | Auto | Read the Addigy audit log for one Mac |
| `addigy-list-installed-software` | Auto | List the applications installed on one Mac, with versions and available updates |
| `addigy-restart-device` | Approval needed | Restart one Mac through Addigy MDM |
| `addigy-deploy-profile` | Approval needed | Deploy one of the client's existing MDM profiles to one or more Macs |
| `addigy-delete-device-user` | Approval needed | Delete a local user account from one Mac |

Addigy records a Mac's user accounts only after an MDM **Request User List** command, which its API can't send. An empty list from `addigy-list-device-users` means Addigy has no user list for that Mac yet, not that the Mac has no users.

## See also

* [Approval settings](https://docs.rallied.ai/dashboard/policies.md) for how **Auto**, **Approval needed** and **Disabled** work
* [Execute Mode](https://docs.rallied.ai/agents/execute-mode.md) for how approvals play out once a client is live
* [Integrations](https://docs.rallied.ai/dashboard/integrations.md) to update the API key or disconnect Addigy
* [Integrations overview](https://docs.rallied.ai/integrations/overview.md)


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