Skip to main content
GET
Search sync plan operations

Authorizations

klef.session
string
cookie
required

Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.

Path Parameters

id
string<uuid>
required

Query Parameters

kind
enum<string>[]

Filter by any of these operation kinds.

What change the operation proposes against the target system, or against the record.

Available options:
create,
update,
set_link,
set_grants,
forget,
set_claims,
adopt,
detach,
set_elements,
end_element,
set_credentials
system
string[]

Filter by any of these target systems.

A connector: one Klef ships, such as microsoft_entra, or a workspace's own, whose id starts with custom_.

Pattern: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
cause
enum<string>[]

Filter by any of these causes.

Why a plan proposes an operation.

Available options:
declared,
released,
worker_left_segment,
target_left_policy,
policy_deleted,
worker_gone,
account_gone,
matched,
unlinked,
rehired,
manually_requested
status
enum<string>[]

Filter by any of these statuses.

Per-operation execution state, recorded when the plan runs.

Available options:
pending,
succeeded,
failed,
blocked,
skipped,
waiting
workerId
string<uuid>[]

Filter by any of these worker ids.

policyId
string<uuid>[]

Filter by operations any of these policies caused.

q
string

Case-insensitive match on the worker's name.

Maximum string length: 100
cursor
integer<int32>
limit
integer<int32>

Response

OK

The envelope for a collection response with the counts each of its filters offers: facets.

results
object[]
required
facets
null | object
required
errors
object[]
required
pagination
null | object
required

Where one page sits in a paged read.