Submit machine identity lifecycle action
POST/machine-identities/v1/:id/lifecycle-actions
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.
Submits a request to activate or deactivate a machine identity. Supported actions are ACTIVATE
and DEACTIVATE.
Note: Lifecycle actions are currently supported only for machine identities of type Agent.
The response includes a requestId. Use it to
get the request or
cancel it.
To see all the requests you've submitted, use
list machine identity lifecycle actions.
Only one lifecycle action can be in progress for a machine identity at a time. If another action is already in progress for the machine identity, the request is rejected.
To submit a lifecycle action, you need the idn:machine-identity:lifecycle-action right, or 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.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 429
- 500
Accepted. The lifecycle request was created.
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.