@sailpoint/api-client 2.2.51 → 2.2.52

package/dist/machine_identities_lifecycle_actions/api.d.ts

@@ -14,7 +14,7 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
 /**
- * Optional cancel metadata. The path `requestId`.
+ * Optional details for the cancel request. The request to cancel is identified by the `requestId` in the path.
  * @export
  * @interface CancelLifecycleActionRequest
  */
@@ -39,11 +39,11 @@ export interface CancelLifecycleActionResponse {
      */
     'requestId': string;
     /**
-     * Updated lifecycle request status after cancel acceptance.
+     * Status of the request after the cancel is accepted. Always `CANCELING`.
      * @type {string}
      * @memberof CancelLifecycleActionResponse
      */
-    'status': string;
+    'status': CancelLifecycleActionResponseStatusEnum;
     /**
      *
      * @type {Lifecycleaction}
@@ -51,18 +51,22 @@ export interface CancelLifecycleActionResponse {
      */
     'action': Lifecycleaction;
     /**
-     * Internal machine identity UUID for the lifecycle target.
+     * ID of the machine identity the request applies to.
      * @type {string}
      * @memberof CancelLifecycleActionResponse
      */
     'targetId': string;
     /**
-     * Connector resource id for the lifecycle target, when present.
+     * ID of the machine identity in its source system, when available.
      * @type {string}
      * @memberof CancelLifecycleActionResponse
      */
     'resourceId'?: string;
 }
+export declare const CancelLifecycleActionResponseStatusEnum: {
+    readonly Canceling: "CANCELING";
+};
+export type CancelLifecycleActionResponseStatusEnum = typeof CancelLifecycleActionResponseStatusEnum[keyof typeof CancelLifecycleActionResponseStatusEnum];
 /**
  *
  * @export
@@ -138,25 +142,25 @@ export interface LifecycleActionRequest {
      */
     'tenantId'?: string;
     /**
-     * Generic request status type discriminator.
+     * Type of request. Always `LIFECYCLE_ACTIONS_REQUEST` for lifecycle action requests.
      * @type {string}
      * @memberof LifecycleActionRequest
      */
     'statusType'?: string;
     /**
-     * Identity id of the principal that submitted the request.
+     * ID of the identity that submitted the request.
      * @type {string}
      * @memberof LifecycleActionRequest
      */
     'requestedBy'?: string;
     /**
-     * Resource type targeted by the lifecycle request.
+     * Type of machine identity the request applies to.
      * @type {string}
      * @memberof LifecycleActionRequest
      */
     'targetType'?: LifecycleActionRequestTargetTypeEnum;
     /**
-     * Internal machine identity UUID for the lifecycle target.
+     * ID of the machine identity the request applies to.
      * @type {string}
      * @memberof LifecycleActionRequest
      */
@@ -168,13 +172,13 @@ export interface LifecycleActionRequest {
      */
     'operationType'?: Lifecycleaction;
     /**
-     * Temporal workflow identifier for the lifecycle request.
+     * Identifier of the workflow that processes the request.
      * @type {string}
      * @memberof LifecycleActionRequest
      */
     'workflowId'?: string;
     /**
-     * Indicates whether the lifecycle request has reached a terminal state.
+     * Indicates whether the request has finished. A request is finished when its status is `COMPLETED`, `REJECTED`, `FAILED`, or `CANCELED`.
      * @type {boolean}
      * @memberof LifecycleActionRequest
      */
@@ -203,7 +207,7 @@ export declare const LifecycleActionRequestTargetTypeEnum: {
 };
 export type LifecycleActionRequestTargetTypeEnum = typeof LifecycleActionRequestTargetTypeEnum[keyof typeof LifecycleActionRequestTargetTypeEnum];
 /**
- * Nested lifecycle execution context stored on the lifecycle request.
+ * Details of the lifecycle request, including its status, approval, comments, and provisioning.
  * @export
  * @interface LifecycleActionRequestDetails
  */
@@ -251,13 +255,13 @@ export interface LifecycleActionRequestDetails {
      */
     'cancelComment'?: string;
     /**
-     * Append-only comment thread for the lifecycle request.
+     * Comments on the lifecycle request, in the order they were added.
      * @type {Array<LifecycleComment>}
      * @memberof LifecycleActionRequestDetails
      */
     'comments'?: Array<LifecycleComment>;
     /**
-     * Workflow phase where the request failed, when applicable.
+     * Stage where the request failed, when applicable.
      * @type {string}
      * @memberof LifecycleActionRequestDetails
      */
@@ -275,7 +279,7 @@ export interface LifecycleActionRequestDetails {
      */
     'resource'?: LifecycleResourceSummary;
     /**
-     * Cached resource owners for the lifecycle target.
+     * Owners of the machine identity at the time the request was submitted.
      * @type {Array<LifecycleOwnerReference>}
      * @memberof LifecycleActionRequestDetails
      */
@@ -293,13 +297,13 @@ export interface LifecycleActionRequestDetails {
      */
     'requester'?: LifecycleRequesterReference;
     /**
-     * Approvals identifier when the request was submitted.
+     * ID of the approval request created for this lifecycle request.
      * @type {string}
      * @memberof LifecycleActionRequestDetails
      */
     'approvalRequestId'?: string;
     /**
-     * Approval settings identifier used for the request.
+     * ID of the approval settings used for the request.
      * @type {string}
      * @memberof LifecycleActionRequestDetails
      */
@@ -356,11 +360,11 @@ export interface LifecycleActionSubmitResponse {
      */
     'requestId': string;
     /**
-     * Initial lifecycle request status.
-     * @type {string}
+     *
+     * @type {Lifecyclestatus}
      * @memberof LifecycleActionSubmitResponse
      */
-    'status': string;
+    'status': Lifecyclestatus;
     /**
      *
      * @type {Lifecycleaction}
@@ -368,13 +372,13 @@ export interface LifecycleActionSubmitResponse {
      */
     'action': Lifecycleaction;
     /**
-     * Internal machine identity UUID for the lifecycle target.
+     * ID of the machine identity the request applies to.
      * @type {string}
      * @memberof LifecycleActionSubmitResponse
      */
     'targetId': string;
     /**
-     * Connector resource id for the lifecycle target, when present.
+     * ID of the machine identity in its source system, when available.
      * @type {string}
      * @memberof LifecycleActionSubmitResponse
      */
@@ -505,7 +509,7 @@ export declare const LifecycleOwnerReferenceTypeEnum: {
 };
 export type LifecycleOwnerReferenceTypeEnum = typeof LifecycleOwnerReferenceTypeEnum[keyof typeof LifecycleOwnerReferenceTypeEnum];
 /**
- * Provisioning execution window for the lifecycle request.
+ * Provisioning status for the lifecycle request, with when provisioning started and ended.
  * @export
  * @interface LifecycleProvisioning
  */
@@ -555,43 +559,43 @@ export interface LifecycleRequesterReference {
     'name'?: string;
 }
 /**
- * Cached resource context for the lifecycle target.
+ * Details of the machine identity at the time the request was submitted.
  * @export
  * @interface LifecycleResourceSummary
  */
 export interface LifecycleResourceSummary {
     /**
-     * Internal machine identity UUID for the lifecycle target.
+     * ID of the machine identity.
      * @type {string}
      * @memberof LifecycleResourceSummary
      */
     'id'?: string;
     /**
-     * Connector resource id for the lifecycle target.
+     * ID of the machine identity in its source system.
      * @type {string}
      * @memberof LifecycleResourceSummary
      */
     'resourceId'?: string;
     /**
-     * Display name of the lifecycle target.
+     * Name of the machine identity.
      * @type {string}
      * @memberof LifecycleResourceSummary
      */
     'name'?: string;
     /**
-     * Source identifier for the lifecycle target.
+     * ID of the source the machine identity belongs to.
      * @type {string}
      * @memberof LifecycleResourceSummary
      */
     'sourceId'?: string;
     /**
-     * Source name for the lifecycle target.
+     * Name of the source the machine identity belongs to.
      * @type {string}
      * @memberof LifecycleResourceSummary
      */
     'sourceName'?: string;
     /**
-     * Machine identity subtype for the lifecycle target.
+     * Type of machine identity.
      * @type {string}
      * @memberof LifecycleResourceSummary
      */
@@ -608,7 +612,7 @@ export declare const Lifecycleaction: {
 };
 export type Lifecycleaction = typeof Lifecycleaction[keyof typeof Lifecycleaction];
 /**
- * Provisioning execution status for the downstream workflow window.
+ * Status of provisioning the change to the machine identity\'s source.
  * @export
  * @enum {string}
  */
@@ -620,7 +624,7 @@ export declare const Lifecycleprovisioningstatus: {
 };
 export type Lifecycleprovisioningstatus = typeof Lifecycleprovisioningstatus[keyof typeof Lifecycleprovisioningstatus];
 /**
- * Detailed lifecycle request status stored on the lifecycle action request.
+ * Status of the lifecycle action request.
  * @export
  * @enum {string}
  */
@@ -678,8 +682,8 @@ export interface SubmitMachineIdentityLifecycleActionV1429Response {
  */
 export declare const MachineIdentityLifecycleActionsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * 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.
-     * @summary Cancel lifecycle action
+     * 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.
+     * @summary Cancel machine identity lifecycle action
      * @param {string} requestId Lifecycle request identifier.
      * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
      * @param {CancelLifecycleActionRequest} [cancelLifecycleActionRequest]
@@ -688,8 +692,8 @@ export declare const MachineIdentityLifecycleActionsApiAxiosParamCreator: (confi
      */
     cancelMachineIdentityLifecycleActionV1: (requestId: string, xSailPointExperimental?: string, cancelLifecycleActionRequest?: CancelLifecycleActionRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns one lifecycle request snapshot by `requestId`. Used for request-level inspection, including cancel acceptance and subsequent status changes.  The original requester is always allowed to read their request. Otherwise, callers must have the `idn:machine-identity-lifecycle-action:manage` scope **and** role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  **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 (response includes `requestId` as a parameter). - `FORBIDDEN.unsupported-type` - the persisted lifecycle row is not scoped to `AI_AGENT`   (`targetType` on read-by-request-id paths).  **404 Not Found**  - `NOT_FOUND.detailed` - unknown `requestId`, or persisted `targetType` does not match the   target machine identity\'s subtype-to-resource-type mapping.
-     * @summary Get lifecycle action by requestId
+     * Returns a single lifecycle action request, including its current status, approval details, and provisioning progress. Use it to follow a request after you submit or cancel it.  You can always view requests that you submitted. To view 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.
+     * @summary Get machine identity lifecycle action
      * @param {string} requestId Lifecycle request identifier.
      * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
      * @param {*} [axiosOptions] Override http request option.
@@ -697,9 +701,9 @@ export declare const MachineIdentityLifecycleActionsApiAxiosParamCreator: (confi
      */
     getMachineIdentityLifecycleActionV1: (requestId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Lists lifecycle requests visible to the requester identity in the current request context.  Results are automatically scoped to the calling identity. If requester identity context is missing, an empty list is returned.  When `limit` is omitted, this endpoint applies a default limit of 50.
-     * @summary List lifecycle actions
-     * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **resourceType**: *eq, in*  **operationType**: *eq, in*  **status**: *eq, in*  **completed**: *eq*  **targetId**: *eq*  **targetName**: *eq, sw*  **sourceId**: *eq*  **created**: *gt, ge, lt, le*
+     * Returns the lifecycle action requests that you submitted. Requests that other users submitted aren\'t included, even if you\'re an admin. If the call isn\'t made on behalf of an identity, the list is empty.  When `limit` is omitted, up to 50 results are returned.
+     * @summary List machine identity lifecycle actions
+     * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **resourceType**: *eq, in*  **operationType**: *eq, in*  **status**: *eq, in*  **completed**: *eq*  **targetId**: *eq*  **targetName**: *eq, sw*  **sourceId**: *eq*  **created**: *gt, ge, lt, le*  The &#x60;resourceType&#x60; filter matches the &#x60;targetType&#x60; field in the response.
      * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **created, modified, status**  Default sort is **-created** (newest first).
      * @param {number} [limit] Max number of results to return. When omitted, the default limit is 50. The maximum allowed limit is 250.  See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
      * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
@@ -710,7 +714,7 @@ export declare const MachineIdentityLifecycleActionsApiAxiosParamCreator: (confi
      */
     listMachineIdentityLifecycleActionsV1: (filters?: string, sorters?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Creates a lifecycle request for the target machine identity and returns the created lifecycle snapshot.  **Note:** Lifecycle actions are currently supported only for machine identities of type **Agent**.  The response includes the generated `requestId`, which is used by https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1, https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1, and https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1  Authorization is enforced in the service layer. Callers must have the `idn:machine-identity-lifecycle-action:manage` scope or role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  Supported actions are `DEACTIVATE`, `ACTIVATE`.
+     * 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](https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1) or [cancel it](https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1). To see all the requests you\'ve submitted, use [list machine identity lifecycle actions](https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1).  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.
      * @summary Submit machine identity lifecycle action
      * @param {string} id Machine identity ID.
      * @param {LifecycleActionSubmitRequest} lifecycleActionSubmitRequest
@@ -726,8 +730,8 @@ export declare const MachineIdentityLifecycleActionsApiAxiosParamCreator: (confi
  */
 export declare const MachineIdentityLifecycleActionsApiFp: (configuration?: Configuration) => {
     /**
-     * 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.
-     * @summary Cancel lifecycle action
+     * 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.
+     * @summary Cancel machine identity lifecycle action
      * @param {string} requestId Lifecycle request identifier.
      * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
      * @param {CancelLifecycleActionRequest} [cancelLifecycleActionRequest]
@@ -736,8 +740,8 @@ export declare const MachineIdentityLifecycleActionsApiFp: (configuration?: Conf
      */
     cancelMachineIdentityLifecycleActionV1(requestId: string, xSailPointExperimental?: string, cancelLifecycleActionRequest?: CancelLifecycleActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelLifecycleActionResponse>>;
     /**
-     * Returns one lifecycle request snapshot by `requestId`. Used for request-level inspection, including cancel acceptance and subsequent status changes.  The original requester is always allowed to read their request. Otherwise, callers must have the `idn:machine-identity-lifecycle-action:manage` scope **and** role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  **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 (response includes `requestId` as a parameter). - `FORBIDDEN.unsupported-type` - the persisted lifecycle row is not scoped to `AI_AGENT`   (`targetType` on read-by-request-id paths).  **404 Not Found**  - `NOT_FOUND.detailed` - unknown `requestId`, or persisted `targetType` does not match the   target machine identity\'s subtype-to-resource-type mapping.
-     * @summary Get lifecycle action by requestId
+     * Returns a single lifecycle action request, including its current status, approval details, and provisioning progress. Use it to follow a request after you submit or cancel it.  You can always view requests that you submitted. To view 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.
+     * @summary Get machine identity lifecycle action
      * @param {string} requestId Lifecycle request identifier.
      * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
      * @param {*} [axiosOptions] Override http request option.
@@ -745,9 +749,9 @@ export declare const MachineIdentityLifecycleActionsApiFp: (configuration?: Conf
      */
     getMachineIdentityLifecycleActionV1(requestId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LifecycleActionRequest>>;
     /**
-     * Lists lifecycle requests visible to the requester identity in the current request context.  Results are automatically scoped to the calling identity. If requester identity context is missing, an empty list is returned.  When `limit` is omitted, this endpoint applies a default limit of 50.
-     * @summary List lifecycle actions
-     * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **resourceType**: *eq, in*  **operationType**: *eq, in*  **status**: *eq, in*  **completed**: *eq*  **targetId**: *eq*  **targetName**: *eq, sw*  **sourceId**: *eq*  **created**: *gt, ge, lt, le*
+     * Returns the lifecycle action requests that you submitted. Requests that other users submitted aren\'t included, even if you\'re an admin. If the call isn\'t made on behalf of an identity, the list is empty.  When `limit` is omitted, up to 50 results are returned.
+     * @summary List machine identity lifecycle actions
+     * @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **resourceType**: *eq, in*  **operationType**: *eq, in*  **status**: *eq, in*  **completed**: *eq*  **targetId**: *eq*  **targetName**: *eq, sw*  **sourceId**: *eq*  **created**: *gt, ge, lt, le*  The &#x60;resourceType&#x60; filter matches the &#x60;targetType&#x60; field in the response.
      * @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **created, modified, status**  Default sort is **-created** (newest first).
      * @param {number} [limit] Max number of results to return. When omitted, the default limit is 50. The maximum allowed limit is 250.  See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
      * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
@@ -758,7 +762,7 @@ export declare const MachineIdentityLifecycleActionsApiFp: (configuration?: Conf
      */
     listMachineIdentityLifecycleActionsV1(filters?: string, sorters?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LifecycleActionRequest>>>;
     /**
-     * Creates a lifecycle request for the target machine identity and returns the created lifecycle snapshot.  **Note:** Lifecycle actions are currently supported only for machine identities of type **Agent**.  The response includes the generated `requestId`, which is used by https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1, https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1, and https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1  Authorization is enforced in the service layer. Callers must have the `idn:machine-identity-lifecycle-action:manage` scope or role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  Supported actions are `DEACTIVATE`, `ACTIVATE`.
+     * 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](https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1) or [cancel it](https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1). To see all the requests you\'ve submitted, use [list machine identity lifecycle actions](https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1).  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.
      * @summary Submit machine identity lifecycle action
      * @param {string} id Machine identity ID.
      * @param {LifecycleActionSubmitRequest} lifecycleActionSubmitRequest
@@ -774,31 +778,31 @@ export declare const MachineIdentityLifecycleActionsApiFp: (configuration?: Conf
  */
 export declare const MachineIdentityLifecycleActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * 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.
-     * @summary Cancel lifecycle action
+     * 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.
+     * @summary Cancel machine identity lifecycle action
      * @param {MachineIdentityLifecycleActionsApiCancelMachineIdentityLifecycleActionV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
     cancelMachineIdentityLifecycleActionV1(requestParameters: MachineIdentityLifecycleActionsApiCancelMachineIdentityLifecycleActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<CancelLifecycleActionResponse>;
     /**
-     * Returns one lifecycle request snapshot by `requestId`. Used for request-level inspection, including cancel acceptance and subsequent status changes.  The original requester is always allowed to read their request. Otherwise, callers must have the `idn:machine-identity-lifecycle-action:manage` scope **and** role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  **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 (response includes `requestId` as a parameter). - `FORBIDDEN.unsupported-type` - the persisted lifecycle row is not scoped to `AI_AGENT`   (`targetType` on read-by-request-id paths).  **404 Not Found**  - `NOT_FOUND.detailed` - unknown `requestId`, or persisted `targetType` does not match the   target machine identity\'s subtype-to-resource-type mapping.
-     * @summary Get lifecycle action by requestId
+     * Returns a single lifecycle action request, including its current status, approval details, and provisioning progress. Use it to follow a request after you submit or cancel it.  You can always view requests that you submitted. To view 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.
+     * @summary Get machine identity lifecycle action
      * @param {MachineIdentityLifecycleActionsApiGetMachineIdentityLifecycleActionV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
     getMachineIdentityLifecycleActionV1(requestParameters: MachineIdentityLifecycleActionsApiGetMachineIdentityLifecycleActionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<LifecycleActionRequest>;
     /**
-     * Lists lifecycle requests visible to the requester identity in the current request context.  Results are automatically scoped to the calling identity. If requester identity context is missing, an empty list is returned.  When `limit` is omitted, this endpoint applies a default limit of 50.
-     * @summary List lifecycle actions
+     * Returns the lifecycle action requests that you submitted. Requests that other users submitted aren\'t included, even if you\'re an admin. If the call isn\'t made on behalf of an identity, the list is empty.  When `limit` is omitted, up to 50 results are returned.
+     * @summary List machine identity lifecycle actions
      * @param {MachineIdentityLifecycleActionsApiListMachineIdentityLifecycleActionsV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
      */
     listMachineIdentityLifecycleActionsV1(requestParameters?: MachineIdentityLifecycleActionsApiListMachineIdentityLifecycleActionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<LifecycleActionRequest>>;
     /**
-     * Creates a lifecycle request for the target machine identity and returns the created lifecycle snapshot.  **Note:** Lifecycle actions are currently supported only for machine identities of type **Agent**.  The response includes the generated `requestId`, which is used by https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1, https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1, and https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1  Authorization is enforced in the service layer. Callers must have the `idn:machine-identity-lifecycle-action:manage` scope or role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  Supported actions are `DEACTIVATE`, `ACTIVATE`.
+     * 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](https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1) or [cancel it](https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1). To see all the requests you\'ve submitted, use [list machine identity lifecycle actions](https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1).  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.
      * @summary Submit machine identity lifecycle action
      * @param {MachineIdentityLifecycleActionsApiSubmitMachineIdentityLifecycleActionV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
@@ -857,7 +861,7 @@ export interface MachineIdentityLifecycleActionsApiGetMachineIdentityLifecycleAc
  */
 export interface MachineIdentityLifecycleActionsApiListMachineIdentityLifecycleActionsV1Request {
     /**
-     * Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **resourceType**: *eq, in*  **operationType**: *eq, in*  **status**: *eq, in*  **completed**: *eq*  **targetId**: *eq*  **targetName**: *eq, sw*  **sourceId**: *eq*  **created**: *gt, ge, lt, le*
+     * Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **resourceType**: *eq, in*  **operationType**: *eq, in*  **status**: *eq, in*  **completed**: *eq*  **targetId**: *eq*  **targetName**: *eq, sw*  **sourceId**: *eq*  **created**: *gt, ge, lt, le*  The &#x60;resourceType&#x60; filter matches the &#x60;targetType&#x60; field in the response.
      * @type {string}
      * @memberof MachineIdentityLifecycleActionsApiListMachineIdentityLifecycleActionsV1
      */
@@ -926,8 +930,8 @@ export interface MachineIdentityLifecycleActionsApiSubmitMachineIdentityLifecycl
  */
 export declare class MachineIdentityLifecycleActionsApi extends BaseAPI {
     /**
-     * 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.
-     * @summary Cancel lifecycle action
+     * 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.
+     * @summary Cancel machine identity lifecycle action
      * @param {MachineIdentityLifecycleActionsApiCancelMachineIdentityLifecycleActionV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
@@ -935,8 +939,8 @@ export declare class MachineIdentityLifecycleActionsApi extends BaseAPI {
      */
     cancelMachineIdentityLifecycleActionV1(requestParameters: MachineIdentityLifecycleActionsApiCancelMachineIdentityLifecycleActionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelLifecycleActionResponse, any>>;
     /**
-     * Returns one lifecycle request snapshot by `requestId`. Used for request-level inspection, including cancel acceptance and subsequent status changes.  The original requester is always allowed to read their request. Otherwise, callers must have the `idn:machine-identity-lifecycle-action:manage` scope **and** role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  **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 (response includes `requestId` as a parameter). - `FORBIDDEN.unsupported-type` - the persisted lifecycle row is not scoped to `AI_AGENT`   (`targetType` on read-by-request-id paths).  **404 Not Found**  - `NOT_FOUND.detailed` - unknown `requestId`, or persisted `targetType` does not match the   target machine identity\'s subtype-to-resource-type mapping.
-     * @summary Get lifecycle action by requestId
+     * Returns a single lifecycle action request, including its current status, approval details, and provisioning progress. Use it to follow a request after you submit or cancel it.  You can always view requests that you submitted. To view 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.
+     * @summary Get machine identity lifecycle action
      * @param {MachineIdentityLifecycleActionsApiGetMachineIdentityLifecycleActionV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
@@ -944,8 +948,8 @@ export declare class MachineIdentityLifecycleActionsApi extends BaseAPI {
      */
     getMachineIdentityLifecycleActionV1(requestParameters: MachineIdentityLifecycleActionsApiGetMachineIdentityLifecycleActionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LifecycleActionRequest, any>>;
     /**
-     * Lists lifecycle requests visible to the requester identity in the current request context.  Results are automatically scoped to the calling identity. If requester identity context is missing, an empty list is returned.  When `limit` is omitted, this endpoint applies a default limit of 50.
-     * @summary List lifecycle actions
+     * Returns the lifecycle action requests that you submitted. Requests that other users submitted aren\'t included, even if you\'re an admin. If the call isn\'t made on behalf of an identity, the list is empty.  When `limit` is omitted, up to 50 results are returned.
+     * @summary List machine identity lifecycle actions
      * @param {MachineIdentityLifecycleActionsApiListMachineIdentityLifecycleActionsV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
      * @throws {RequiredError}
@@ -953,7 +957,7 @@ export declare class MachineIdentityLifecycleActionsApi extends BaseAPI {
      */
     listMachineIdentityLifecycleActionsV1(requestParameters?: MachineIdentityLifecycleActionsApiListMachineIdentityLifecycleActionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LifecycleActionRequest[], any>>;
     /**
-     * Creates a lifecycle request for the target machine identity and returns the created lifecycle snapshot.  **Note:** Lifecycle actions are currently supported only for machine identities of type **Agent**.  The response includes the generated `requestId`, which is used by https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1, https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1, and https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1  Authorization is enforced in the service layer. Callers must have the `idn:machine-identity-lifecycle-action:manage` scope or role-context access to the target machine identity (organization admin, source admin, scoped source sub-admin, or effective owner).  Supported actions are `DEACTIVATE`, `ACTIVATE`.
+     * 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](https://developer.sailpoint.com/docs/api/get-machine-identity-lifecycle-action-v-1) or [cancel it](https://developer.sailpoint.com/docs/api/cancel-machine-identity-lifecycle-action-v-1). To see all the requests you\'ve submitted, use [list machine identity lifecycle actions](https://developer.sailpoint.com/docs/api/list-machine-identity-lifecycle-actions-v-1).  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.
      * @summary Submit machine identity lifecycle action
      * @param {MachineIdentityLifecycleActionsApiSubmitMachineIdentityLifecycleActionV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.