Skip to content

Update Cursor connector docs for GA launch #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
c1-dev-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Cursor connector docs for GA launch #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 50 additions & 21 deletions baton/cursor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,73 @@
---
title: "Set up a Cursor connector"
og:title: "Set up a Cursor connector"
description: "ConductorOne provides identity governance and just-in-time provisioning for Cursor. Integrate your Cursor instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
og:description: "ConductorOne provides identity governance and just-in-time provisioning for Cursor. Integrate your Cursor instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
description: "ConductorOne provides identity governance for Cursor. Integrate your Cursor instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
og:description: "ConductorOne provides identity governance for Cursor. Integrate your Cursor instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."

Check warning on line 5 in baton/cursor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (conductorone) - vale-spellcheck

baton/cursor.mdx#L5 

Did you really mean 'UARs'?
sidebarTitle: "Cursor"
---

<Warning>
**This connector is in beta.** This means it's undergoing ongoing testing and development while we gather feedback, validate functionality, and improve stability. Beta connectors are generally stable, but they may have limited feature support, incomplete error handling, or occasional issues.

We recommend closely monitoring workflows that use this connector and contacting our Support team with any issues or feedback.
The Cursor connector requires the Cursor **Enterprise** plan. The Admin API used by this connector is only available to Enterprise teams. Teams on the Business plan do not have access to the Admin API and cannot use this connector.
</Warning>

## Capabilities

The Cursor connector syncs the following resources:

| Resource | Sync | Provision |
| :--- | :--- | :--- |
| Account | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
| Role | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
| Account | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
| Role | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |

**Notes:**
- The connector syncs team members and their assigned roles (Owner, Member, Free Owner).
- Provisioning is not currently supported. The connector provides read-only visibility into Cursor team membership and role assignments.

**Additional functionality:**

_None._

## Gather Cursor configuration information
## Prerequisites

Before setting up the Cursor connector, confirm the following:

- Your Cursor team is on the **Enterprise** plan. The Admin API is not available on Business or other plans.
- You have the **administrator** role in your Cursor team. Only administrators can create API keys.

Configuring the connector requires you to pass in information from Cursor. Gather these configuration details before you move on.
<Tip>
If your organization uses Cursor on the Enterprise plan with SSO enabled, you can also configure [SCIM provisioning](https://cursor.com/docs/account/teams/scim) directly in Cursor to manage user lifecycle through your identity provider. The ConductorOne connector complements SCIM by providing access visibility and review capabilities.
</Tip>

Here's the information you'll need:
## Gather Cursor credentials

- API Key
<Warning>
To configure the Cursor connector, you need **administrator** permissions in your Cursor team.
</Warning>

<Steps>
<Step>
Log in to the [Cursor dashboard](https://cursor.com/dashboard).
</Step>
<Step>
Navigate to **Settings** > **Advanced** > **Admin API Keys**.
</Step>
<Step>
Click **Create New API Key** and provide a descriptive name (for example, `ConductorOne`).
</Step>
<Step>
Copy the generated API key and save it securely. The key follows the format `key_` followed by a 64-character string. You cannot retrieve the key after leaving the page.
</Step>
</Steps>

See the Cursor docs for information on how to acquire credentials: [View the documentation](https://docs.cursor.com/account/teams/admin-api#creating-an-api-key)
For more information, see the [Cursor Admin API documentation](https://cursor.com/docs/account/teams/admin-api).

## Configure the Cursor connector

<Warning>
To complete this task, you'll need:
To complete this task, you need:

- The **Connector Administrator** or **Super Administrator** role in ConductorOne
- Access to the set of Cursor configuration information gathered by following the instructions above
- The Cursor API key gathered in the previous section
</Warning>

<Tabs>
Expand Down Expand Up @@ -72,7 +100,7 @@
Find the **Settings** area of the page and click **Edit**.
</Step>
<Step>
Enter the configuration information from the previous section.
Enter your Cursor API key in the **API Key** field.
</Step>
<Step>
Click **Save**.
Expand All @@ -87,14 +115,10 @@
</Tab>
<Tab title="Self-hosted">

**Follow these instructions to use the Cursor connector, hosted and run in your own environment.**
**Follow these instructions to use the [Cursor](https://github.com/ConductorOne/baton-cursor) connector, hosted and run in your own environment.**

When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.

### Resources

* [GitHub repository](https://github.com/ConductorOne/baton-cursor): Access the source code, report issues, or contribute to the project.

### Step 1: Set up a new Cursor connector

<Steps>
Expand Down Expand Up @@ -124,7 +148,7 @@
<Step>
Click **Rotate** to generate a new Client ID and Secret.

Carefully copy and save these credentials. We'll use them in Step 2.
Carefully copy and save these credentials. You need them in Step 2.
</Step>
</Steps>

Expand Down Expand Up @@ -201,4 +225,9 @@
</Tab>
</Tabs>

## Known limitations

- **Enterprise plan required.** The Cursor Admin API is only available on Enterprise plans. Teams on the Business plan cannot use this connector.
- **No provisioning.** The connector provides read-only access. It cannot invite users, remove members, or modify role assignments through the Cursor API.
- **No role management API.** Cursor does not expose an API for changing user roles. Role assignments are synced for visibility only.
- **SCIM requires Enterprise and SSO.** SCIM-based user provisioning in Cursor is only available on Enterprise plans with SSO enabled. SCIM is configured directly in Cursor, not through this connector. See the [Cursor SCIM documentation](https://cursor.com/docs/account/teams/scim) for setup guidance.