Enqueue Access Sync
POST
/v1/jobs/sync/access
const url = 'https://example.com/v1/jobs/sync/access';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"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"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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" }'Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
AccessSyncRequestIn
object
tenant_id
required
Tenant Id
string
proposal_id
required
Proposal Id
string
mode
required
Mode
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
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
JobOut
object
tenant_id
required
Tenant Id
string
id
required
Id
string
job_type
required
Job Type
string
provider_kind
required
Provider Kind
string
status
required
Status
string
payload
required
Payload
object
key
additional properties
any
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>
ValidationErrorobject
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": {} } ]}