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

# API token setup

> Connect JumpCloud to Ravenna using a JumpCloud admin API key for fast setup with standard authentication suitable for most workspaces.

Standard API key authentication. Quick to set up and suitable for most use cases.

## Prerequisites

Before you begin, ensure you have:

* JumpCloud Administrator access
* Access to generate API keys in the JumpCloud Admin Console

## Setup guide

### Create API key in JumpCloud

<Steps>
  <Step title="Access JumpCloud Admin Console">
    Log in to your [JumpCloud Admin Console](https://console.jumpcloud.com)
  </Step>

  <Step title="Navigate to API settings">
    Click your profile avatar in the top-right corner and select **My API Key**
  </Step>

  <Step title="Generate API key">
    Copy your API key. If you do not have one, click **Generate New API Key**.

    <Warning>
      Store this API key securely. You will not be able to view it again after navigating away.
    </Warning>
  </Step>
</Steps>

<Callout icon="link" color="#3B82F6">
  For more details, see [JumpCloud's API key documentation](https://jumpcloud.com/support/jumpcloud-apis#generating-a-new-api-key)
</Callout>

### Add integration in Ravenna

<Steps>
  <Step title="Navigate to integrations">
    Go to **Settings > Integrations**
  </Step>

  <Step title="Select JumpCloud">
    Find **JumpCloud** in the available integrations and click **Connect**
  </Step>

  <Step title="Select API Token method">
    Select **API Token** as your authentication method
  </Step>

  <Step title="Enter credentials">
    Provide the following information:

    <ParamField path="apiKey" type="string" required>
      The API key from your JumpCloud admin account
    </ParamField>
  </Step>

  <Step title="Complete setup">
    Click **Add JumpCloud** to complete the integration. Ravenna will validate your credentials and begin syncing users and groups.
  </Step>
</Steps>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Invalid credentials error">
    **Cause**: API key is incorrect or expired.

    **Solution**:

    * Verify the API key is copied correctly
    * Ensure there are no extra spaces or characters
    * Check that the key has not been regenerated since setup
    * Confirm the admin account that generated the key is still active
  </Accordion>

  <Accordion title="Insufficient permissions error">
    **Cause**: The admin account lacks the required permissions.

    **Solution**:

    * Ensure the JumpCloud admin account has Administrator-level access
    * Check that the API key belongs to an active admin user
  </Accordion>

  <Accordion title="Users or groups not syncing">
    **Cause**: Sync may still be in progress or credentials have limited scope. When the API token can't read a resource (users, groups, or applications), Ravenna keeps the integration connected and syncs that resource as empty rather than failing.

    **Solution**:

    * Allow a few minutes for the initial sync to complete
    * Verify the integration status shows as connected in **Settings > Integrations**
    * Check that users and groups exist in the JumpCloud organization linked to your credentials
    * Confirm the API token has read access to each resource type you expect to see, then trigger a resync from the integration page
  </Accordion>
</AccordionGroup>