Record an external lifecycle signal.

POST

/api/admin/field-mapping/lifecycle-signals

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/lifecycle-signals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceType": "scim", "sourceId": "workday", "sourceEventId": "evt_123", "signalType": "deprovision", "targetType": "account", "targetId": "account_123" }'

Records an authoritative lifecycle signal from an external source and evaluates the resulting account, membership, entitlement, or permission decision. Duplicate source events are handled idempotently.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

sourceType

required

string

sourceId

required

string

sourceEventId

required

string

sourceTimestamp

integer | null

bindingVersion

string | null

signalType

required

string

subjectId

string | null

accountId

string | null

targetType

required

string

Allowed values: account group_membership entitlement permission

targetId

required

string

payloadRef

string | null

ownership

object | null

key

additional properties

Example

{
  "sourceType": "scim",
  "sourceId": "workday",
  "sourceEventId": "evt_123",
  "signalType": "deprovision",
  "targetType": "account",
  "targetId": "account_123"
}

Responses

200

Lifecycle signal processing response.

Media type application/json

object

result

required

object

signalEventId

required

string

decision

required

string

reasonCodes

required

Array<string>

idempotent

boolean

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "signalEventId": "example",
    "decision": "example",
    "reasonCodes": [
      "example"
    ],
    "idempotent": true
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}