Zluri

opencollection: 1.0.0
info:
  name: Zluri API
  version: 2.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Instances
    type: folder
  items:
  - info:
      name: Zluri List Instances
      type: http
    http:
      method: GET
      url: https://api-ext.zluri.com/v2/integrations-sync/instances
    docs: Retrieve a list of all integration instances configured in your Zluri account.
  - info:
      name: Zluri Get Instance
      type: http
    http:
      method: GET
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
    docs: Retrieve details of a specific integration instance.
  - info:
      name: Zluri Update Instance
      type: http
    http:
      method: PUT
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
      body:
        type: json
        data: '{}'
    docs: Update an existing integration instance configuration with new data in the request body. You can update notification
      emails and other instance settings.
- info:
    name: Syncs
    type: folder
  items:
  - info:
      name: Zluri Create Sync
      type: http
    http:
      method: POST
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id/syncs
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
    docs: Create a new sync session for the specified instance. Only one sync can be active per instance at a time. Unfinished
      syncs block new syncs for the same instance. Data uploaded during a sync will not appear in Zluri until the sync is
      finished.
  - info:
      name: Zluri Get Sync Status
      type: http
    http:
      method: GET
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id/syncs/:sync_id
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
      - name: sync_id
        value: ''
        type: path
        description: The unique identifier of the sync session.
    docs: Retrieve the current status of a sync session. Use this to check if a sync is running, failed, or finished.
  - info:
      name: Zluri Finish Sync
      type: http
    http:
      method: POST
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id/syncs/:sync_id/finish
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
      - name: sync_id
        value: ''
        type: path
        description: The unique identifier of the sync session.
    docs: Mark a sync session as finished. Data will not appear in Zluri until the sync is finished. Always finish your sync
      after uploading all data. Once finished, a new sync can be created for the same instance.
- info:
    name: Data Upload
    type: folder
  items:
  - info:
      name: Zluri Upload Snapshot Data
      type: http
    http:
      method: POST
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id/syncs/:sync_id/data/snapshots
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
      - name: sync_id
        value: ''
        type: path
        description: The unique identifier of the sync session.
      body:
        type: json
        data: '{}'
    docs: Upload snapshot entity data within an active sync session. Snapshot data represents the current state of entities.
      Zluri compares new snapshots with the previous state to identify changes such as new users, deactivated users, and role
      changes. Data must be sent in paginated batches of up to 1000 records per page. Re-uploading a page with the same page
      number during an active sync will overwrite the previous data for that page. Supported entities include users, applications,
      contracts, and transa
  - info:
      name: Zluri Upload Fact Data
      type: http
    http:
      method: POST
      url: https://api-ext.zluri.com/v2/integrations-sync/instances/:instance_id/syncs/:sync_id/data/facts
      params:
      - name: instance_id
        value: ''
        type: path
        description: The unique identifier of the integration instance.
      - name: sync_id
        value: ''
        type: path
        description: The unique identifier of the sync session.
      body:
        type: json
        data: '{}'
    docs: Upload fact entity data within an active sync session. Fact data represents historical events that Zluri appends
      to the timeline for analytics and compliance tracking. Data must be sent in paginated batches of up to 1000 records
      per page. Fact and snapshot entities have different required fields and structures; using the wrong endpoint will fail
      schema validation.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: Zluri List Webhooks
      type: http
    http:
      method: GET
      url: https://api-ext.zluri.com/v2/webhooks
    docs: Retrieve all configured webhooks for your Zluri account.
  - info:
      name: Zluri Create Webhook
      type: http
    http:
      method: POST
      url: https://api-ext.zluri.com/v2/webhooks
      body:
        type: json
        data: '{}'
    docs: Create a new webhook to receive real-time notifications for events such as user status updates from IDP and HRMS
      tools.
  - info:
      name: Zluri Get Webhook
      type: http
    http:
      method: GET
      url: https://api-ext.zluri.com/v2/webhooks/:webhook_id
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The unique identifier of the webhook.
    docs: Retrieve details of a specific webhook.
  - info:
      name: Zluri Update Webhook
      type: http
    http:
      method: PUT
      url: https://api-ext.zluri.com/v2/webhooks/:webhook_id
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The unique identifier of the webhook.
      body:
        type: json
        data: '{}'
    docs: Update an existing webhook configuration.
  - info:
      name: Zluri Delete Webhook
      type: http
    http:
      method: DELETE
      url: https://api-ext.zluri.com/v2/webhooks/:webhook_id
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The unique identifier of the webhook.
    docs: Delete a webhook.
bundled: true