Overview

JumpCloud is a cloud-based directory platform designed to centralise and simplify identity, access, and device management for modern IT environments. It provides tools to connect users to their devices securely, applications, networks, and IT resources, regardless of location.

The JumpCloud connector enables Leena AI Agents to integrate with your organization's JumpCloud platform, facilitating automated user management, access control, and identity workflows.

API Details

Leena AI integrates with JumpCloud via REST APIs (v1.0).

Documentation link: https://docs.jumpcloud.com/api/1.0/index.html

Setup

The JumpCloud connector uses API Key authentication.

Prerequisites

Before setting up the JumpCloud connector, ensure you have:

• Administrator access to your JumpCloud console
• Ability to generate API keys in JumpCloud
• Access to your Leena AI workspace with connector management permissions

Get credentials

Here is how to generate an API Key in JumpCloud:

1. Log in to your JumpCloud instance using the following link: https://console.jumpcloud.com/login/admin
2. Navigate to User settings by clicking on your user avatar
3. Navigate to the 'My API key' section
4. Click on 'Generate new API Key' to generate an API key
5. Save the API key for later use

Add connection

Here is how to add a connection on Leena AI:

1. Log in to your Leena AI workspace
2. Navigate to Settings > Integrations
3. Search for "JumpCloud" and select it from the list to add its new connector
4. Start configuring the connector
   1. API Key: Enter the API key generated from JumpCloud console
5. Save the connector configuration

Actions

The following actions are supported for the JumpCloud connector:

Activate a System User

Activates a de-activated system user in JumpCloud. The Agent can leverage the skill (workflow), which has been designed to activate a user account that has been created but is currently inactive, once the user raises a query to do so.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Here is a sample JSON input:

{
  "systemUserId": "E_195"
}

Response

Upon successful activation, the action returns the updated user status confirmation.

Create a System User

Creates a new system user in JumpCloud. The Agent can leverage the skill (workflow), which has been designed to create a new user account within the JumpCloud system, typically during employee onboarding.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Optional

Here is a sample JSON input:

{
  "username": "ai_hammad",
  "email": "[email protected]",
  "firstname": "Hammad",
  "lastname": "M",
  "password": "TestUser@123",
  "account_locked": false,
  "activated": true
}

Response

Upon successful creation, the action returns the created user details including:

• System User ID
• Username
• Email
• Account status
• Activation status

Unlock a System User

Unlocks a locked system user in JumpCloud. The Agent can leverage the skill (workflow), which has been designed to unlock a user's account after multiple failed login attempts or other security restrictions.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Here is a sample JSON input:

{
  "systemUserId": "ai_hammad"
}

Response

Upon successful unlock, the action returns confirmation of the unlocked account status.

Get All System Users

Retrieves a list of all system users in JumpCloud. This action can be leveraged by Leena AI Orchestrator/Agent to fetch the complete list of users within the organization. Here are some common use cases:

• User Directory: Get all users for monitoring and auditing access
• Compliance Reporting: Retrieve user lists for compliance audits
• Access Review: Check all active and inactive users
• User Management: Maintain an accurate inventory of system users

Input Parameters

Here are the input parameters required to set up this action:

Optional

Here is a sample JSON input:

{
  "limit": 10,
  "skip": 0,
  "filterCombinator": "AND",
  "search": "username"
}

Response

The action returns a list of system users, each containing:

• System User ID
• Username
• Email
• First Name and Last Name
• Account status
• Activation status
• Associated permissions and roles

Get a System User by ID

Retrieves detailed information about a specific system user based on their ID in JumpCloud. The Agent can leverage the skill (workflow) to fetch detailed user information for verification, troubleshooting, or compliance purposes.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Optional

Here is a sample JSON input:

{
  "systemUserId": "E_195",
  "fields": ""
}

Response

The action returns detailed information about the user including:

• System User ID
• Username and Email
• Full Name
• Account status and permissions
• Associated roles
• Last login information

Update a System User

Updates an existing system user's information in JumpCloud. The Agent can leverage the skill (workflow), which has been designed to update a user's profile information, such as contact details, roles, and permissions.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Optional

Here is a sample JSON input:

{
  "username": "ai_hammad",
  "email": "[email protected]",
  "firstname": "Hammad",
  "lastname": "M",
  "password": "TestUser@123",
  "account_locked": false,
  "activated": true
}

Response

Upon successful update, the action returns the updated user details including:

• Updated profile information
• Modification timestamp
• Current account status

Expire System User's Password

Forces a system user's password to expire in JumpCloud. The user would not be able to use the current password once it has been expired. The Agent can leverage the skill (workflow) to enforce security protocols by requiring users to update their passwords.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Here is a sample JSON input:

{
  "systemUserId": "ai_hammad"
}

Response

Upon successful expiration, the action returns confirmation that the password has been expired and the user will be prompted to set a new password at next login.

Reset a System User's MFA Token

Resets the multi-factor authentication (MFA) token for a system user in JumpCloud, allowing them to re-enroll in MFA. The Agent can leverage the skill (workflow) when users encounter issues with their MFA device or lose access.

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Optional

Here is a sample JSON input:

{
  "systemUserId": "ai_hammad",
  "exclusionDays": 20
}

Response

Upon successful reset, the action returns confirmation that the MFA token has been reset and the user can re-enroll in MFA with the specified exclusion period.