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

# Envoy

> Connect Envoy to Iru Compliance through OAuth to collect visitor logs, invites, locations, and employee directory metadata as physical-security evidence.

### About Envoy

Iru reads **visitor entry logs**, **invites**, **locations**, and **employee** directory metadata via Envoy’s API using **OAuth 2.0** (**authorization code**). Typical scopes include **`entry_logs.read`**, **`invites.read`**, **`locations.read`**, **`employees.read`**, plus **`refresh_tokens`** so Iru can rotate access tokens without repeated logins.

### How It Works

Iru uses Envoy’s **OAuth 2.0 authorization code** flow. When you enable the source, a **browser popup** redirects to Envoy’s authorization server. You sign in, review scopes, and grant access; Envoy returns a code that Iru exchanges for an **access token** and **refresh token**.

| Detail             | Value                                |
| ------------------ | ------------------------------------ |
| **Category**       | Visitor management                   |
| **Authentication** | OAuth 2.0                            |
| **Typical plans**  | Premium or Enterprise for API access |

Official references: [Developer hub](https://developers.envoy.com/hub/docs), [Authorization](https://developers.envoy.com/hub/docs/authorization), [Scopes](https://developers.envoy.com/hub/docs/scopes).

### Prerequisites

* **Admin** or **Global Admin** in Envoy.
* Browser **popups** enabled.

### Connect Envoy to Iru

<Tabs>
  <Tab title="Envoy">
    <Note>
      Complete this tab before you enable **Envoy** in **Iru Compliance**, so the right administrator completes OAuth.
    </Note>

    <Steps>
      <Step title="Sign in to Envoy">
        Open your Envoy dashboard (for example [dashboard.envoy.com](https://dashboard.envoy.com) or the URL your workplace uses) and sign in with **Admin** or **Global Admin** rights.
      </Step>

      <Step title="Confirm Premium or Enterprise API access">
        Envoy’s developer APIs require a plan that exposes the scopes Iru requests. Confirm your subscription matches **Prerequisites** in this article.
      </Step>

      <Step title="Review OAuth scopes">
        Skim [Envoy authorization](https://developers.envoy.com/hub/docs/authorization) and [Scopes](https://developers.envoy.com/hub/docs/scopes) so the consent screen matches your security review.
      </Step>

      <Step title="Allow pop-ups for Iru">
        In the browser profile you will use for Compliance, allow **pop-ups** for your **Iru** hostname so the Envoy OAuth window is not blocked.
      </Step>
    </Steps>

    <Note>
      Continue on the [**Iru Compliance**](#iru-compliance) tab.
    </Note>
  </Tab>

  <Tab title="Iru Compliance">
    <Note>
      Finish the [**Envoy**](#envoy) tab first.
    </Note>

    <Steps>
      <Step title="Open Sources">
        In Iru Compliance, on the left navigation bar, expand **Compliance** and select **Sources**.

        <Frame>
          <img src="https://mintcdn.com/iru/7HsGH7lnQ8GpVmI0/assets/media/images/iru-navigation-compliance-sources.png?fit=max&auto=format&n=7HsGH7lnQ8GpVmI0&q=85&s=595982441fd777b333b3ecfea24adc24" alt="Left navigation: Compliance expanded, Sources selected" width="424" height="1056" data-path="assets/media/images/iru-navigation-compliance-sources.png" />
        </Frame>
      </Step>

      <Step title="Turn on Envoy">
        Find **Envoy** (use **Category** or **Search by name or description**). On that card, turn on the **toggle**. A browser tab or window may open for the connector wizard.
      </Step>

      <Step title="Sign in to Envoy">
        In the OAuth popup, complete Envoy login if you are prompted.
      </Step>

      <Step title="Authorize Envoy">
        In Envoy’s OAuth popup, click **Authorize** (or the equivalent approval control).
      </Step>

      <Step title="Finish the connection">
        When the popup closes and Iru finishes the token exchange, the wizard shows **Connection Configured**.
      </Step>

      <Step title="Confirm the source is Active">
        Close the **Iru is requesting access to external services** browser tab, then return to **Compliance** → **Sources** and confirm the **Envoy** card is **Active**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

### Troubleshooting

<AccordionGroup>
  <Accordion title="Nothing opens when you turn the source on">
    Check **pop-up blocker** settings for the Iru site and try again.
  </Accordion>

  <Accordion title="Popup blocked">
    Allow popups for your Iru origin; retry.
  </Accordion>

  <Accordion title="Access denied">
    Insufficient Envoy role - use Admin/Global Admin.
  </Accordion>

  <Accordion title="No API data">
    **Standard** plan may lack API - upgrade per Envoy licensing.
  </Accordion>

  <Accordion title="Stale connection">
    Deactivated admin - **re-authorize** with an active account.
  </Accordion>
</AccordionGroup>

### Related Articles

<CardGroup cols={2}>
  <Card title="Sources Management" icon="plug" href="/en/compliance/sources-management">
    Browse and manage every Compliance source.
  </Card>

  <Card title="Getting Started With Compliance" icon="rocket" href="/en/compliance/getting-started-with-compliance">
    Frameworks, actions, and **Artifacts**.
  </Card>

  <Card title="Iru Overview" icon="layer-group" href="/en/iru/platform-overview/iru-overview">
    How Endpoint, Compliance, and Identity fit together.
  </Card>

  <Card title="Artifacts Management" icon="folder-open" href="/en/compliance/artifacts-management">
    Upload, review, and organize evidence from sources and actions.
  </Card>
</CardGroup>