Applications

Create an import job

This endpoint allows you to create a user import job that will import new users and/or update existing users in JumpCloud from the application. The endpoint can currently only be used for applications that have an active Identity Management custom API integration. The request will fail with a “Not found” error for applications if that type of integration is not configured. To learn more about configuring this type of integration, read Import users from an external identity source using a custom API integration.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/applications/{application_id}/import/jobs \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-org-id: {ORG_ID}' \
-d '{
    "allowUserReactivation": true,
    "operations": [
        "users.create",
        "users.update"
    ]
    "queryString": "location=Chicago&department=IT"
  }'
post/api/v2/applications/{application_id}/import/jobs

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

queryStringstring

Query string to filter and sort the user list returned from the application. The supported filtering and sorting varies by application. If no value is sent, all users are returned. Example: "location=Chicago&department=IT"Query string used to retrieve users from service

allowUserReactivationboolean

A boolean value to allow the reactivation of suspended users

operationsImportOperation[]

Operations to be performed on the user list returned from the application

Response

OK

jobIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.