/** * Identity Security Cloud API - SOD Policies * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface AccessCriteria */ export interface AccessCriteria { /** * Business name for the access construct list * @type {string} * @memberof AccessCriteria */ 'name'?: string; /** * List of criteria. There is a min of 1 and max of 50 items in the list. * @type {Array} * @memberof AccessCriteria */ 'criteriaList'?: Array; } /** * * @export * @interface AccessCriteriaCriteriaListInner */ export interface AccessCriteriaCriteriaListInner { /** * Type of the propery to which this reference applies to * @type {string} * @memberof AccessCriteriaCriteriaListInner */ 'type'?: AccessCriteriaCriteriaListInnerTypeEnum; /** * ID of the object to which this reference applies to * @type {string} * @memberof AccessCriteriaCriteriaListInner */ 'id'?: string; /** * Human-readable display name of the object to which this reference applies to * @type {string} * @memberof AccessCriteriaCriteriaListInner */ 'name'?: string; } export declare const AccessCriteriaCriteriaListInnerTypeEnum: { readonly Entitlement: "ENTITLEMENT"; }; export type AccessCriteriaCriteriaListInnerTypeEnum = typeof AccessCriteriaCriteriaListInnerTypeEnum[keyof typeof AccessCriteriaCriteriaListInnerTypeEnum]; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface ConflictingAccessCriteria */ export interface ConflictingAccessCriteria { /** * * @type {AccessCriteria} * @memberof ConflictingAccessCriteria */ 'leftCriteria'?: AccessCriteria; /** * * @type {AccessCriteria} * @memberof ConflictingAccessCriteria */ 'rightCriteria'?: AccessCriteria; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListSodPoliciesV1401Response */ export interface ListSodPoliciesV1401Response { /** * A message describing the error * @type {any} * @memberof ListSodPoliciesV1401Response */ 'error'?: any; } /** * * @export * @interface ListSodPoliciesV1429Response */ export interface ListSodPoliciesV1429Response { /** * A message describing the error * @type {any} * @memberof ListSodPoliciesV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface MultiPolicyRequest */ export interface MultiPolicyRequest { /** * Multi-policy report will be run for this list of ids * @type {Array} * @memberof MultiPolicyRequest */ 'filteredPolicyList'?: Array; } /** * * @export * @interface ReportResultReference */ export interface ReportResultReference { /** * SOD policy violation report result DTO type. * @type {string} * @memberof ReportResultReference */ 'type'?: ReportResultReferenceTypeEnum; /** * SOD policy violation report result ID. * @type {string} * @memberof ReportResultReference */ 'id'?: string; /** * Human-readable name of the SOD policy violation report result. * @type {string} * @memberof ReportResultReference */ 'name'?: string; /** * Status of a SOD policy violation report. * @type {string} * @memberof ReportResultReference */ 'status'?: ReportResultReferenceStatusEnum; } export declare const ReportResultReferenceTypeEnum: { readonly ReportResult: "REPORT_RESULT"; }; export type ReportResultReferenceTypeEnum = typeof ReportResultReferenceTypeEnum[keyof typeof ReportResultReferenceTypeEnum]; export declare const ReportResultReferenceStatusEnum: { readonly Success: "SUCCESS"; readonly Warning: "WARNING"; readonly Error: "ERROR"; readonly Terminated: "TERMINATED"; readonly TempError: "TEMP_ERROR"; readonly Pending: "PENDING"; }; export type ReportResultReferenceStatusEnum = typeof ReportResultReferenceStatusEnum[keyof typeof ReportResultReferenceStatusEnum]; /** * The schedule information. * @export * @interface Schedule */ export interface Schedule { /** * * @type {ScheduleType} * @memberof Schedule */ 'type': ScheduleType; /** * * @type {ScheduleMonths} * @memberof Schedule */ 'months'?: ScheduleMonths; /** * * @type {ScheduleDays} * @memberof Schedule */ 'days'?: ScheduleDays; /** * * @type {ScheduleHours} * @memberof Schedule */ 'hours': ScheduleHours; /** * A date-time in ISO-8601 format * @type {string} * @memberof Schedule */ 'expiration'?: string | null; /** * The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. * @type {string} * @memberof Schedule */ 'timeZoneId'?: string | null; } /** * * @export * @interface ScheduleDays */ export interface ScheduleDays { /** * * @type {SelectorType} * @memberof ScheduleDays */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof ScheduleDays */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof ScheduleDays */ 'interval'?: number | null; } /** * * @export * @interface ScheduleHours */ export interface ScheduleHours { /** * * @type {SelectorType} * @memberof ScheduleHours */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof ScheduleHours */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof ScheduleHours */ 'interval'?: number | null; } /** * * @export * @interface ScheduleMonths */ export interface ScheduleMonths { /** * * @type {SelectorType} * @memberof ScheduleMonths */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof ScheduleMonths */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof ScheduleMonths */ 'interval'?: number | null; } /** * Enum representing the currently supported schedule types. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const ScheduleType: { readonly Daily: "DAILY"; readonly Weekly: "WEEKLY"; readonly Monthly: "MONTHLY"; readonly Calendar: "CALENDAR"; readonly Annually: "ANNUALLY"; }; export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType]; /** * * @export * @interface Selector */ export interface Selector { /** * * @type {SelectorType} * @memberof Selector */ 'type': SelectorType; /** * The selected values. * @type {Array} * @memberof Selector */ 'values': Array; /** * The selected interval for RANGE selectors. * @type {number} * @memberof Selector */ 'interval'?: number | null; } /** * Enum representing the currently supported selector types. LIST - the *values* array contains one or more distinct values. RANGE - the *values* array contains two values: the start and end of the range, inclusive. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const SelectorType: { readonly List: "LIST"; readonly Range: "RANGE"; }; export type SelectorType = typeof SelectorType[keyof typeof SelectorType]; /** * * @export * @interface SodPolicy */ export interface SodPolicy { /** * Policy id * @type {string} * @memberof SodPolicy */ 'id'?: string; /** * Policy Business Name * @type {string} * @memberof SodPolicy */ 'name'?: string; /** * The time when this SOD policy is created. * @type {string} * @memberof SodPolicy */ 'created'?: string; /** * The time when this SOD policy is modified. * @type {string} * @memberof SodPolicy */ 'modified'?: string; /** * Optional description of the SOD policy * @type {string} * @memberof SodPolicy */ 'description'?: string | null; /** * * @type {SodPolicyOwnerRef} * @memberof SodPolicy */ 'ownerRef'?: SodPolicyOwnerRef; /** * Optional External Policy Reference * @type {string} * @memberof SodPolicy */ 'externalPolicyReference'?: string | null; /** * Search query of the SOD policy * @type {string} * @memberof SodPolicy */ 'policyQuery'?: string; /** * Optional compensating controls(Mitigating Controls) * @type {string} * @memberof SodPolicy */ 'compensatingControls'?: string | null; /** * Optional correction advice * @type {string} * @memberof SodPolicy */ 'correctionAdvice'?: string | null; /** * whether the policy is enforced or not * @type {string} * @memberof SodPolicy */ 'state'?: SodPolicyStateEnum; /** * tags for this policy object * @type {Array} * @memberof SodPolicy */ 'tags'?: Array; /** * Policy\'s creator ID * @type {string} * @memberof SodPolicy */ 'creatorId'?: string; /** * Policy\'s modifier ID * @type {string} * @memberof SodPolicy */ 'modifierId'?: string | null; /** * * @type {ViolationOwnerAssignmentConfig} * @memberof SodPolicy */ 'violationOwnerAssignmentConfig'?: ViolationOwnerAssignmentConfig; /** * defines whether a policy has been scheduled or not * @type {boolean} * @memberof SodPolicy */ 'scheduled'?: boolean; /** * whether a policy is query based or conflicting access based * @type {string} * @memberof SodPolicy */ 'type'?: SodPolicyTypeEnum; /** * * @type {SodPolicyConflictingAccessCriteria} * @memberof SodPolicy */ 'conflictingAccessCriteria'?: SodPolicyConflictingAccessCriteria; } export declare const SodPolicyStateEnum: { readonly Enforced: "ENFORCED"; readonly NotEnforced: "NOT_ENFORCED"; }; export type SodPolicyStateEnum = typeof SodPolicyStateEnum[keyof typeof SodPolicyStateEnum]; export declare const SodPolicyTypeEnum: { readonly General: "GENERAL"; readonly ConflictingAccessBased: "CONFLICTING_ACCESS_BASED"; }; export type SodPolicyTypeEnum = typeof SodPolicyTypeEnum[keyof typeof SodPolicyTypeEnum]; /** * * @export * @interface SodPolicyConflictingAccessCriteria */ export interface SodPolicyConflictingAccessCriteria { /** * * @type {AccessCriteria} * @memberof SodPolicyConflictingAccessCriteria */ 'leftCriteria'?: AccessCriteria; /** * * @type {AccessCriteria} * @memberof SodPolicyConflictingAccessCriteria */ 'rightCriteria'?: AccessCriteria; } /** * The owner of the SOD policy. * @export * @interface SodPolicyOwnerRef */ export interface SodPolicyOwnerRef { /** * Owner type. * @type {string} * @memberof SodPolicyOwnerRef */ 'type'?: SodPolicyOwnerRefTypeEnum; /** * Owner\'s ID. * @type {string} * @memberof SodPolicyOwnerRef */ 'id'?: string; /** * Owner\'s name. * @type {string} * @memberof SodPolicyOwnerRef */ 'name'?: string; } export declare const SodPolicyOwnerRefTypeEnum: { readonly Identity: "IDENTITY"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; }; export type SodPolicyOwnerRefTypeEnum = typeof SodPolicyOwnerRefTypeEnum[keyof typeof SodPolicyOwnerRefTypeEnum]; /** * * @export * @interface SodPolicySchedule */ export interface SodPolicySchedule { /** * SOD Policy schedule name * @type {string} * @memberof SodPolicySchedule */ 'name'?: string; /** * The time when this SOD policy schedule is created. * @type {string} * @memberof SodPolicySchedule */ 'created'?: string; /** * The time when this SOD policy schedule is modified. * @type {string} * @memberof SodPolicySchedule */ 'modified'?: string; /** * SOD Policy schedule description * @type {string} * @memberof SodPolicySchedule */ 'description'?: string; /** * * @type {Schedule} * @memberof SodPolicySchedule */ 'schedule'?: Schedule; /** * * @type {Array} * @memberof SodPolicySchedule */ 'recipients'?: Array; /** * Indicates if empty results need to be emailed * @type {boolean} * @memberof SodPolicySchedule */ 'emailEmptyResults'?: boolean; /** * Policy\'s creator ID * @type {string} * @memberof SodPolicySchedule */ 'creatorId'?: string; /** * Policy\'s modifier ID * @type {string} * @memberof SodPolicySchedule */ 'modifierId'?: string; } /** * SOD policy recipient. * @export * @interface SodRecipient */ export interface SodRecipient { /** * SOD policy recipient DTO type. * @type {string} * @memberof SodRecipient */ 'type'?: SodRecipientTypeEnum; /** * SOD policy recipient\'s identity ID. * @type {string} * @memberof SodRecipient */ 'id'?: string; /** * SOD policy recipient\'s display name. * @type {string} * @memberof SodRecipient */ 'name'?: string; } export declare const SodRecipientTypeEnum: { readonly Identity: "IDENTITY"; }; export type SodRecipientTypeEnum = typeof SodRecipientTypeEnum[keyof typeof SodRecipientTypeEnum]; /** * SOD policy violation report result. * @export * @interface SodReportResultDto */ export interface SodReportResultDto { /** * SOD policy violation report result DTO type. * @type {string} * @memberof SodReportResultDto */ 'type'?: SodReportResultDtoTypeEnum; /** * SOD policy violation report result ID. * @type {string} * @memberof SodReportResultDto */ 'id'?: string; /** * Human-readable name of the SOD policy violation report result. * @type {string} * @memberof SodReportResultDto */ 'name'?: string; } export declare const SodReportResultDtoTypeEnum: { readonly ReportResult: "REPORT_RESULT"; }; export type SodReportResultDtoTypeEnum = typeof SodReportResultDtoTypeEnum[keyof typeof SodReportResultDtoTypeEnum]; /** * * @export * @interface ViolationOwnerAssignmentConfig */ export interface ViolationOwnerAssignmentConfig { /** * Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity * @type {string} * @memberof ViolationOwnerAssignmentConfig */ 'assignmentRule'?: ViolationOwnerAssignmentConfigAssignmentRuleEnum | null; /** * * @type {ViolationOwnerAssignmentConfigOwnerRef} * @memberof ViolationOwnerAssignmentConfig */ 'ownerRef'?: ViolationOwnerAssignmentConfigOwnerRef | null; } export declare const ViolationOwnerAssignmentConfigAssignmentRuleEnum: { readonly Manager: "MANAGER"; readonly Static: "STATIC"; }; export type ViolationOwnerAssignmentConfigAssignmentRuleEnum = typeof ViolationOwnerAssignmentConfigAssignmentRuleEnum[keyof typeof ViolationOwnerAssignmentConfigAssignmentRuleEnum]; /** * The owner of the violation assignment config. * @export * @interface ViolationOwnerAssignmentConfigOwnerRef */ export interface ViolationOwnerAssignmentConfigOwnerRef { /** * Owner type. * @type {string} * @memberof ViolationOwnerAssignmentConfigOwnerRef */ 'type'?: ViolationOwnerAssignmentConfigOwnerRefTypeEnum | null; /** * Owner\'s ID. * @type {string} * @memberof ViolationOwnerAssignmentConfigOwnerRef */ 'id'?: string; /** * Owner\'s name. * @type {string} * @memberof ViolationOwnerAssignmentConfigOwnerRef */ 'name'?: string; } export declare const ViolationOwnerAssignmentConfigOwnerRefTypeEnum: { readonly Identity: "IDENTITY"; readonly GovernanceGroup: "GOVERNANCE_GROUP"; readonly Manager: "MANAGER"; }; export type ViolationOwnerAssignmentConfigOwnerRefTypeEnum = typeof ViolationOwnerAssignmentConfigOwnerRefTypeEnum[keyof typeof ViolationOwnerAssignmentConfigOwnerRefTypeEnum]; /** * SODPoliciesApi - axios parameter creator * @export */ export declare const SODPoliciesApiAxiosParamCreator: (configuration?: Configuration) => { /** * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. * @summary Create sod policy * @param {SodPolicy} sodPolicy * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSodPolicyV1: (sodPolicy: SodPolicy, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This deletes schedule for a specified SOD policy by ID. * @summary Delete sod policy schedule * @param {string} id The ID of the SOD policy the schedule must be deleted for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSodPolicyScheduleV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This deletes a specified SOD policy. Requires role of ORG_ADMIN. * @summary Delete sod policy by id * @param {string} id The ID of the SOD Policy to delete. * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSodPolicyV1: (id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This allows to download a specified named violation report for a given report reference. * @summary Download custom violation report * @param {string} reportResultId The ID of the report reference to download. * @param {string} fileName Custom Name for the file. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCustomViolationReportV1: (reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This allows to download a violation report for a given report reference. * @summary Download violation report * @param {string} reportResultId The ID of the report reference to download. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDefaultViolationReportV1: (reportResultId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint gets the status for a violation report for all policy run. * @summary Get multi-report run task status * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodAllReportRunStatusV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint gets a specified SOD policy\'s schedule. * @summary Get sod policy schedule * @param {string} id The ID of the SOD policy schedule to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodPolicyScheduleV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This gets specified SOD policy. Requires role of ORG_ADMIN. * @summary Get sod policy by id * @param {string} id The ID of the SOD Policy to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodPolicyV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get violation report run status * @param {string} reportResultId The ID of the report reference to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodViolationReportRunStatusV1: (reportResultId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get sod violation report status * @param {string} id The ID of the violation report to retrieve status for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodViolationReportStatusV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This gets list of all SOD policies. Requires role of ORG_ADMIN * @summary List sod policies * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSodPoliciesV1: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. * @summary Patch sod policy by id * @param {string} id The ID of the SOD policy being modified. * @param {Array} jsonPatchOperation A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSodPolicyV1: (id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This updates schedule for a specified SOD policy. * @summary Update sod policy schedule * @param {string} id The ID of the SOD policy to update its schedule. * @param {SodPolicySchedule} sodPolicySchedule * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putPolicyScheduleV1: (id: string, sodPolicySchedule: SodPolicySchedule, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This updates a specified SOD policy. Requires role of ORG_ADMIN. * @summary Update sod policy by id * @param {string} id The ID of the SOD policy to update. * @param {SodPolicy} sodPolicy * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSodPolicyV1: (id: string, sodPolicy: SodPolicy, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. * @summary Evaluate one policy by id * @param {string} id The SOD policy ID to run. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startEvaluateSodPolicyV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. * @summary Runs all policies for org * @param {MultiPolicyRequest} [multiPolicyRequest] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startSodAllPoliciesForOrgV1: (multiPolicyRequest?: MultiPolicyRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. * @summary Runs sod policy violation report * @param {string} id The SOD policy ID to run. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startSodPolicyV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SODPoliciesApi - functional programming interface * @export */ export declare const SODPoliciesApiFp: (configuration?: Configuration) => { /** * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. * @summary Create sod policy * @param {SodPolicy} sodPolicy * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSodPolicyV1(sodPolicy: SodPolicy, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This deletes schedule for a specified SOD policy by ID. * @summary Delete sod policy schedule * @param {string} id The ID of the SOD policy the schedule must be deleted for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSodPolicyScheduleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This deletes a specified SOD policy. Requires role of ORG_ADMIN. * @summary Delete sod policy by id * @param {string} id The ID of the SOD Policy to delete. * @param {boolean} [logical] Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSodPolicyV1(id: string, logical?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This allows to download a specified named violation report for a given report reference. * @summary Download custom violation report * @param {string} reportResultId The ID of the report reference to download. * @param {string} fileName Custom Name for the file. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCustomViolationReportV1(reportResultId: string, fileName: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This allows to download a violation report for a given report reference. * @summary Download violation report * @param {string} reportResultId The ID of the report reference to download. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDefaultViolationReportV1(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint gets the status for a violation report for all policy run. * @summary Get multi-report run task status * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodAllReportRunStatusV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint gets a specified SOD policy\'s schedule. * @summary Get sod policy schedule * @param {string} id The ID of the SOD policy schedule to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodPolicyScheduleV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This gets specified SOD policy. Requires role of ORG_ADMIN. * @summary Get sod policy by id * @param {string} id The ID of the SOD Policy to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodPolicyV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get violation report run status * @param {string} reportResultId The ID of the report reference to retrieve. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodViolationReportRunStatusV1(reportResultId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get sod violation report status * @param {string} id The ID of the violation report to retrieve status for. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodViolationReportStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This gets list of all SOD policies. Requires role of ORG_ADMIN * @summary List sod policies * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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 [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSodPoliciesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. * @summary Patch sod policy by id * @param {string} id The ID of the SOD policy being modified. * @param {Array} jsonPatchOperation A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSodPolicyV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This updates schedule for a specified SOD policy. * @summary Update sod policy schedule * @param {string} id The ID of the SOD policy to update its schedule. * @param {SodPolicySchedule} sodPolicySchedule * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putPolicyScheduleV1(id: string, sodPolicySchedule: SodPolicySchedule, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This updates a specified SOD policy. Requires role of ORG_ADMIN. * @summary Update sod policy by id * @param {string} id The ID of the SOD policy to update. * @param {SodPolicy} sodPolicy * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSodPolicyV1(id: string, sodPolicy: SodPolicy, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. * @summary Evaluate one policy by id * @param {string} id The SOD policy ID to run. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startEvaluateSodPolicyV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. * @summary Runs all policies for org * @param {MultiPolicyRequest} [multiPolicyRequest] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startSodAllPoliciesForOrgV1(multiPolicyRequest?: MultiPolicyRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. * @summary Runs sod policy violation report * @param {string} id The SOD policy ID to run. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startSodPolicyV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SODPoliciesApi - factory interface * @export */ export declare const SODPoliciesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. * @summary Create sod policy * @param {SODPoliciesApiCreateSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSodPolicyV1(requestParameters: SODPoliciesApiCreateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This deletes schedule for a specified SOD policy by ID. * @summary Delete sod policy schedule * @param {SODPoliciesApiDeleteSodPolicyScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSodPolicyScheduleV1(requestParameters: SODPoliciesApiDeleteSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This deletes a specified SOD policy. Requires role of ORG_ADMIN. * @summary Delete sod policy by id * @param {SODPoliciesApiDeleteSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSodPolicyV1(requestParameters: SODPoliciesApiDeleteSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This allows to download a specified named violation report for a given report reference. * @summary Download custom violation report * @param {SODPoliciesApiGetCustomViolationReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCustomViolationReportV1(requestParameters: SODPoliciesApiGetCustomViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This allows to download a violation report for a given report reference. * @summary Download violation report * @param {SODPoliciesApiGetDefaultViolationReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDefaultViolationReportV1(requestParameters: SODPoliciesApiGetDefaultViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint gets the status for a violation report for all policy run. * @summary Get multi-report run task status * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodAllReportRunStatusV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint gets a specified SOD policy\'s schedule. * @summary Get sod policy schedule * @param {SODPoliciesApiGetSodPolicyScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodPolicyScheduleV1(requestParameters: SODPoliciesApiGetSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This gets specified SOD policy. Requires role of ORG_ADMIN. * @summary Get sod policy by id * @param {SODPoliciesApiGetSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodPolicyV1(requestParameters: SODPoliciesApiGetSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get violation report run status * @param {SODPoliciesApiGetSodViolationReportRunStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodViolationReportRunStatusV1(requestParameters: SODPoliciesApiGetSodViolationReportRunStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get sod violation report status * @param {SODPoliciesApiGetSodViolationReportStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSodViolationReportStatusV1(requestParameters: SODPoliciesApiGetSodViolationReportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This gets list of all SOD policies. Requires role of ORG_ADMIN * @summary List sod policies * @param {SODPoliciesApiListSodPoliciesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listSodPoliciesV1(requestParameters?: SODPoliciesApiListSodPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. * @summary Patch sod policy by id * @param {SODPoliciesApiPatchSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchSodPolicyV1(requestParameters: SODPoliciesApiPatchSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This updates schedule for a specified SOD policy. * @summary Update sod policy schedule * @param {SODPoliciesApiPutPolicyScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putPolicyScheduleV1(requestParameters: SODPoliciesApiPutPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This updates a specified SOD policy. Requires role of ORG_ADMIN. * @summary Update sod policy by id * @param {SODPoliciesApiPutSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putSodPolicyV1(requestParameters: SODPoliciesApiPutSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. * @summary Evaluate one policy by id * @param {SODPoliciesApiStartEvaluateSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startEvaluateSodPolicyV1(requestParameters: SODPoliciesApiStartEvaluateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. * @summary Runs all policies for org * @param {SODPoliciesApiStartSodAllPoliciesForOrgV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startSodAllPoliciesForOrgV1(requestParameters?: SODPoliciesApiStartSodAllPoliciesForOrgV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. * @summary Runs sod policy violation report * @param {SODPoliciesApiStartSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startSodPolicyV1(requestParameters: SODPoliciesApiStartSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiCreateSodPolicyV1Request */ export interface SODPoliciesApiCreateSodPolicyV1Request { /** * * @type {SodPolicy} * @memberof SODPoliciesApiCreateSodPolicyV1 */ readonly sodPolicy: SodPolicy; } /** * Request parameters for deleteSodPolicyScheduleV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiDeleteSodPolicyScheduleV1Request */ export interface SODPoliciesApiDeleteSodPolicyScheduleV1Request { /** * The ID of the SOD policy the schedule must be deleted for. * @type {string} * @memberof SODPoliciesApiDeleteSodPolicyScheduleV1 */ readonly id: string; } /** * Request parameters for deleteSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiDeleteSodPolicyV1Request */ export interface SODPoliciesApiDeleteSodPolicyV1Request { /** * The ID of the SOD Policy to delete. * @type {string} * @memberof SODPoliciesApiDeleteSodPolicyV1 */ readonly id: string; /** * Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. * @type {boolean} * @memberof SODPoliciesApiDeleteSodPolicyV1 */ readonly logical?: boolean; } /** * Request parameters for getCustomViolationReportV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiGetCustomViolationReportV1Request */ export interface SODPoliciesApiGetCustomViolationReportV1Request { /** * The ID of the report reference to download. * @type {string} * @memberof SODPoliciesApiGetCustomViolationReportV1 */ readonly reportResultId: string; /** * Custom Name for the file. * @type {string} * @memberof SODPoliciesApiGetCustomViolationReportV1 */ readonly fileName: string; } /** * Request parameters for getDefaultViolationReportV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiGetDefaultViolationReportV1Request */ export interface SODPoliciesApiGetDefaultViolationReportV1Request { /** * The ID of the report reference to download. * @type {string} * @memberof SODPoliciesApiGetDefaultViolationReportV1 */ readonly reportResultId: string; } /** * Request parameters for getSodPolicyScheduleV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiGetSodPolicyScheduleV1Request */ export interface SODPoliciesApiGetSodPolicyScheduleV1Request { /** * The ID of the SOD policy schedule to retrieve. * @type {string} * @memberof SODPoliciesApiGetSodPolicyScheduleV1 */ readonly id: string; } /** * Request parameters for getSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiGetSodPolicyV1Request */ export interface SODPoliciesApiGetSodPolicyV1Request { /** * The ID of the SOD Policy to retrieve. * @type {string} * @memberof SODPoliciesApiGetSodPolicyV1 */ readonly id: string; } /** * Request parameters for getSodViolationReportRunStatusV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiGetSodViolationReportRunStatusV1Request */ export interface SODPoliciesApiGetSodViolationReportRunStatusV1Request { /** * The ID of the report reference to retrieve. * @type {string} * @memberof SODPoliciesApiGetSodViolationReportRunStatusV1 */ readonly reportResultId: string; } /** * Request parameters for getSodViolationReportStatusV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiGetSodViolationReportStatusV1Request */ export interface SODPoliciesApiGetSodViolationReportStatusV1Request { /** * The ID of the violation report to retrieve status for. * @type {string} * @memberof SODPoliciesApiGetSodViolationReportStatusV1 */ readonly id: string; } /** * Request parameters for listSodPoliciesV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiListSodPoliciesV1Request */ export interface SODPoliciesApiListSodPoliciesV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof SODPoliciesApiListSodPoliciesV1 */ readonly limit?: number; /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof SODPoliciesApiListSodPoliciesV1 */ readonly offset?: number; /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof SODPoliciesApiListSodPoliciesV1 */ readonly count?: boolean; /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* * @type {string} * @memberof SODPoliciesApiListSodPoliciesV1 */ readonly filters?: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** * @type {string} * @memberof SODPoliciesApiListSodPoliciesV1 */ readonly sorters?: string; } /** * Request parameters for patchSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiPatchSodPolicyV1Request */ export interface SODPoliciesApiPatchSodPolicyV1Request { /** * The ID of the SOD policy being modified. * @type {string} * @memberof SODPoliciesApiPatchSodPolicyV1 */ readonly id: string; /** * A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria * @type {Array} * @memberof SODPoliciesApiPatchSodPolicyV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for putPolicyScheduleV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiPutPolicyScheduleV1Request */ export interface SODPoliciesApiPutPolicyScheduleV1Request { /** * The ID of the SOD policy to update its schedule. * @type {string} * @memberof SODPoliciesApiPutPolicyScheduleV1 */ readonly id: string; /** * * @type {SodPolicySchedule} * @memberof SODPoliciesApiPutPolicyScheduleV1 */ readonly sodPolicySchedule: SodPolicySchedule; } /** * Request parameters for putSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiPutSodPolicyV1Request */ export interface SODPoliciesApiPutSodPolicyV1Request { /** * The ID of the SOD policy to update. * @type {string} * @memberof SODPoliciesApiPutSodPolicyV1 */ readonly id: string; /** * * @type {SodPolicy} * @memberof SODPoliciesApiPutSodPolicyV1 */ readonly sodPolicy: SodPolicy; } /** * Request parameters for startEvaluateSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiStartEvaluateSodPolicyV1Request */ export interface SODPoliciesApiStartEvaluateSodPolicyV1Request { /** * The SOD policy ID to run. * @type {string} * @memberof SODPoliciesApiStartEvaluateSodPolicyV1 */ readonly id: string; } /** * Request parameters for startSodAllPoliciesForOrgV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiStartSodAllPoliciesForOrgV1Request */ export interface SODPoliciesApiStartSodAllPoliciesForOrgV1Request { /** * * @type {MultiPolicyRequest} * @memberof SODPoliciesApiStartSodAllPoliciesForOrgV1 */ readonly multiPolicyRequest?: MultiPolicyRequest; } /** * Request parameters for startSodPolicyV1 operation in SODPoliciesApi. * @export * @interface SODPoliciesApiStartSodPolicyV1Request */ export interface SODPoliciesApiStartSodPolicyV1Request { /** * The SOD policy ID to run. * @type {string} * @memberof SODPoliciesApiStartSodPolicyV1 */ readonly id: string; } /** * SODPoliciesApi - object-oriented interface * @export * @class SODPoliciesApi * @extends {BaseAPI} */ export declare class SODPoliciesApi extends BaseAPI { /** * This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. * @summary Create sod policy * @param {SODPoliciesApiCreateSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ createSodPolicyV1(requestParameters: SODPoliciesApiCreateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This deletes schedule for a specified SOD policy by ID. * @summary Delete sod policy schedule * @param {SODPoliciesApiDeleteSodPolicyScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ deleteSodPolicyScheduleV1(requestParameters: SODPoliciesApiDeleteSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This deletes a specified SOD policy. Requires role of ORG_ADMIN. * @summary Delete sod policy by id * @param {SODPoliciesApiDeleteSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ deleteSodPolicyV1(requestParameters: SODPoliciesApiDeleteSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This allows to download a specified named violation report for a given report reference. * @summary Download custom violation report * @param {SODPoliciesApiGetCustomViolationReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getCustomViolationReportV1(requestParameters: SODPoliciesApiGetCustomViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This allows to download a violation report for a given report reference. * @summary Download violation report * @param {SODPoliciesApiGetDefaultViolationReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getDefaultViolationReportV1(requestParameters: SODPoliciesApiGetDefaultViolationReportV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint gets the status for a violation report for all policy run. * @summary Get multi-report run task status * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getSodAllReportRunStatusV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint gets a specified SOD policy\'s schedule. * @summary Get sod policy schedule * @param {SODPoliciesApiGetSodPolicyScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getSodPolicyScheduleV1(requestParameters: SODPoliciesApiGetSodPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This gets specified SOD policy. Requires role of ORG_ADMIN. * @summary Get sod policy by id * @param {SODPoliciesApiGetSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getSodPolicyV1(requestParameters: SODPoliciesApiGetSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get violation report run status * @param {SODPoliciesApiGetSodViolationReportRunStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getSodViolationReportRunStatusV1(requestParameters: SODPoliciesApiGetSodViolationReportRunStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This gets the status for a violation report run task that has already been invoked. * @summary Get sod violation report status * @param {SODPoliciesApiGetSodViolationReportStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ getSodViolationReportStatusV1(requestParameters: SODPoliciesApiGetSodViolationReportStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This gets list of all SOD policies. Requires role of ORG_ADMIN * @summary List sod policies * @param {SODPoliciesApiListSodPoliciesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ listSodPoliciesV1(requestParameters?: SODPoliciesApiListSodPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Allows updating SOD Policy fields other than [\"id\",\"created\",\"creatorId\",\"policyQuery\",\"type\"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. * @summary Patch sod policy by id * @param {SODPoliciesApiPatchSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ patchSodPolicyV1(requestParameters: SODPoliciesApiPatchSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This updates schedule for a specified SOD policy. * @summary Update sod policy schedule * @param {SODPoliciesApiPutPolicyScheduleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ putPolicyScheduleV1(requestParameters: SODPoliciesApiPutPolicyScheduleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This updates a specified SOD policy. Requires role of ORG_ADMIN. * @summary Update sod policy by id * @param {SODPoliciesApiPutSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ putSodPolicyV1(requestParameters: SODPoliciesApiPutSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. * @summary Evaluate one policy by id * @param {SODPoliciesApiStartEvaluateSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ startEvaluateSodPolicyV1(requestParameters: SODPoliciesApiStartEvaluateSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. * @summary Runs all policies for org * @param {SODPoliciesApiStartSodAllPoliciesForOrgV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ startSodAllPoliciesForOrgV1(requestParameters?: SODPoliciesApiStartSodAllPoliciesForOrgV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. * @summary Runs sod policy violation report * @param {SODPoliciesApiStartSodPolicyV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SODPoliciesApi */ startSodPolicyV1(requestParameters: SODPoliciesApiStartSodPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }