Skip to main content
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

1

Access JumpCloud Admin Console

Log in to your JumpCloud Admin Console
2

Navigate to API settings

Click your profile avatar in the top-right corner and select My API Key
3

Generate API key

Copy your API key. If you do not have one, click Generate New API Key.
Store this API key securely. You will not be able to view it again after navigating away.
For more details, see JumpCloud’s API key documentation

​
Add integration in Ravenna

1

Navigate to integrations

Go to Settings > Integrations
2

Select JumpCloud

Find JumpCloud in the available integrations and click Connect
3

Choose API Token method

Select API Token as your authentication method
4

Enter credentials

Provide the following information:
​
apiKey
string
required
The API key from your JumpCloud admin account
5

Complete setup

Click Add JumpCloud to complete the integration. Ravenna will validate your credentials and begin syncing users and groups.

​
Troubleshooting

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
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
Cause: Sync may still be in progress or credentials have limited scope.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