JumpCloud v1.1.0

About the connector

JumpCloud is a 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 they need access to.

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 with JumpCloud.

Version information

Connector Version: 1.1.0

FortiSOAR™ Version Tested on: 7.5.0-4015

JumpCloud Version Tested on: Cloud Setup

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.1.0

The following enhancements have been made to the JumpCloud Connector in version 1.1.0:

• Fixed an issue where a reference to the package requests, in requirements.txt, kept the urllib3 to a lower version resulting in failure of integration services

NOTE: If you are upgrading the connector from v1.0.0, ensure to update the urllib3 library using the following command:

sudo -u fsr-integrations /opt/cyops-integrations/.env/bin/pip install urllib3==1.26.18

Installing the connector

Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.

You can also use the yum command as a root user to install the connector:

yum install cyops-connector-jumpcloud

Prerequisites to configuring the connector

• You must have the credentials of JumpCloud server to which you will connect and perform automated operations.
• The FortiSOAR™ server should have outbound connectivity to port 443 on the JumpCloud server.

Minimum Permissions Required

• Not applicable

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:

operation: Create Command

Input parameters

Output

The output contains the following populated JSON schema:

{
    "_id": "",
    "id": "",
    "name": "",
    "trigger": "",
    "command": "",
    "commandType": "",
    "commandRunners": [],
    "sudo": "",
    "launchType": "",
    "listensTo": "",
    "scheduleRepeatType": "",
    "schedule": "",
    "files": [],
    "timeout": "",
    "organization": "",
    "shell": ""
}

operation: Get Systems

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when the System ID IS NOT specified:

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

Output schema when the System ID IS specified:

{
    "id": "",
    "os": "",
    "_id": "",
    "fde": {
        "active": "",
        "keyPresent": ""
    },
    "arch": "",
    "active": "",
    "created": "",
    "version": "",
    "hostname": "",
    "remoteIP": "",
    "sshdParams": [],
    "displayName": "",
    "lastContact": "",
    "agentVersion": "",
    "organization": "",
    "serialNumber": "",
    "templateName": "",
    "sshRootEnabled": "",
    "systemTimezone": "",
    "modifySSHDConfig": "",
    "allowSshRootLogin": "",
    "connectionHistory": [],
    "networkInterfaces": [
        {
            "name": "",
            "family": "",
            "address": "",
            "internal": ""
        }
    ],
    "allowPublicKeyAuthentication": "",
    "allowMultiFactorAuthentication": "",
    "allowSshPasswordAuthentication": ""
}

operation: Get Users

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when the User ID IS NOT specified:

{
    "results": [
        {
            "id": "",
            "_id": "",
            "mfa": {
                "exclusion": "",
                "configured": ""
            },
            "sudo": "",
            "email": "",
            "state": "",
            "created": "",
            "manager": "",
            "lastname": "",
            "ssh_keys": [],
            "unix_uid": "",
            "username": "",
            "activated": "",
            "addresses": [],
            "firstname": "",
            "suspended": "",
            "unix_guid": "",
            "attributes": [],
            "middlename": "",
            "description": "",
            "displayname": "",
            "organization": "",
            "phoneNumbers": [],
            "totp_enabled": "",
            "mfaEnrollment": {
                "pushStatus": "",
                "totpStatus": "",
                "overallStatus": "",
                "webAuthnStatus": ""
            },
            "password_date": "",
            "account_locked": "",
            "alternateEmail": "",
            "allow_public_key": "",
            "password_expired": "",
            "ldap_binding_user": "",
            "passwordless_sudo": "",
            "associatedTagCount": "",
            "enable_managed_uid": "",
            "externally_managed": "",
            "samba_service_user": "",
            "password_never_expires": "",
            "disableDeviceMaxLoginAttempts": "",
            "enable_user_portal_multifactor": ""
        }
    ],
    "totalCount": ""
}

Output schema when the User ID IS specified:

{
    "id": "",
    "_id": "",
    "mfa": {
        "exclusion": "",
        "configured": ""
    },
    "sudo": "",
    "email": "",
    "state": "",
    "created": "",
    "manager": "",
    "lastname": "",
    "ssh_keys": [],
    "unix_uid": "",
    "username": "",
    "activated": "",
    "addresses": [],
    "firstname": "",
    "suspended": "",
    "unix_guid": "",
    "attributes": [],
    "middlename": "",
    "description": "",
    "displayname": "",
    "organization": "",
    "phoneNumbers": [],
    "totp_enabled": "",
    "mfaEnrollment": {
        "pushStatus": "",
        "totpStatus": "",
        "overallStatus": "",
        "webAuthnStatus": ""
    },
    "password_date": "",
    "recoveryEmail": {
        "verified": ""
    },
    "account_locked": "",
    "alternateEmail": "",
    "allow_public_key": "",
    "password_expired": "",
    "restrictedFields": [],
    "ldap_binding_user": "",
    "passwordless_sudo": "",
    "enable_managed_uid": "",
    "externally_managed": "",
    "samba_service_user": "",
    "password_never_expires": "",
    "disableDeviceMaxLoginAttempts": "",
    "enable_user_portal_multifactor": ""
}

operation: Get Organizations

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when the Organization ID IS NOT specified:

{
    "results": [
        {
            "id": "",
            "_id": "",
            "created": "",
            "logoUrl": "",
            "displayName": ""
        }
    ],
    "totalCount": ""
}

Output schema when the Organization ID IS specified:

{
    "id": "",
    "_id": "",
    "created": "",
    "logoUrl": "",
    "provider": "",
    "settings": {
        "name": "",
        "disableUM": "",
        "showIntro": "",
        "enableO365": "",
        "contactName": "",
        "disableLdap": "",
        "betaFeatures": {},
        "contactEmail": "",
        "passwordPolicy": {
            "minLength": "",
            "maxHistory": "",
            "needsNumeric": "",
            "effectiveDate": "",
            "needsSymbolic": "",
            "needsLowercase": "",
            "needsUppercase": "",
            "enableMinLength": "",
            "enableMaxHistory": "",
            "maxLoginAttempts": "",
            "lockoutTimeInSeconds": "",
            "minChangePeriodInDays": "",
            "allowUsernameSubstring": "",
            "enableMaxLoginAttempts": "",
            "passwordExpirationInDays": "",
            "enableLockoutTimeInSeconds": "",
            "enableMinChangePeriodInDays": "",
            "enablePasswordExpirationInDays": "",
            "daysAfterExpirationToSelfRecover": "",
            "daysBeforeExpirationToForceReset": "",
            "enableDaysAfterExpirationToSelfRecover": "",
            "enableDaysBeforeExpirationToForceReset": ""
        },
        "emailDisclaimer": "",
        "enableGoogleApps": "",
        "enableManagedUID": "",
        "groupingStrategy": "",
        "passwordCompliance": "",
        "duplicateLDAPGroups": "",
        "disableCommandRunner": "",
        "systemUserPasswordExpirationInDays": ""
    },
    "displayName": "",
    "hasStripeCustomerId": ""
}

operation: Get Commands

Input parameters

Output

The output contains the following populated JSON schema:

Output schema when the Command ID IS NOT specified:

{
    "results": [
        {
            "id": "",
            "_id": "",
            "name": "",
            "command": "",
            "trigger": "",
            "schedule": "",
            "template": "",
            "listensTo": "",
            "launchType": "",
            "commandType": "",
            "organization": "",
            "scheduleYear": "",
            "scheduleRepeatType": ""
        }
    ],
    "totalCount": ""
}

Output schema when the Command ID IS specified:

{
    "id": "",
    "_id": "",
    "name": "",
    "sudo": "",
    "user": "",
    "files": [],
    "shell": "",
    "command": "",
    "systems": "",
    "timeout": "",
    "trigger": "",
    "schedule": "",
    "listensTo": "",
    "launchType": "",
    "commandType": "",
    "organization": "",
    "scheduleYear": "",
    "commandRunners": [],
    "timeToLiveSeconds": "",
    "scheduleRepeatType": ""
}

operation: Manage Command Associations

Input parameters

Output

The output contains the following populated JSON schema:

{
    "Status": "",
    "Message": ""
}

operation: Trigger Command

Input parameters

Output

The output contains the following populated JSON schema:

{
    "triggered": []
}

Included playbooks

The Sample - JumpCloud - 1.1.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.