Jobs Endpoints

The Jobs API provides endpoints for monitoring background tasks such as data synchronization, role generation, and policy analysis.

Base URL

All endpoints are relative to /api/v1/jobs.

---

List Jobs

Retrieve a list of background jobs with optional filtering.

GET /api/v1/jobs

::: note Administrator Only This endpoint requires Administrator role. :::

Query Parameters

Parameter	Type	Description
job_type	string	Filter by job type
status	string	Filter by status (pending, running, completed, failed, cancelled)
start_date	string	Filter jobs started after this date (ISO 8601)
end_date	string	Filter jobs started before this date (ISO 8601)
first	number	Number of items to return
after	string	Cursor for pagination

Response

{
  "jobs": [
    {
      "id": "job-123",
      "job_type": "full_sync",
      "status": "completed",
      "progress": 100,
      "start_time": "2024-02-01T10:00:00Z",
      "end_time": "2024-02-01T10:15:00Z",
      "duration_ms": 900000,
      "records_created": 150,
      "records_updated": 45,
      "records_deleted": 10
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "cursor-token"
  }
}

---

Get Job

Retrieve details for a specific job.

GET /api/v1/jobs/{id}

::: note Administrator Only This endpoint requires Administrator role. :::

Path Parameters

Parameter	Type	Description
id	string	Job ID

Response

Returns the complete job object with all details.

---

Get Job Progress

Retrieve real-time progress for a running job.

GET /api/v1/jobs/{id}/progress

::: note Administrator Only This endpoint requires Administrator role. :::

Path Parameters

Parameter	Type	Description
id	string	Job ID

Response

{
  "id": "job-123",
  "status": "running",
  "progress": 65,
  "current_step": "Processing accounts",
  "records_processed": 650,
  "total_records": 1000,
  "elapsed_ms": 45000
}

---

Cancel Job

Cancel a running job.

DELETE /api/v1/jobs/{id}

::: note Administrator Only This endpoint requires Administrator role. :::

Path Parameters

Parameter	Type	Description
id	string	Job ID

Response

Returns 204 No Content on success.

Partial Results

Cancelling a job mid-process may result in partial data. Records already processed will remain in the system.

---

Get Running Jobs

Retrieve all currently running jobs.

GET /api/v1/jobs/running

::: note Administrator Only This endpoint requires Administrator role. :::

Response

{
  "jobs": [
    {
      "id": "job-123",
      "job_type": "account_sync",
      "status": "running",
      "progress": 45,
      "start_time": "2024-02-01T10:00:00Z"
    }
  ]
}

---

Job Types

Job Type	Description
full_sync	Complete synchronization of all entity types
incremental_sync	Sync only changes since last sync
account_sync	Synchronize accounts only
owner_sync	Synchronize owners only
group_sync	Synchronize groups only
application_sync	Synchronize applications only
role_generation	Generate roles from owner attributes
policy_analysis	Analyze roles against policies
manager_resolution	Resolve manager hierarchies
enrichment	Data enrichment operations

---

Job Statuses

Status	Description
pending	Job queued, waiting to start
running	Job currently executing
completed	Job finished successfully
failed	Job encountered an error
cancelled	Job stopped by user

---

Error Responses

Status Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Authentication required
403	Forbidden - Insufficient permissions
404	Not Found - Job does not exist
500	Internal Server Error

---

Related Topics

• Sync API - Data synchronization endpoints
• Job History - User guide
• API Reference - Complete API index