Skip to main content
POST
/
hris
/
provisioning-groups
/
{group_id}
/
diff
Get provisioning diff
curl --request POST \
  --url https://api.kombo.dev/v1/hris/provisioning-groups/{group_id}/diff \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "provisioned_users": [
    {
      "origin_id": "your_id_123",
      "email": "johndoe@example.com"
    }
  ],
  "options": {
    "employee_fields": [
      "id",
      "first_name",
      "last_name"
    ]
  }
}'
{
  "status": "<string>",
  "data": {
    "users": {
      "to_provision": [
        {
          "email": "<string>",
          "employee": {
            "id": "<string>",
            "remote_id": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "groups": [
              {
                "id": "<string>",
                "remote_id": "<string>",
                "name": "<string>"
              }
            ],
            "avatar": "<string>",
            "work_location_id": "<string>",
            "legal_entity_id": "<string>"
          }
        }
      ],
      "to_deprovision": [
        {
          "origin_id": "<string>",
          "email": "jsmith@example.com"
        }
      ],
      "already_provisioned": [
        {
          "origin_id": "<string>",
          "email": "jsmith@example.com",
          "employee": {
            "id": "<string>",
            "remote_id": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "groups": [
              {
                "id": "<string>",
                "remote_id": "<string>",
                "name": "<string>"
              }
            ],
            "avatar": "<string>",
            "work_location_id": "<string>",
            "legal_entity_id": "<string>"
          }
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
group_id
string
required

ID of the provisioning group (currently only default is allowed).

Body

application/json

POST /hris/provisioning-groups/:group_id/diff Request body

​
provisioned_users
object[]
required

Array of the already provisioned users in your system.

​
options
object
required

Options to customize what we return.

Response

POST /hris/provisioning-groups/:group_id/diff Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required

The users to provision, deprovision, and optionally update.