@sailpoint/api-client 2.2.35 → 2.2.37

package/dist/jit_activations/api.d.ts

@@ -85,6 +85,205 @@ export interface ErrorResponseDto {
      */
     'causes'?: Array<ErrorMessageDto>;
 }
+/**
+ * Data submitted for a friction step.
+ * @export
+ * @interface FrictionSubmittedData
+ */
+export interface FrictionSubmittedData {
+    /**
+     * Justification text.
+     * @type {string}
+     * @memberof FrictionSubmittedData
+     */
+    'justification'?: string;
+    /**
+     * Whether this step was bypassed.
+     * @type {boolean}
+     * @memberof FrictionSubmittedData
+     */
+    'bypass'?: boolean;
+    /**
+     * Ticketing system identifier.
+     * @type {string}
+     * @memberof FrictionSubmittedData
+     */
+    'ticketId'?: string;
+    /**
+     * Whether the ticket is valid. Set by the server.
+     * @type {boolean}
+     * @memberof FrictionSubmittedData
+     */
+    'isValidTicket'?: boolean;
+    /**
+     * Count of failed submissions for this step. The server sets this value and ignores it on PATCH.
+     * @type {number}
+     * @memberof FrictionSubmittedData
+     */
+    'attempts'?: number;
+    /**
+     * Whether reauthentication succeeded.
+     * @type {boolean}
+     * @memberof FrictionSubmittedData
+     */
+    'reauthSuccessful'?: boolean;
+    /**
+     * Time of reauthentication.
+     * @type {string}
+     * @memberof FrictionSubmittedData
+     */
+    'reauthDate'?: string;
+    /**
+     * Whether the ticketing integration is disabled. Set by the server.
+     * @type {boolean}
+     * @memberof FrictionSubmittedData
+     */
+    'integrationDisabled'?: boolean;
+}
+/**
+ * Submission for the current friction step.
+ * @export
+ * @interface JITActivationFrictionPatchRequest
+ */
+export interface JITActivationFrictionPatchRequest {
+    /**
+     * Kind of friction step being submitted.
+     * @type {JITActivationFrictionType}
+     * @memberof JITActivationFrictionPatchRequest
+     */
+    'type': JITActivationFrictionType;
+    /**
+     * Data submitted for this friction step. Omit when bypassing a step that allows bypass.
+     * @type {FrictionSubmittedData}
+     * @memberof JITActivationFrictionPatchRequest
+     */
+    'submittedData'?: FrictionSubmittedData;
+    /**
+     * Whether to bypass this friction step.
+     * @type {boolean}
+     * @memberof JITActivationFrictionPatchRequest
+     */
+    'bypass'?: boolean | null;
+}
+/**
+ * One friction step on an activation.
+ * @export
+ * @interface JITActivationFrictionResponse
+ */
+export interface JITActivationFrictionResponse {
+    /**
+     * Kind of friction step.
+     * @type {JITActivationFrictionType}
+     * @memberof JITActivationFrictionResponse
+     */
+    'type': JITActivationFrictionType | null;
+    /**
+     * Lifecycle of this friction step.
+     * @type {JITActivationFrictionStatus}
+     * @memberof JITActivationFrictionResponse
+     */
+    'status': JITActivationFrictionStatus | null;
+    /**
+     * Data submitted for this friction step.
+     * @type {FrictionSubmittedData}
+     * @memberof JITActivationFrictionResponse
+     */
+    'submittedData': FrictionSubmittedData | null;
+    /**
+     * Whether this step may be bypassed.
+     * @type {boolean}
+     * @memberof JITActivationFrictionResponse
+     */
+    'bypassAllowed': boolean;
+    /**
+     * Minimum word count for a justification step.
+     * @type {number}
+     * @memberof JITActivationFrictionResponse
+     */
+    'minWords'?: number;
+}
+/**
+ * Aggregate friction state of an activation.
+ * @export
+ * @enum {string}
+ */
+export declare const JITActivationFrictionState: {
+    readonly Pending: "PENDING";
+    readonly InProgress: "IN_PROGRESS";
+    readonly TimedOut: "TIMED_OUT";
+    readonly Complete: "COMPLETE";
+    readonly NotApplicable: "NOT_APPLICABLE";
+};
+export type JITActivationFrictionState = typeof JITActivationFrictionState[keyof typeof JITActivationFrictionState];
+/**
+ * Lifecycle of one friction step.
+ * @export
+ * @enum {string}
+ */
+export declare const JITActivationFrictionStatus: {
+    readonly Pending: "PENDING";
+    readonly Active: "ACTIVE";
+    readonly TimedOut: "TIMED_OUT";
+    readonly Complete: "COMPLETE";
+    readonly NotApplicable: "NOT_APPLICABLE";
+    readonly Cancelled: "CANCELLED";
+    readonly Failed: "FAILED";
+};
+export type JITActivationFrictionStatus = typeof JITActivationFrictionStatus[keyof typeof JITActivationFrictionStatus];
+/**
+ * Kind of friction step.
+ * @export
+ * @enum {string}
+ */
+export declare const JITActivationFrictionType: {
+    readonly Ticket: "TICKET";
+    readonly Justification: "JUSTIFICATION";
+    readonly Reauthentication: "REAUTHENTICATION";
+};
+export type JITActivationFrictionType = typeof JITActivationFrictionType[keyof typeof JITActivationFrictionType];
+/**
+ * Friction state for an activation.
+ * @export
+ * @interface JITActivationFrictionsResponse
+ */
+export interface JITActivationFrictionsResponse {
+    /**
+     * Identifier of the activation.
+     * @type {string}
+     * @memberof JITActivationFrictionsResponse
+     */
+    'activationId': string | null;
+    /**
+     * Aggregate friction state of the activation.
+     * @type {JITActivationFrictionState}
+     * @memberof JITActivationFrictionsResponse
+     */
+    'frictionState': JITActivationFrictionState | null;
+    /**
+     * Identifier of the entitlement connection.
+     * @type {string}
+     * @memberof JITActivationFrictionsResponse
+     */
+    'connectionId': string | null;
+    /**
+     * Time the activation started.
+     * @type {string}
+     * @memberof JITActivationFrictionsResponse
+     */
+    'activationInitTime': string | null;
+    /**
+     * Minutes allowed to complete all frictions.
+     * @type {string}
+     * @memberof JITActivationFrictionsResponse
+     */
+    'expiryMins': string;
+    /**
+     * Friction steps for the activation.
+     * @type {Array<JITActivationFrictionResponse>}
+     * @memberof JITActivationFrictionsResponse
+     */
+    'frictions': Array<JITActivationFrictionResponse>;
+}
 /**
  *
  * @export
@@ -704,6 +903,15 @@ export interface StartActivateWorkflowV1429Response {
  * @export
  */
 export declare const JITActivationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns evaluated frictions for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Returns HTTP 404 when the activation does not exist.
+     * @summary Get JIT activation frictions
+     * @param {string} activationId Identifier of the activation.
+     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJitActivationFrictionsV1: (activationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns JIT activation history records for the authenticated identity only.  This is the self-service view - results are automatically scoped to the calling identity. Requires `idn:jit-activation-history-self:read`.  Returns HTTP 403 when the `PSPM_858_JIT_ACCESS_ACTIVATION_HISTORY_SEARCH` feature flag is disabled.
      * @summary List JIT activation history (self)
@@ -732,6 +940,16 @@ export declare const JITActivationsApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     listJitActivationHistoryV1: (limit?: number, offset?: number, count?: boolean, sorters?: string, searchAfter?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Submits the current friction step for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Request bodies larger than 16 KB return HTTP 413.
+     * @summary Submit JIT activation friction
+     * @param {string} activationId Identifier of the activation.
+     * @param {JITActivationFrictionPatchRequest} jITActivationFrictionPatchRequest Submission for the current friction step.
+     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchJitActivationFrictionsV1: (activationId: string, jITActivationFrictionPatchRequest: JITActivationFrictionPatchRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation.  The response is returned with HTTP 202 Accepted while the workflow initializes.
      * @summary Start JIT activation workflow
@@ -765,6 +983,15 @@ export declare const JITActivationsApiAxiosParamCreator: (configuration?: Config
  * @export
  */
 export declare const JITActivationsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns evaluated frictions for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Returns HTTP 404 when the activation does not exist.
+     * @summary Get JIT activation frictions
+     * @param {string} activationId Identifier of the activation.
+     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJitActivationFrictionsV1(activationId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JITActivationFrictionsResponse>>;
     /**
      * Returns JIT activation history records for the authenticated identity only.  This is the self-service view - results are automatically scoped to the calling identity. Requires `idn:jit-activation-history-self:read`.  Returns HTTP 403 when the `PSPM_858_JIT_ACCESS_ACTIVATION_HISTORY_SEARCH` feature flag is disabled.
      * @summary List JIT activation history (self)
@@ -793,6 +1020,16 @@ export declare const JITActivationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listJitActivationHistoryV1(limit?: number, offset?: number, count?: boolean, sorters?: string, searchAfter?: string, filters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Jitactivationhistorydocument>>>;
+    /**
+     * Submits the current friction step for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Request bodies larger than 16 KB return HTTP 413.
+     * @summary Submit JIT activation friction
+     * @param {string} activationId Identifier of the activation.
+     * @param {JITActivationFrictionPatchRequest} jITActivationFrictionPatchRequest Submission for the current friction step.
+     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchJitActivationFrictionsV1(activationId: string, jITActivationFrictionPatchRequest: JITActivationFrictionPatchRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JITActivationFrictionsResponse>>;
     /**
      * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation.  The response is returned with HTTP 202 Accepted while the workflow initializes.
      * @summary Start JIT activation workflow
@@ -826,6 +1063,14 @@ export declare const JITActivationsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const JITActivationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns evaluated frictions for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Returns HTTP 404 when the activation does not exist.
+     * @summary Get JIT activation frictions
+     * @param {JITActivationsApiGetJitActivationFrictionsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    getJitActivationFrictionsV1(requestParameters: JITActivationsApiGetJitActivationFrictionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<JITActivationFrictionsResponse>;
     /**
      * Returns JIT activation history records for the authenticated identity only.  This is the self-service view - results are automatically scoped to the calling identity. Requires `idn:jit-activation-history-self:read`.  Returns HTTP 403 when the `PSPM_858_JIT_ACCESS_ACTIVATION_HISTORY_SEARCH` feature flag is disabled.
      * @summary List JIT activation history (self)
@@ -842,6 +1087,14 @@ export declare const JITActivationsApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     listJitActivationHistoryV1(requestParameters?: JITActivationsApiListJitActivationHistoryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Jitactivationhistorydocument>>;
+    /**
+     * Submits the current friction step for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Request bodies larger than 16 KB return HTTP 413.
+     * @summary Submit JIT activation friction
+     * @param {JITActivationsApiPatchJitActivationFrictionsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchJitActivationFrictionsV1(requestParameters: JITActivationsApiPatchJitActivationFrictionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<JITActivationFrictionsResponse>;
     /**
      * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation.  The response is returned with HTTP 202 Accepted while the workflow initializes.
      * @summary Start JIT activation workflow
@@ -867,6 +1120,25 @@ export declare const JITActivationsApiFactory: (configuration?: Configuration, b
      */
     startExtendWorkflowV1(requestParameters: JITActivationsApiStartExtendWorkflowV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<JitActivationExtendResponse>;
 };
+/**
+ * Request parameters for getJitActivationFrictionsV1 operation in JITActivationsApi.
+ * @export
+ * @interface JITActivationsApiGetJitActivationFrictionsV1Request
+ */
+export interface JITActivationsApiGetJitActivationFrictionsV1Request {
+    /**
+     * Identifier of the activation.
+     * @type {string}
+     * @memberof JITActivationsApiGetJitActivationFrictionsV1
+     */
+    readonly activationId: string;
+    /**
+     * Use this header to enable this experimental API.
+     * @type {string}
+     * @memberof JITActivationsApiGetJitActivationFrictionsV1
+     */
+    readonly xSailPointExperimental?: string;
+}
 /**
  * Request parameters for listJitActivationHistoryForCurrentIdentityV1 operation in JITActivationsApi.
  * @export
@@ -965,6 +1237,31 @@ export interface JITActivationsApiListJitActivationHistoryV1Request {
      */
     readonly xSailPointExperimental?: string;
 }
+/**
+ * Request parameters for patchJitActivationFrictionsV1 operation in JITActivationsApi.
+ * @export
+ * @interface JITActivationsApiPatchJitActivationFrictionsV1Request
+ */
+export interface JITActivationsApiPatchJitActivationFrictionsV1Request {
+    /**
+     * Identifier of the activation.
+     * @type {string}
+     * @memberof JITActivationsApiPatchJitActivationFrictionsV1
+     */
+    readonly activationId: string;
+    /**
+     * Submission for the current friction step.
+     * @type {JITActivationFrictionPatchRequest}
+     * @memberof JITActivationsApiPatchJitActivationFrictionsV1
+     */
+    readonly jITActivationFrictionPatchRequest: JITActivationFrictionPatchRequest;
+    /**
+     * Use this header to enable this experimental API.
+     * @type {string}
+     * @memberof JITActivationsApiPatchJitActivationFrictionsV1
+     */
+    readonly xSailPointExperimental?: string;
+}
 /**
  * Request parameters for startActivateWorkflowV1 operation in JITActivationsApi.
  * @export
@@ -1029,6 +1326,15 @@ export interface JITActivationsApiStartExtendWorkflowV1Request {
  * @extends {BaseAPI}
  */
 export declare class JITActivationsApi extends BaseAPI {
+    /**
+     * Returns evaluated frictions for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Returns HTTP 404 when the activation does not exist.
+     * @summary Get JIT activation frictions
+     * @param {JITActivationsApiGetJitActivationFrictionsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JITActivationsApi
+     */
+    getJitActivationFrictionsV1(requestParameters: JITActivationsApiGetJitActivationFrictionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JITActivationFrictionsResponse, any>>;
     /**
      * Returns JIT activation history records for the authenticated identity only.  This is the self-service view - results are automatically scoped to the calling identity. Requires `idn:jit-activation-history-self:read`.  Returns HTTP 403 when the `PSPM_858_JIT_ACCESS_ACTIVATION_HISTORY_SEARCH` feature flag is disabled.
      * @summary List JIT activation history (self)
@@ -1047,6 +1353,15 @@ export declare class JITActivationsApi extends BaseAPI {
      * @memberof JITActivationsApi
      */
     listJitActivationHistoryV1(requestParameters?: JITActivationsApiListJitActivationHistoryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Jitactivationhistorydocument[], any>>;
+    /**
+     * Submits the current friction step for a JIT Privileged (JIT P) activation.  Requires OAuth scope **idn:jit-activation-workflow:activate** or **idn:jit-activation-workflow:manage**. The JWT identity id must match the activation identity.  Returns HTTP 403 when **PSPM_JIT_ACCESS_ACTIVATION** or **PSPM_JIT_ACCESS_ACTIVATION_15** is disabled.  Request bodies larger than 16 KB return HTTP 413.
+     * @summary Submit JIT activation friction
+     * @param {JITActivationsApiPatchJitActivationFrictionsV1Request} requestParameters Request parameters.
+     * @param {*} [axiosOptions] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JITActivationsApi
+     */
+    patchJitActivationFrictionsV1(requestParameters: JITActivationsApiPatchJitActivationFrictionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JITActivationFrictionsResponse, any>>;
     /**
      * Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation.  The response is returned with HTTP 202 Accepted while the workflow initializes.
      * @summary Start JIT activation workflow