Skip to main content

Cancel lifecycle action

POST 
/machine-identities/v1/lifecycle-actions/:requestId/cancel
experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Attempts to cancel a lifecycle request before provisioning starts.

The path requestId is authoritative for lookup and authorization. The request body is optional and may carry cancel metadata such as comment. Any requestId value in the body is ignored.

Workflow cancel signaling is attempted before the request is persisted as CANCELING. If signaling fails, the service returns 503 (DOWNSTREAM_SERVICE_UNAVAILABLE, cause workflow-signal-failed) and the lifecycle request status is unchanged.

Invalid cancel states are returned as 400 (INVALID_REQUEST_IN_CURRENT_STATE variants).

Cancel authorization matches https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1: the original submitter is always allowed; otherwise callers must have the idn:machine-identity-lifecycle-action:manage scope and target role-context access.

403 Forbidden

  • FORBIDDEN.lifecycle-request-access-denied - caller is not the submitter and lacks both the idn:machine-identity-lifecycle-action:manage scope and target role-context.
  • FORBIDDEN.unsupported-type - the persisted lifecycle row is not scoped to AI_AGENT.

404 Not Found

  • NOT_FOUND.detailed - unknown requestId, or persisted targetType/target-identity subtype mismatch.

Request​

Responses​

Accepted. The lifecycle request cancel was accepted.