> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-xsiam/cloud-security/cortex-cloud-saas-security/onboard-a-supported-saas-application/onboard-coveo.md).

# Onboard Coveo

For SaaS Security to detect posture risks in your Coveo instance, you must onboard your Coveo instance to SaaS Security. Through the onboarding process, SaaS Security connects to a Coveo API and, through the API, scans your Coveo instance for misconfigured settings. If there are misconfigured settings, SaaS Security suggests a remediation action based on best practices.

To access your Coveo instance, SaaS Security requires the following information, which you specify during the onboarding process.

| Admin API Key   | A generated character string that identifies a Coveo administrator to the Coveo API. SaaS Security requires this API key to authenticate to the API. Required permissions: The Admin API key must be generated by an administrator of your organization. |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Organization ID | A unique identifier that Coveo assigned to your organization.                                                                                                                                                                                            |

To onboard your Coveo instance, complete the following actions.

***

### Step 1: Generate and Configure an Admin API Key for Your Organization

1. As an administrator of your organization, log in to the [Coveo Administration Console](https://platform.cloud.coveo.com/admin).
2. In the left navigation pane, select API Keys. The API Keys item is located in the Organization section of the menu.
3. On the API Keys page, click Add key. Coveo displays the Add an API key page, which provides steps for defining the API key.
4. Follow the steps on the API key page to define your API key:
   1. On the Key purpose page, do not choose any of the predefined templates. Instead, select the Custom option to create a custom combination of privileges. Click Next.
   2. On the Identification page, specify a meaningful Name for the API key, such as SaaS Security Integration. You can optionally specify a longer Description. Click Next.
   3. On the Privileges page, grant the API key the following privileges. Click Next.

| Groups       | View all |
| ------------ | -------- |
| Organization | View     |

4. On the Configuration page, set the Expiration date to 1 year. Click Next.
5. Do not modify the Access page. Click Next.
6. Review the details of your key on the Review page and click Add API key. Coveo generates and displays your API key.
7. Copy the API key and paste it into a text file.

**Note**: Do not continue to the next step unless you have copied the API key. You will provide this key to SaaS Security during the onboarding process.

***

### Step 2: Identify Your Organization ID

1. In the left navigation pane of the Coveo Administration Console, select Settings. The Settings item is located in the Organization section of the menu.
2. On the Settings page, select the Organization tab.
3. View the organization Details, which include your Organization ID.
4. Copy your Organization ID and paste it into a text file.

**Note**: Do not continue to the next step unless you have copied the Organization ID. You will provide this information to SaaS Security during the onboarding process.

***

### Step 3: Connect SaaS Security to Your Coveo Instance

By adding a Coveo app in Cortex, you enable SaaS Security to connect to your Coveo instance.

1. Log in to Cortex.
2. Select **Settings > Data Sources and Integrations > Add New**. You can use the Search bar to find the app you want to connect to.
3. Click the Coveo tile.
4. Under **Capabilities**, Enter a Name for your application.
5. Select Security Posture under Default Capabilities and click Next.
6. Under **Connections**, enter the Admin API Key and Organization ID
7. Under **Configurations**, select a **Sync Interval**. Choose a meaningful **Tag** to distinguish between various applications in different environments. 
8. Click **Next** to complete the onboarding validation process.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/cortex-xsiam/cloud-security/cortex-cloud-saas-security/onboard-a-supported-saas-application/onboard-coveo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.