JumpCloud v1.0.0

About the connector

JumpCloud's Directory-as-a-Service (DaaS) is the single point of authority to authenticate, authorize, and manage the identities of a business's employees and the systems and IT resources to which they require access.

This document provides information about the JumpCloud connector, which facilitates automated interactions, with a JumpCloud server using FortiSOAR™ playbooks. Add the JumpCloud connector as a step in FortiSOAR™ playbooks and perform automated operations, such as automatically creating and running a new command on JumpCloud, and retrieving details of systems, users, organization, and commands from JumpCloud.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 5.0.1-098

Authored By: Fortinet

Certified: Yes

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-jumpcloud

Prerequisites to configuring the connector

• You must have the URL of JumpCloud server to which you will connect and perform automated operations and the API key and Organization ID to access that server.
• To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Connectors page, click the JumpCloud connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

operation: Create Command

Input parameters

Output

The output contains the following populated JSON schema:
{
"listensTo": "",
"trigger": "",
"launchType": "",
"commandRunners": [],
"scheduleRepeatType": "",
"sudo": "",
"id": "",
"organization": "",
"name": "",
"_id": "",
"timeout": "",
"command": "",
"schedule": "",
"files": [],
"shell": "",
"commandType": ""
}

operation: Get Systems

Input parameters

Output

The output contains the following populated JSON schema:
{
"results": [
{
"arch": "",
"sshRootEnabled": "",
"created": "",
"serialNumber": "",
"os": "",
"lastContact": "",
"id": "",
"displayName": "",
"allowSshPasswordAuthentication": "",
"associatedTagCount": "",
"allowSshRootLogin": "",
"agentVersion": "",
"sshdParams": [],
"fde": {
"keyPresent": "",
"active": ""
},
"organization": "",
"remoteIP": "",
"connectionHistory": [],
"version": "",
"allowMultiFactorAuthentication": "",
"_id": "",
"modifySSHDConfig": "",
"allowPublicKeyAuthentication": "",
"templateName": "",
"hostname": "",
"networkInterfaces": [
{
"name": "",
"internal": "",
"family": "",
"address": ""
}
],
"systemTimezone": "",
"active": ""
}
],
"totalCount": ""
}

operation: Get Users

Input parameters

Output

The output contains the following populated JSON schema:
{
"results": [
{
"externally_managed": "",
"created": "",
"ssh_keys": [],
"password_expired": "",
"mfa": {
"configured": "",
"exclusion": ""
},
"passwordless_sudo": "",
"unix_uid": "",
"id": "",
"enable_user_portal_multifactor": "",
"associatedTagCount": "",
"password_never_expires": "",
"phoneNumbers": [],
"username": "",
"enable_managed_uid": "",
"allow_public_key": "",
"ldap_binding_user": "",
"lastname": "",
"email": "",
"samba_service_user": "",
"middlename": "",
"activated": "",
"description": "",
"addresses": [],
"totp_enabled": "",
"sudo": "",
"unix_guid": "",
"firstname": "",
"account_locked": "",
"displayname": "",
"attributes": [],
"_id": ""
}
],
"totalCount": ""
}

operation: Get Organizations

Input parameters

Output

The output contains the following populated JSON schema:
{
"results": [
{
"_id": "",
"logoUrl": "",
"created": "",
"id": "",
"displayName": ""
}
],
"totalCount": ""
}

operation: Get Commands

Input parameters

Output

The output contains the following populated JSON schema:
{
"results": [
{
"organization": "",
"name": "",
"schedule": "",
"listensTo": "",
"command": "",
"_id": "",
"launchType": "",
"trigger": "",
"scheduleRepeatType": "",
"commandType": "",
"id": ""
}
],
"totalCount": ""
}

operation: Manage command associations

Input parameters

Output

The output contains the following populated JSON schema:

{
"status": "",

"message": ""
}

operation: Trigger Command

Input parameters

Output

{
"Triggered": []
}

Included playbooks

The Sample - JumpCloud - 1.0.0 playbook collection comes bundled with the JumpCloud connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the JumpCloud connector.

• Create Command
• Get Commands
• Get Organizations
• Get Systems
• Get Users
• Manage command associations
• Trigger Command

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.