Skip to content
FractalOps

Enqueue Principal Lifecycle Apply

POST
/v1/jobs/lifecycle/principal
curl --request POST \
  --url https://example.com/v1/jobs/lifecycle/principal \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "example", "idempotency_key": "example", "proposal_id": "example", "subject_key": "example", "principal_type": "human", "target_group_paths": [ "example" ], "reason_code": "lifecycle_apply", "source": "hr-event", "attributes": {}, "dry_run": false }'

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-api-key
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PrincipalLifecycleJobIn
object
tenant_id
required
Tenant Id
string
>= 1 characters
idempotency_key
Any of:
string
proposal_id
required
Proposal Id
string
>= 1 characters
subject_key
required
Subject Key
string
>= 1 characters
principal_type
Principal Type
string
default: human
target_group_paths
Target Group Paths
Array<string>
reason_code
Reason Code
string
default: lifecycle_apply
source
Source
string
default: hr-event
attributes
Attributes
object
key
additional properties
any
dry_run
Dry Run
boolean

Responses

Section titled “Responses”

200

Section titled “200”

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"
}

422

Section titled “422”

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": {}
    }
  ]
}