Cancel machine identity lifecycle action
POST/machine-identities/v1/lifecycle-actions/:requestId/cancel
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.
Cancels a lifecycle action request that hasn't started provisioning yet. When the cancel is
accepted, the request moves to CANCELING status.
A request can't be canceled once provisioning has started, after it has finished, or while a cancel is already in progress.
The request body is optional. Use it to add a comment explaining why the request was canceled.
You can always cancel requests that you submitted. To cancel a request that someone else submitted,
you need the idn:machine-identity:lifecycle-action right and admin or owner access to the
machine identity. Admin or owner access means you're an org admin, a source admin, a source sub-admin
for the machine identity's source, or the machine identity's owner.
If the cancel can't be completed, the API returns an error and the request stays in CANCELING
status.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 429
- 500
Accepted. The lifecycle request cancel was accepted.
Client Error - Returned if the request body is invalid.
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Not Found - returned if the request URL refers to a resource or object that does not exist
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
Internal Server Error - Returned if there is an unexpected error.