JumpCloud Directory Insights Source

JumpCloud's open directory platform unifies your technology stack across identity, access, and device management in a cost-effective manner that doesn't sacrifice security or functionality. Directory Insights gives you a clear path to view, analyze, and save user and resource activity data, in a standard format that you can query in real time.

JumpCloud Directory Insights Source is used to collect Directory Insights Events from the JumpCloud platform using the REST API and send it to Sumo Logic.

note

This source is available in all deployments, including the Fed deployment.

Data collected

Polling Interval	Data
5 min	Events data

Setup

Vendor configuration

The JumpCloud Directory Insights source requires you to provide the API Key and Organization ID to access the source data.

• To generate the API Key, follow the instructions mentioned in the Jumpcloud documentation.
• To generate the Organization ID, follow the instructions mentioned in the Jumpcloud documentation.

Source configuration

When you create a JumpCloud Directory Insights source, you add it to a Hosted Collector. Before creating the source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a JumpCloud Directory Insights source:

1. In Sumo Logic, select Manage Data > Collection > Collection. 
2. On the Collection page, click Add Source next to a Hosted Collector.
3. Search for and select JumpCloud Directory Insights.
4. Enter a Name for the source. The description is optional.
5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
6. (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
7. In API Key, enter the API Key you generated from the JumpCloud Directory Insights platform.
8. In Organization ID, enter the Organization ID you generated from the JumpCloud Directory Insights platform.
9. In Service, select the type of logs to collect. This allows you to limit the response to just the data you want.
10. When you are finished configuring the Source, click Save.

Metadata fields

Field	Value	Description
_siemParser	/Parsers/System/JumpCloud/JumpCloud Directory Insights	Set when Forward To SIEM is checked.

JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See Use JSON to Configure Sources for details.

Parameter	Type	Value	Required	Description
schemaRef	JSON Object	{"type":"JumpCloud Directory Insights"}	Yes	Define the specific schema type.
sourceType	String	"Universal"	Yes	Type of source.
config	JSON Object	Configuration object	Yes	Source type specific values.

Configuration Object

Parameter	Type	Required	Default	Description	Example
name	String	Yes	null	Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source.	"mySource"
description	String	No	null	Type a description of the source.	"Testing source"
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	"mySource/test"
fields	JSON Object	No	null	JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	{"_siemForward": false, "fieldA": "valueA"}
apiKey	String	Yes	null	API Key generated from the JumpCloud Directory Insights platform.
orgID	String	Yes	null	Organization ID generated from the JumpCloud Directory Insights platform.
service	String	Yes	null	Type of logs from which you want to collect the data from.

JSON example

{
    "api.version": "v1",
    "source": {
        "config": {
            "name": "JumpCloud Directory Insights",
            "description": "Collect Events from JumpCloud Directory Insights Product",
            "category": "jumpcloud-directory-insights",
            "apiKey": "ebf7b9d6e1****************",
            "orgID": "64949312***************",
            "service": "all"
        },
        "schemaRef": {
            "type": "JumpCloud Directory Insights"
        },
        "sourceType": "Universal"
    }
}

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "jumpcloud-directory-insights-source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "JumpCloud Directory Insights"
  }
  config = jsonencode({
            "name": "JumpCloud Directory Insights",
            "description": "Collect Events from JumpCloud Directory Insights Product",
            "category": "jumpcloud-directory-insights",
            "apiKey": "ebf7b9d6e1****************",
            "orgID": "64949312***************",
            "service": "all"
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example

Troubleshooting

After configuring your source, you should check the status of the source in the Collectors page > Status column. If the source is not functioning as expected, you may see an error next to the Source Category column as shown below: 

Error Code: 400
Solution: Make sure that the orgID entered is correct your domain.

Error Code: 401
Solution: Make sure that the apiKey entered is correct your domain.

Error Code: 402
Solution: Make sure that the Directory Insights is enabled for the Organization.

FAQ

info

Click here for more information about Cloud-to-Cloud sources.