Skip to content

Enqueue Access Sync

POST
/v1/jobs/sync/access
curl --request POST \
--url https://example.com/v1/jobs/sync/access \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "example", "idempotency_key": "example", "proposal_id": "example", "mode": "request", "provider_kind": "example", "payload": {}, "required_connectors": [ "example" ], "preflight_ssot": { "additionalProperty": { "additionalProperty": "example" } }, "dry_run": false, "preflight_mode": "strict" }'
x-api-key
Any of:
string
Media typeapplication/json
AccessSyncRequestIn
object
tenant_id
required
Tenant Id
string
>= 1 characters
idempotency_key
Any of:
string
proposal_id
required
Proposal Id
string
>= 1 characters
mode
required
Mode
string
Allowed values: request repository_dispatch delta_cursor reconcile
provider_kind
Any of:
string
payload
Payload
object
key
additional properties
any
required_connectors
Required Connectors
Array<string>
preflight_ssot
Preflight Ssot
object
key
additional properties
object
key
additional properties
string
dry_run
Dry Run
boolean
preflight_mode
Preflight Mode
string
default: strict
Allowed values: strict best_effort

Successful Response

Media typeapplication/json
JobOut
object
tenant_id
required
Tenant Id
string
id
required
Id
string
proposal_id
Any of:
string
job_type
required
Job Type
string
provider_kind
required
Provider Kind
string
status
required
Status
string
Allowed values: queued running succeeded failed
payload
required
Payload
object
key
additional properties
any
result
Any of:
object
key
additional properties
any
error_message
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
"status": "queued"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}