Configure Service Graph Connector for Jamf using SGC Central

  • Release version: Washingtondc
  • Updated January 30, 2025
  • 4 minutes to read

    • Use the playbook available with the SGC Central application to set up the Service Graph Connector for Jamf for pulling in Jamf data into the CMDB.

    Before you begin

    Install Service Graph Connector for Jamf version 2.13.0 or later from the ServiceNow Store. For ServiceNow Store installation steps, see Install a ServiceNow Store application.
    When using client credentials for authentication, obtain the OAuth credentials from your Jamf administrator. Make a note of the following details:
    • Application (client) ID
    • Client Secret

    If using Client Credentials authentication in Jamf Pro, you need to utilize the API Roles and Clients functionality. For more details, refer to the API Roles and Clients section in the Jamf documentation. When creating a new API client in the Jamf environment, the Access token lifetime field on the form for creating a client enables setting how long the token remains valid. The default is 60 seconds, but due to ServiceNow AI Platform limitations, the value must be set to more than 60 seconds. Setting the token lifetime to 3600 seconds (1 hour) helps prevent potential issues.

    Role required: cmdb_inst_admin or admin

    About this task

    The playbook experience for onboarding connectors is activated with SGC Central in the CMDB Workspace. To configure the SGC Central application, see Configuring SGC Central and for more information on how to interact with a playbook, see Interact with Playbook.

    Procedure

    1. Navigate to Workspaces > CMDB Workspace.
    2. In the CMDB Workspace, select SGC Central.
    3. On the Overview page, select Create connection.
      Tip:
      Alternatively, you can select Create connection on the All connections page.
    4. On the Create connection window, select the Jamf connector type and then select Create connection.
    5. Complete the initial prerequisites when setting up a connection for the first time using a connector.
      Note:
      This step is required only during the first-time setup. See Perform initial setup tasks when creating a connection in SGC Central.
    6. Determine the type of authentication for the Jamf connection.
      1. In the Setup stage of the playbook, select the Select alias template activity.
        If needed, expand the Setup stage to select an activity.
      2. Select an alias template for the connection.
        • SG-Jamf OAuth Connection: Select when using OAuth or client credentials for authentication.
        • SG-Jamf Basic Connection: Select when using Basic authentication or Bearer token.
      3. Select Continue.
    7. Enter connection details and test the API connection for importing data.
      1. In the Setup stage of the playbook, select the Configure and test connection activity.
      2. On the form, fill in the fields.
        • When the SG-Jamf OAuth Connection template is selected, fill in the details as shown in the following table.
          Table 1. OAuth connection information
          Field Description
          Connection Name Name to identify the Jamf connection record.
          Connection URL Base URL to connect to the Jamf API.
          Note:
          This field is automatically set to the URL to connect to the application. Leave the field value as is.
          OAuth Client ID Application (client) ID of your Jamf client application as noted in the Before you begin section.
          Note:
          Verify that the Jamf client has read privileges for the Computers and Mobile Devices categories in Jamf.
          OAuth Client Secret Client Secret of your Jamf client application as noted in the Before you begin section.
          Use MID Server Option to use a MID Server.
          Note:
          Use of a MID Server is optional.
          Mid Selection Name of the MID Server used by the connector.

          This field appears only when the Use MID Server check box is selected.
        • When the SG-Jamf Basic Connection template is selected, fill in the details as shown in the following table.
          Table 2. Basic connection information
          Field Description
          Connection Name Name to identify the Jamf connection record.
          Connection Host Target host value used by the connection.
          Note:
          Update the Host field with your Jamf base URL or IP address. For example, demojamfhost.com or 127.0.0.1.
          User Name User name that is used to authenticate the HTTP or HTTPS request when this Basic authentication profile is enabled.
          Note:
          Verify that the Jamf user has read privileges for the Computers and Mobile Devices categories in Jamf.
          Password Password that is used to authenticate the HTTP or HTTPS request when this Basic authentication profile is enabled.
          Use MID Server Option to use a MID Server.
          Note:
          Use of a MID Server is optional.
          Mid Selection Name of the MID Server used by the connector.

          This field appears only when the Use MID Server check box is selected.
      3. Select Create and test connection.
      4. Once the connection test is complete, select Continue.
    8. Optional: Set configuration properties for the connection to access Jamf resources.
      Note:
      To skip this step, select Continue for the Set configuration properties activity. If you skip this step, the default values of the properties are considered.
      1. In the Setup stage of the playbook, select the Set configuration properties activity.
      2. Set the fields for configuration properties as described in the following table.
        Table 3. Configuration properties
        Field Description
        Import managed application records only Option to limit the import to managed application records only.
        Note:
        If the Import managed application records only check box is cleared, the default behavior is to import all application records.
        Use JAMF Pro API Option to enable the use of the Jamf Pro API for querying computer records.
        Note:
        When the Use JAMF Pro API check box is selected, the connector uses the Jamf Pro API, which offers pagination of response data and improved performance over the Jamf Classic API.
      3. Select Continue.
    9. Configure the import schedule to import data at regular intervals.
      1. In the Setup stage of the playbook, select the Configure import schedule activity.
      2. Select Configure import schedule.
      3. Select the Active check box, and then fill in the run schedule and time details.

        For more information, see Schedule a data import.

      4. Select Save.
      5. Repeat steps from 9.b to 9.d for each job displayed on the page.
      6. Select Continue.
    10. In the Setup stage of the playbook, select the Confirm connection creation activity to verify whether the connection was created.

    What to do next

    Select View all connections to review the connection details. The configured connection appears in the Installed connections list.