/** * Identity Security Cloud API - IAI Role Mining * 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 ArrayInner */ export interface ArrayInner { } /** * * @export * @interface ArrayInner1 */ export interface ArrayInner1 { } /** * * @export * @interface EntityCreatedByDTO */ export interface EntityCreatedByDTO { /** * ID of the creator * @type {string} * @memberof EntityCreatedByDTO */ 'id'?: string; /** * The display name of the creator * @type {string} * @memberof EntityCreatedByDTO */ 'displayName'?: string; } /** * * @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; } /** * * @export * @interface GetRoleMiningSessionsV1401Response */ export interface GetRoleMiningSessionsV1401Response { /** * A message describing the error * @type {any} * @memberof GetRoleMiningSessionsV1401Response */ 'error'?: any; } /** * * @export * @interface GetRoleMiningSessionsV1429Response */ export interface GetRoleMiningSessionsV1429Response { /** * A message describing the error * @type {any} * @memberof GetRoleMiningSessionsV1429Response */ 'message'?: any; } /** * 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]; /** * A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperationRoleMining */ export interface JsonPatchOperationRoleMining { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperationRoleMining */ 'op': JsonPatchOperationRoleMiningOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperationRoleMining */ 'path': string; /** * * @type {JsonPatchOperationRoleMiningValue} * @memberof JsonPatchOperationRoleMining */ 'value'?: JsonPatchOperationRoleMiningValue; } export declare const JsonPatchOperationRoleMiningOpEnum: { readonly Remove: "remove"; readonly Replace: "replace"; }; export type JsonPatchOperationRoleMiningOpEnum = typeof JsonPatchOperationRoleMiningOpEnum[keyof typeof JsonPatchOperationRoleMiningOpEnum]; /** * @type JsonPatchOperationRoleMiningValue * The value to be used for the operation, required for \"replace\" operations * @export */ export type JsonPatchOperationRoleMiningValue = Array | boolean | number | object | string; /** * @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; /** * 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 RoleMiningEntitlement */ export interface RoleMiningEntitlement { /** * * @type {RoleMiningEntitlementRef} * @memberof RoleMiningEntitlement */ 'entitlementRef'?: RoleMiningEntitlementRef; /** * Name of the entitlement * @type {string} * @memberof RoleMiningEntitlement */ 'name'?: string; /** * Application name of the entitlement * @type {string} * @memberof RoleMiningEntitlement */ 'applicationName'?: string; /** * The number of identities with this entitlement in a role. * @type {number} * @memberof RoleMiningEntitlement */ 'identityCount'?: number; /** * The % popularity of this entitlement in a role. * @type {number} * @memberof RoleMiningEntitlement */ 'popularity'?: number; /** * The % popularity of this entitlement in the org. * @type {number} * @memberof RoleMiningEntitlement */ 'popularityInOrg'?: number; /** * The ID of the source/application. * @type {string} * @memberof RoleMiningEntitlement */ 'sourceId'?: string; /** * The status of activity data for the source. Value is complete or notComplete. * @type {string} * @memberof RoleMiningEntitlement */ 'activitySourceState'?: string | null; /** * The percentage of identities in the potential role that have usage of the source/application of this entitlement. * @type {number} * @memberof RoleMiningEntitlement */ 'sourceUsagePercent'?: number | null; } /** * * @export * @interface RoleMiningEntitlementRef */ export interface RoleMiningEntitlementRef { /** * Id of the entitlement * @type {string} * @memberof RoleMiningEntitlementRef */ 'id'?: string; /** * Name of the entitlement * @type {string} * @memberof RoleMiningEntitlementRef */ 'name'?: string; /** * Description forthe entitlement * @type {string} * @memberof RoleMiningEntitlementRef */ 'description'?: string | null; /** * The entitlement attribute * @type {string} * @memberof RoleMiningEntitlementRef */ 'attribute'?: string; } /** * * @export * @interface RoleMiningIdentity */ export interface RoleMiningIdentity { /** * Id of the identity * @type {string} * @memberof RoleMiningIdentity */ 'id'?: string; /** * Name of the identity * @type {string} * @memberof RoleMiningIdentity */ 'name'?: string; /** * * @type {{ [key: string]: string | null; }} * @memberof RoleMiningIdentity */ 'attributes'?: { [key: string]: string | null; }; } /** * * @export * @interface RoleMiningIdentityDistribution */ export interface RoleMiningIdentityDistribution { /** * Id of the potential role * @type {string} * @memberof RoleMiningIdentityDistribution */ 'attributeName'?: string; /** * * @type {Array} * @memberof RoleMiningIdentityDistribution */ 'distribution'?: Array; } /** * * @export * @interface RoleMiningIdentityDistributionDistributionInner */ export interface RoleMiningIdentityDistributionDistributionInner { /** * The attribute value that identities are grouped by * @type {string} * @memberof RoleMiningIdentityDistributionDistributionInner */ 'attributeValue'?: string | null; /** * The number of identities that have this attribute value * @type {number} * @memberof RoleMiningIdentityDistributionDistributionInner */ 'count'?: number; } /** * * @export * @interface RoleMiningPotentialRole */ export interface RoleMiningPotentialRole { /** * * @type {RoleMiningSessionResponseCreatedBy} * @memberof RoleMiningPotentialRole */ 'createdBy'?: RoleMiningSessionResponseCreatedBy; /** * The density of a potential role. * @type {number} * @memberof RoleMiningPotentialRole */ 'density'?: number; /** * The description of a potential role. * @type {string} * @memberof RoleMiningPotentialRole */ 'description'?: string | null; /** * The number of entitlements in a potential role. * @type {number} * @memberof RoleMiningPotentialRole */ 'entitlementCount'?: number; /** * The list of entitlement ids to be excluded. * @type {Array} * @memberof RoleMiningPotentialRole */ 'excludedEntitlements'?: Array | null; /** * The freshness of a potential role. * @type {number} * @memberof RoleMiningPotentialRole */ 'freshness'?: number; /** * The number of identities in a potential role. * @type {number} * @memberof RoleMiningPotentialRole */ 'identityCount'?: number; /** * Identity attribute distribution. * @type {Array} * @memberof RoleMiningPotentialRole */ 'identityDistribution'?: Array | null; /** * The list of ids in a potential role. * @type {Array} * @memberof RoleMiningPotentialRole */ 'identityIds'?: Array; /** * The status for this identity group which can be OBTAINED or COMPRESSED * @type {string} * @memberof RoleMiningPotentialRole */ 'identityGroupStatus'?: string | null; /** * Name of the potential role. * @type {string} * @memberof RoleMiningPotentialRole */ 'name'?: string; /** * * @type {RoleMiningPotentialRolePotentialRoleRef} * @memberof RoleMiningPotentialRole */ 'potentialRoleRef'?: RoleMiningPotentialRolePotentialRoleRef | null; /** * * @type {RoleMiningPotentialRoleProvisionState} * @memberof RoleMiningPotentialRole */ 'provisionState'?: RoleMiningPotentialRoleProvisionState; /** * The quality of a potential role. * @type {number} * @memberof RoleMiningPotentialRole */ 'quality'?: number; /** * The roleId of a potential role. * @type {string} * @memberof RoleMiningPotentialRole */ 'roleId'?: string | null; /** * The potential role\'s saved status. * @type {boolean} * @memberof RoleMiningPotentialRole */ 'saved'?: boolean; /** * * @type {RoleMiningSessionParametersDto} * @memberof RoleMiningPotentialRole */ 'session'?: RoleMiningSessionParametersDto; /** * * @type {RoleMiningRoleType} * @memberof RoleMiningPotentialRole */ 'type'?: RoleMiningRoleType; /** * Id of the potential role * @type {string} * @memberof RoleMiningPotentialRole */ 'id'?: string; /** * The date-time when this potential role was created. * @type {string} * @memberof RoleMiningPotentialRole */ 'createdDate'?: string; /** * The date-time when this potential role was modified. * @type {string} * @memberof RoleMiningPotentialRole */ 'modifiedDate'?: string; } /** * * @export * @interface RoleMiningPotentialRoleApplication */ export interface RoleMiningPotentialRoleApplication { /** * Id of the application * @type {string} * @memberof RoleMiningPotentialRoleApplication */ 'id'?: string; /** * Name of the application * @type {string} * @memberof RoleMiningPotentialRoleApplication */ 'name'?: string; } /** * * @export * @interface RoleMiningPotentialRoleEditEntitlements */ export interface RoleMiningPotentialRoleEditEntitlements { /** * The list of entitlement ids to be edited * @type {Array} * @memberof RoleMiningPotentialRoleEditEntitlements */ 'ids'?: Array; /** * If true, add ids to be exclusion list. If false, remove ids from the exclusion list. * @type {boolean} * @memberof RoleMiningPotentialRoleEditEntitlements */ 'exclude'?: boolean; } /** * * @export * @interface RoleMiningPotentialRoleEntitlements */ export interface RoleMiningPotentialRoleEntitlements { /** * Id of the entitlement * @type {string} * @memberof RoleMiningPotentialRoleEntitlements */ 'id'?: string; /** * Name of the entitlement * @type {string} * @memberof RoleMiningPotentialRoleEntitlements */ 'name'?: string; } /** * * @export * @interface RoleMiningPotentialRoleExportRequest */ export interface RoleMiningPotentialRoleExportRequest { /** * The minimum popularity among identities in the role which an entitlement must have to be included in the report * @type {number} * @memberof RoleMiningPotentialRoleExportRequest */ 'minEntitlementPopularity'?: number; /** * If false, do not include entitlements that are highly popular among the entire orginization * @type {boolean} * @memberof RoleMiningPotentialRoleExportRequest */ 'includeCommonAccess'?: boolean; } /** * * @export * @interface RoleMiningPotentialRoleExportResponse */ export interface RoleMiningPotentialRoleExportResponse { /** * The minimum popularity among identities in the role which an entitlement must have to be included in the report * @type {number} * @memberof RoleMiningPotentialRoleExportResponse */ 'minEntitlementPopularity'?: number; /** * If false, do not include entitlements that are highly popular among the entire orginization * @type {boolean} * @memberof RoleMiningPotentialRoleExportResponse */ 'includeCommonAccess'?: boolean; /** * ID used to reference this export * @type {string} * @memberof RoleMiningPotentialRoleExportResponse */ 'exportId'?: string; /** * * @type {RoleMiningPotentialRoleExportState} * @memberof RoleMiningPotentialRoleExportResponse */ 'status'?: RoleMiningPotentialRoleExportState; } /** * * @export * @enum {string} */ export declare const RoleMiningPotentialRoleExportState: { readonly Queued: "QUEUED"; readonly InProgress: "IN_PROGRESS"; readonly Success: "SUCCESS"; readonly Error: "ERROR"; }; export type RoleMiningPotentialRoleExportState = typeof RoleMiningPotentialRoleExportState[keyof typeof RoleMiningPotentialRoleExportState]; /** * The potential role reference * @export * @interface RoleMiningPotentialRolePotentialRoleRef */ export interface RoleMiningPotentialRolePotentialRoleRef { /** * Id of the potential role * @type {string} * @memberof RoleMiningPotentialRolePotentialRoleRef */ 'id'?: string; /** * Name of the potential role * @type {string} * @memberof RoleMiningPotentialRolePotentialRoleRef */ 'name'?: string; } /** * * @export * @interface RoleMiningPotentialRoleProvisionRequest */ export interface RoleMiningPotentialRoleProvisionRequest { /** * Name of the new role being created * @type {string} * @memberof RoleMiningPotentialRoleProvisionRequest */ 'roleName'?: string; /** * Short description of the new role being created * @type {string} * @memberof RoleMiningPotentialRoleProvisionRequest */ 'roleDescription'?: string; /** * ID of the identity that will own this role * @type {string} * @memberof RoleMiningPotentialRoleProvisionRequest */ 'ownerId'?: string; /** * When true, create access requests for the identities associated with the potential role * @type {boolean} * @memberof RoleMiningPotentialRoleProvisionRequest */ 'includeIdentities'?: boolean; /** * When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements * @type {boolean} * @memberof RoleMiningPotentialRoleProvisionRequest */ 'directlyAssignedEntitlements'?: boolean; } /** * Provision state * @export * @enum {string} */ export declare const RoleMiningPotentialRoleProvisionState: { readonly Potential: "POTENTIAL"; readonly Pending: "PENDING"; readonly Complete: "COMPLETE"; readonly Failed: "FAILED"; }; export type RoleMiningPotentialRoleProvisionState = typeof RoleMiningPotentialRoleProvisionState[keyof typeof RoleMiningPotentialRoleProvisionState]; /** * * @export * @interface RoleMiningPotentialRoleRef */ export interface RoleMiningPotentialRoleRef { /** * Id of the potential role * @type {string} * @memberof RoleMiningPotentialRoleRef */ 'id'?: string; /** * Name of the potential role * @type {string} * @memberof RoleMiningPotentialRoleRef */ 'name'?: string; } /** * * @export * @interface RoleMiningPotentialRoleSourceUsage */ export interface RoleMiningPotentialRoleSourceUsage { /** * The identity ID * @type {string} * @memberof RoleMiningPotentialRoleSourceUsage */ 'id'?: string; /** * Display name for the identity * @type {string} * @memberof RoleMiningPotentialRoleSourceUsage */ 'displayName'?: string; /** * Email address for the identity * @type {string} * @memberof RoleMiningPotentialRoleSourceUsage */ 'email'?: string; /** * The number of days there has been usage of the source by the identity. * @type {number} * @memberof RoleMiningPotentialRoleSourceUsage */ 'usageCount'?: number; } /** * * @export * @interface RoleMiningPotentialRoleSummary */ export interface RoleMiningPotentialRoleSummary { /** * Id of the potential role * @type {string} * @memberof RoleMiningPotentialRoleSummary */ 'id'?: string; /** * Name of the potential role * @type {string} * @memberof RoleMiningPotentialRoleSummary */ 'name'?: string; /** * * @type {RoleMiningPotentialRoleRef} * @memberof RoleMiningPotentialRoleSummary */ 'potentialRoleRef'?: RoleMiningPotentialRoleRef; /** * The number of identities in a potential role. * @type {number} * @memberof RoleMiningPotentialRoleSummary */ 'identityCount'?: number; /** * The number of entitlements in a potential role. * @type {number} * @memberof RoleMiningPotentialRoleSummary */ 'entitlementCount'?: number; /** * The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" * @type {string} * @memberof RoleMiningPotentialRoleSummary */ 'identityGroupStatus'?: string; /** * * @type {RoleMiningPotentialRoleProvisionState} * @memberof RoleMiningPotentialRoleSummary */ 'provisionState'?: RoleMiningPotentialRoleProvisionState; /** * ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. * @type {string} * @memberof RoleMiningPotentialRoleSummary */ 'roleId'?: string | null; /** * The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. * @type {number} * @memberof RoleMiningPotentialRoleSummary */ 'density'?: number; /** * The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. * @type {number} * @memberof RoleMiningPotentialRoleSummary */ 'freshness'?: number; /** * The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. * @type {number} * @memberof RoleMiningPotentialRoleSummary */ 'quality'?: number; /** * * @type {RoleMiningRoleType} * @memberof RoleMiningPotentialRoleSummary */ 'type'?: RoleMiningRoleType; /** * * @type {RoleMiningPotentialRoleSummaryCreatedBy} * @memberof RoleMiningPotentialRoleSummary */ 'createdBy'?: RoleMiningPotentialRoleSummaryCreatedBy; /** * The date-time when this potential role was created. * @type {string} * @memberof RoleMiningPotentialRoleSummary */ 'createdDate'?: string; /** * The potential role\'s saved status * @type {boolean} * @memberof RoleMiningPotentialRoleSummary */ 'saved'?: boolean; /** * Description of the potential role * @type {string} * @memberof RoleMiningPotentialRoleSummary */ 'description'?: string | null; /** * * @type {RoleMiningSessionParametersDto} * @memberof RoleMiningPotentialRoleSummary */ 'session'?: RoleMiningSessionParametersDto; } /** * @type RoleMiningPotentialRoleSummaryCreatedBy * The potential role created by details * @export */ export type RoleMiningPotentialRoleSummaryCreatedBy = EntityCreatedByDTO | string; /** * Role type * @export * @enum {string} */ export declare const RoleMiningRoleType: { readonly Specialized: "SPECIALIZED"; readonly Common: "COMMON"; }; export type RoleMiningRoleType = typeof RoleMiningRoleType[keyof typeof RoleMiningRoleType]; /** * * @export * @interface RoleMiningSessionDraftRoleDto */ export interface RoleMiningSessionDraftRoleDto { /** * Name of the draft role * @type {string} * @memberof RoleMiningSessionDraftRoleDto */ 'name'?: string; /** * Draft role description * @type {string} * @memberof RoleMiningSessionDraftRoleDto */ 'description'?: string; /** * The list of identities for this role mining session. * @type {Array} * @memberof RoleMiningSessionDraftRoleDto */ 'identityIds'?: Array; /** * The list of entitlement ids for this role mining session. * @type {Array} * @memberof RoleMiningSessionDraftRoleDto */ 'entitlementIds'?: Array; /** * The list of excluded entitlement ids. * @type {Array} * @memberof RoleMiningSessionDraftRoleDto */ 'excludedEntitlements'?: Array; /** * Last modified date * @type {string} * @memberof RoleMiningSessionDraftRoleDto */ 'modified'?: string; /** * * @type {RoleMiningRoleType} * @memberof RoleMiningSessionDraftRoleDto */ 'type'?: RoleMiningRoleType; /** * Id of the potential draft role * @type {string} * @memberof RoleMiningSessionDraftRoleDto */ 'id'?: string; /** * The date-time when this potential draft role was created. * @type {string} * @memberof RoleMiningSessionDraftRoleDto */ 'createdDate'?: string; /** * The date-time when this potential draft role was modified. * @type {string} * @memberof RoleMiningSessionDraftRoleDto */ 'modifiedDate'?: string; } /** * * @export * @interface RoleMiningSessionDto */ export interface RoleMiningSessionDto { /** * * @type {RoleMiningSessionScope} * @memberof RoleMiningSessionDto */ 'scope'?: RoleMiningSessionScope; /** * The prune threshold to be used or null to calculate prescribedPruneThreshold * @type {number} * @memberof RoleMiningSessionDto */ 'pruneThreshold'?: number | null; /** * The calculated prescribedPruneThreshold * @type {number} * @memberof RoleMiningSessionDto */ 'prescribedPruneThreshold'?: number | null; /** * Minimum number of identities in a potential role * @type {number} * @memberof RoleMiningSessionDto */ 'minNumIdentitiesInPotentialRole'?: number | null; /** * Number of potential roles * @type {number} * @memberof RoleMiningSessionDto */ 'potentialRoleCount'?: number; /** * Number of potential roles ready * @type {number} * @memberof RoleMiningSessionDto */ 'potentialRolesReadyCount'?: number; /** * * @type {RoleMiningRoleType} * @memberof RoleMiningSessionDto */ 'type'?: RoleMiningRoleType; /** * The id of the user who will receive an email about the role mining session * @type {string} * @memberof RoleMiningSessionDto */ 'emailRecipientId'?: string | null; /** * Number of identities in the population which meet the search criteria or identity list provided * @type {number} * @memberof RoleMiningSessionDto */ 'identityCount'?: number; /** * The session\'s saved status * @type {boolean} * @memberof RoleMiningSessionDto */ 'saved'?: boolean; /** * The session\'s saved name * @type {string} * @memberof RoleMiningSessionDto */ 'name'?: string | null; } /** * * @export * @interface RoleMiningSessionParametersDto */ export interface RoleMiningSessionParametersDto { /** * The ID of the role mining session * @type {string} * @memberof RoleMiningSessionParametersDto */ 'id'?: string; /** * The session\'s saved name * @type {string} * @memberof RoleMiningSessionParametersDto */ 'name'?: string | null; /** * Minimum number of identities in a potential role * @type {number} * @memberof RoleMiningSessionParametersDto */ 'minNumIdentitiesInPotentialRole'?: number | null; /** * The prune threshold to be used or null to calculate prescribedPruneThreshold * @type {number} * @memberof RoleMiningSessionParametersDto */ 'pruneThreshold'?: number | null; /** * The session\'s saved status * @type {boolean} * @memberof RoleMiningSessionParametersDto */ 'saved'?: boolean; /** * * @type {RoleMiningSessionScope} * @memberof RoleMiningSessionParametersDto */ 'scope'?: RoleMiningSessionScope; /** * * @type {RoleMiningRoleType} * @memberof RoleMiningSessionParametersDto */ 'type'?: RoleMiningRoleType; /** * * @type {RoleMiningSessionState} * @memberof RoleMiningSessionParametersDto */ 'state'?: RoleMiningSessionState; /** * * @type {RoleMiningSessionScopingMethod} * @memberof RoleMiningSessionParametersDto */ 'scopingMethod'?: RoleMiningSessionScopingMethod; } /** * * @export * @interface RoleMiningSessionResponse */ export interface RoleMiningSessionResponse { /** * * @type {RoleMiningSessionScope} * @memberof RoleMiningSessionResponse */ 'scope'?: RoleMiningSessionScope; /** * Minimum number of identities in a potential role * @type {number} * @memberof RoleMiningSessionResponse */ 'minNumIdentitiesInPotentialRole'?: number | null; /** * The scoping method of the role mining session * @type {string} * @memberof RoleMiningSessionResponse */ 'scopingMethod'?: string | null; /** * The computed (or prescribed) prune threshold for this session * @type {number} * @memberof RoleMiningSessionResponse */ 'prescribedPruneThreshold'?: number | null; /** * The prune threshold to be used for this role mining session * @type {number} * @memberof RoleMiningSessionResponse */ 'pruneThreshold'?: number | null; /** * The number of potential roles * @type {number} * @memberof RoleMiningSessionResponse */ 'potentialRoleCount'?: number; /** * The number of potential roles which have completed processing * @type {number} * @memberof RoleMiningSessionResponse */ 'potentialRolesReadyCount'?: number; /** * * @type {RoleMiningSessionStatus} * @memberof RoleMiningSessionResponse */ 'status'?: RoleMiningSessionStatus; /** * The id of the user who will receive an email about the role mining session * @type {string} * @memberof RoleMiningSessionResponse */ 'emailRecipientId'?: string | null; /** * * @type {RoleMiningSessionResponseCreatedBy} * @memberof RoleMiningSessionResponse */ 'createdBy'?: RoleMiningSessionResponseCreatedBy; /** * The number of identities * @type {number} * @memberof RoleMiningSessionResponse */ 'identityCount'?: number; /** * The session\'s saved status * @type {boolean} * @memberof RoleMiningSessionResponse */ 'saved'?: boolean; /** * The session\'s saved name * @type {string} * @memberof RoleMiningSessionResponse */ 'name'?: string | null; /** * The data file path of the role mining session * @type {string} * @memberof RoleMiningSessionResponse */ 'dataFilePath'?: string | null; /** * Session Id for this role mining session * @type {string} * @memberof RoleMiningSessionResponse */ 'id'?: string; /** * The date-time when this role mining session was created. * @type {string} * @memberof RoleMiningSessionResponse */ 'createdDate'?: string; /** * The date-time when this role mining session was completed. * @type {string} * @memberof RoleMiningSessionResponse */ 'modifiedDate'?: string; /** * * @type {RoleMiningRoleType} * @memberof RoleMiningSessionResponse */ 'type'?: RoleMiningRoleType; } /** * @type RoleMiningSessionResponseCreatedBy * The session created by details * @export */ export type RoleMiningSessionResponseCreatedBy = EntityCreatedByDTO | string; /** * * @export * @interface RoleMiningSessionScope */ export interface RoleMiningSessionScope { /** * The list of identities for this role mining session. * @type {Array} * @memberof RoleMiningSessionScope */ 'identityIds'?: Array; /** * The \"search\" criteria that produces the list of identities for this role mining session. * @type {string} * @memberof RoleMiningSessionScope */ 'criteria'?: string | null; /** * The filter criteria for this role mining session. * @type {Array} * @memberof RoleMiningSessionScope */ 'attributeFilterCriteria'?: Array | null; } /** * The scoping method used in the current role mining session. * @export * @enum {string} */ export declare const RoleMiningSessionScopingMethod: { readonly Manual: "MANUAL"; readonly AutoRm: "AUTO_RM"; }; export type RoleMiningSessionScopingMethod = typeof RoleMiningSessionScopingMethod[keyof typeof RoleMiningSessionScopingMethod]; /** * Role mining session status * @export * @enum {string} */ export declare const RoleMiningSessionState: { readonly Created: "CREATED"; readonly Updated: "UPDATED"; readonly IdentitiesObtained: "IDENTITIES_OBTAINED"; readonly PruneThresholdObtained: "PRUNE_THRESHOLD_OBTAINED"; readonly PotentialRolesProcessing: "POTENTIAL_ROLES_PROCESSING"; readonly PotentialRolesCreated: "POTENTIAL_ROLES_CREATED"; }; export type RoleMiningSessionState = typeof RoleMiningSessionState[keyof typeof RoleMiningSessionState]; /** * * @export * @interface RoleMiningSessionStatus */ export interface RoleMiningSessionStatus { /** * * @type {RoleMiningSessionState} * @memberof RoleMiningSessionStatus */ 'state'?: RoleMiningSessionState; } /** * IAIRoleMiningApi - axios parameter creator * @export */ export declare const IAIRoleMiningApiAxiosParamCreator: (configuration?: Configuration) => { /** * This method starts a job to provision a potential role * @summary Create request to provision a potential role into an actual role. * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {RoleMiningPotentialRoleProvisionRequest} [roleMiningPotentialRoleProvisionRequest] Required information to create a new role * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPotentialRoleProvisionRequestV1: (sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequest?: RoleMiningPotentialRoleProvisionRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This submits a create role mining session request to the role mining application. * @summary Create a role mining session * @param {RoleMiningSessionDto} roleMiningSessionDto Role mining session parameters * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRoleMiningSessionsV1: (roleMiningSessionDto: RoleMiningSessionDto, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint downloads a completed export of information for a potential role in a role mining session. * @summary Export (download) details for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} exportId The id of a previously run export job for this potential role * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ downloadRoleMiningPotentialRoleZipV1: (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {RoleMiningPotentialRoleExportRequest} [roleMiningPotentialRoleExportRequest] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleAsyncV1: (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequest?: RoleMiningPotentialRoleExportRequest, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint retrieves information about the current status of a potential role export. * @summary Retrieve status of a potential role export job * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} exportId The id of a previously run export job for this potential role * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleStatusV1: (sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. * @summary Export (download) details for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleV1: (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns all potential role summaries that match the query parameters * @summary Retrieves all potential role summaries * @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: **createdDate, identityCount, entitlementCount, freshness, quality** * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAllPotentialRoleSummariesV1: (sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns entitlement popularity distribution for a potential role in a role mining session. * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementDistributionPotentialRoleV1: (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns entitlements for a potential role in a role mining session. * @summary Retrieves entitlements for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementsPotentialRoleV1: (sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns excluded entitlements for a potential role in a role mining session. * @summary Retrieves excluded entitlements for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **popularity** * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getExcludedEntitlementsPotentialRoleV1: (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns identities for a potential role in a role mining session. * @summary Retrieves identities for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **name** * @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: **name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitiesPotentialRoleV1: (sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns the applications of a potential role for a role mining session. * @summary Retrieves the applications of a potential role for a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **applicationName**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleApplicationsV1: (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns the entitlements of a potential role for a role mining session. * @summary Retrieves the entitlements of a potential role for a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **entitlementRef.name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleEntitlementsV1: (sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. * @summary Retrieves potential role source usage * @param {string} potentialRoleId A potential role id * @param {string} sourceId A source id * @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 is supported for the following fields: **displayName, email, usageCount** * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleSourceIdentityUsageV1: (potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns the potential role summaries for a role mining session. * @summary Retrieves all potential role summaries * @param {string} sessionId The role mining session id * @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: **createdDate** * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleSummariesV1: (sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns a specific potential role for a role mining session. * @summary Retrieves a specific potential role * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleV1: (sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns a specific potential role. * @summary Retrieves a specific potential role * @param {string} potentialRoleId A potential role id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningPotentialRoleV1: (potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns a role mining session status for a customer. * @summary Get role mining session status state * @param {string} sessionId The role mining session id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionStatusV1: (sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * The method retrieves a role mining session. * @summary Get a role mining session * @param {string} sessionId The role mining session id to be retrieved. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionV1: (sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns all role mining sessions that match the query parameters * @summary Retrieves all role mining sessions * @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: **saved**: *eq* **name**: *eq, sw* * @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: **createdBy, createdDate** * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionsV1: (filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This method returns all saved potential roles (draft roles). * @summary Retrieves all saved potential roles * @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 is supported for the following fields: **modified** * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSavedPotentialRolesV1: (sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId The potential role summary id * @param {Array} jsonPatchOperationRoleMining * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchPotentialRoleSessionV1: (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMining: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role * @param {string} sessionId The role mining session id * @param {string} potentialRoleId The potential role summary id * @param {Array} jsonPatchOperationRoleMining * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchPotentialRoleV1: (sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMining: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. * @summary Patch a role mining session * @param {string} sessionId The role mining session id to be patched * @param {Array} jsonPatchOperation Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleMiningSessionV1: (sessionId: string, jsonPatchOperation: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint adds or removes entitlements from an exclusion list for a potential role. * @summary Edit entitlements for a potential role to exclude some entitlements * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {RoleMiningPotentialRoleEditEntitlements} roleMiningPotentialRoleEditEntitlements Role mining session parameters * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateEntitlementsPotentialRoleV1: (sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlements: RoleMiningPotentialRoleEditEntitlements, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * IAIRoleMiningApi - functional programming interface * @export */ export declare const IAIRoleMiningApiFp: (configuration?: Configuration) => { /** * This method starts a job to provision a potential role * @summary Create request to provision a potential role into an actual role. * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {number} [minEntitlementPopularity] Minimum popularity required for an entitlement to be included in the provisioned role. * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included in the provisioned role. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {RoleMiningPotentialRoleProvisionRequest} [roleMiningPotentialRoleProvisionRequest] Required information to create a new role * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPotentialRoleProvisionRequestV1(sessionId: string, potentialRoleId: string, minEntitlementPopularity?: number, includeCommonAccess?: boolean, xSailPointExperimental?: string, roleMiningPotentialRoleProvisionRequest?: RoleMiningPotentialRoleProvisionRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This submits a create role mining session request to the role mining application. * @summary Create a role mining session * @param {RoleMiningSessionDto} roleMiningSessionDto Role mining session parameters * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRoleMiningSessionsV1(roleMiningSessionDto: RoleMiningSessionDto, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint downloads a completed export of information for a potential role in a role mining session. * @summary Export (download) details for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} exportId The id of a previously run export job for this potential role * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ downloadRoleMiningPotentialRoleZipV1(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {RoleMiningPotentialRoleExportRequest} [roleMiningPotentialRoleExportRequest] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleAsyncV1(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, roleMiningPotentialRoleExportRequest?: RoleMiningPotentialRoleExportRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint retrieves information about the current status of a potential role export. * @summary Retrieve status of a potential role export job * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} exportId The id of a previously run export job for this potential role * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleStatusV1(sessionId: string, potentialRoleId: string, exportId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. * @summary Export (download) details for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleV1(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all potential role summaries that match the query parameters * @summary Retrieves all potential role summaries * @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: **createdDate, identityCount, entitlementCount, freshness, quality** * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAllPotentialRoleSummariesV1(sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns entitlement popularity distribution for a potential role in a role mining session. * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementDistributionPotentialRoleV1(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: number; }>>; /** * This method returns entitlements for a potential role in a role mining session. * @summary Retrieves entitlements for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {boolean} [includeCommonAccess] Boolean determining whether common access entitlements will be included or not * @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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementsPotentialRoleV1(sessionId: string, potentialRoleId: string, includeCommonAccess?: boolean, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns excluded entitlements for a potential role in a role mining session. * @summary Retrieves excluded entitlements for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **popularity** * @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: **applicationName**: *sw* **entitlementRef.name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getExcludedEntitlementsPotentialRoleV1(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns identities for a potential role in a role mining session. * @summary Retrieves identities for a potential role in a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **name** * @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: **name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitiesPotentialRoleV1(sessionId: string, potentialRoleId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns the applications of a potential role for a role mining session. * @summary Retrieves the applications of a potential role for a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **applicationName**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleApplicationsV1(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns the entitlements of a potential role for a role mining session. * @summary Retrieves the entitlements of a potential role for a role mining session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @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: **entitlementRef.name**: *sw* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleEntitlementsV1(sessionId: string, potentialRoleId: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. * @summary Retrieves potential role source usage * @param {string} potentialRoleId A potential role id * @param {string} sourceId A source id * @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 is supported for the following fields: **displayName, email, usageCount** * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleSourceIdentityUsageV1(potentialRoleId: string, sourceId: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns the potential role summaries for a role mining session. * @summary Retrieves all potential role summaries * @param {string} sessionId The role mining session id * @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: **createdDate** * @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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleSummariesV1(sessionId: string, sorters?: string, filters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns a specific potential role for a role mining session. * @summary Retrieves a specific potential role * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleV1(sessionId: string, potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method returns a specific potential role. * @summary Retrieves a specific potential role * @param {string} potentialRoleId A potential role id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningPotentialRoleV1(potentialRoleId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This method returns a role mining session status for a customer. * @summary Get role mining session status state * @param {string} sessionId The role mining session id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionStatusV1(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The method retrieves a role mining session. * @summary Get a role mining session * @param {string} sessionId The role mining session id to be retrieved. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionV1(sessionId: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns all role mining sessions that match the query parameters * @summary Retrieves all role mining sessions * @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: **saved**: *eq* **name**: *eq, sw* * @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: **createdBy, createdDate** * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionsV1(filters?: string, sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * This method returns all saved potential roles (draft roles). * @summary Retrieves all saved potential roles * @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 is supported for the following fields: **modified** * @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 {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 {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} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSavedPotentialRolesV1(sorters?: string, offset?: number, limit?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role session * @param {string} sessionId The role mining session id * @param {string} potentialRoleId The potential role summary id * @param {Array} jsonPatchOperationRoleMining * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchPotentialRoleSessionV1(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMining: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role * @param {string} sessionId The role mining session id * @param {string} potentialRoleId The potential role summary id * @param {Array} jsonPatchOperationRoleMining * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchPotentialRoleV1(sessionId: string, potentialRoleId: string, jsonPatchOperationRoleMining: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. * @summary Patch a role mining session * @param {string} sessionId The role mining session id to be patched * @param {Array} jsonPatchOperation Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleMiningSessionV1(sessionId: string, jsonPatchOperation: Array, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint adds or removes entitlements from an exclusion list for a potential role. * @summary Edit entitlements for a potential role to exclude some entitlements * @param {string} sessionId The role mining session id * @param {string} potentialRoleId A potential role id in a role mining session * @param {RoleMiningPotentialRoleEditEntitlements} roleMiningPotentialRoleEditEntitlements Role mining session parameters * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateEntitlementsPotentialRoleV1(sessionId: string, potentialRoleId: string, roleMiningPotentialRoleEditEntitlements: RoleMiningPotentialRoleEditEntitlements, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IAIRoleMiningApi - factory interface * @export */ export declare const IAIRoleMiningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This method starts a job to provision a potential role * @summary Create request to provision a potential role into an actual role. * @param {IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPotentialRoleProvisionRequestV1(requestParameters: IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This submits a create role mining session request to the role mining application. * @summary Create a role mining session * @param {IAIRoleMiningApiCreateRoleMiningSessionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRoleMiningSessionsV1(requestParameters: IAIRoleMiningApiCreateRoleMiningSessionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint downloads a completed export of information for a potential role in a role mining session. * @summary Export (download) details for a potential role in a role mining session * @param {IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ downloadRoleMiningPotentialRoleZipV1(requestParameters: IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 * @param {IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleAsyncV1(requestParameters: IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint retrieves information about the current status of a potential role export. * @summary Retrieve status of a potential role export job * @param {IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleStatusV1(requestParameters: IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. * @summary Export (download) details for a potential role in a role mining session * @param {IAIRoleMiningApiExportRoleMiningPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningApiExportRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all potential role summaries that match the query parameters * @summary Retrieves all potential role summaries * @param {IAIRoleMiningApiGetAllPotentialRoleSummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAllPotentialRoleSummariesV1(requestParameters?: IAIRoleMiningApiGetAllPotentialRoleSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns entitlement popularity distribution for a potential role in a role mining session. * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session * @param {IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementDistributionPotentialRoleV1(requestParameters: IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }>; /** * This method returns entitlements for a potential role in a role mining session. * @summary Retrieves entitlements for a potential role in a role mining session * @param {IAIRoleMiningApiGetEntitlementsPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningApiGetEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns excluded entitlements for a potential role in a role mining session. * @summary Retrieves excluded entitlements for a potential role in a role mining session * @param {IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getExcludedEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns identities for a potential role in a role mining session. * @summary Retrieves identities for a potential role in a role mining session * @param {IAIRoleMiningApiGetIdentitiesPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitiesPotentialRoleV1(requestParameters: IAIRoleMiningApiGetIdentitiesPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns the applications of a potential role for a role mining session. * @summary Retrieves the applications of a potential role for a role mining session * @param {IAIRoleMiningApiGetPotentialRoleApplicationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleApplicationsV1(requestParameters: IAIRoleMiningApiGetPotentialRoleApplicationsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns the entitlements of a potential role for a role mining session. * @summary Retrieves the entitlements of a potential role for a role mining session * @param {IAIRoleMiningApiGetPotentialRoleEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleEntitlementsV1(requestParameters: IAIRoleMiningApiGetPotentialRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. * @summary Retrieves potential role source usage * @param {IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleSourceIdentityUsageV1(requestParameters: IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns the potential role summaries for a role mining session. * @summary Retrieves all potential role summaries * @param {IAIRoleMiningApiGetPotentialRoleSummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleSummariesV1(requestParameters: IAIRoleMiningApiGetPotentialRoleSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns a specific potential role for a role mining session. * @summary Retrieves a specific potential role * @param {IAIRoleMiningApiGetPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPotentialRoleV1(requestParameters: IAIRoleMiningApiGetPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This method returns a specific potential role. * @summary Retrieves a specific potential role * @param {IAIRoleMiningApiGetRoleMiningPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningApiGetRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This method returns a role mining session status for a customer. * @summary Get role mining session status state * @param {IAIRoleMiningApiGetRoleMiningSessionStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionStatusV1(requestParameters: IAIRoleMiningApiGetRoleMiningSessionStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * The method retrieves a role mining session. * @summary Get a role mining session * @param {IAIRoleMiningApiGetRoleMiningSessionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionV1(requestParameters: IAIRoleMiningApiGetRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns all role mining sessions that match the query parameters * @summary Retrieves all role mining sessions * @param {IAIRoleMiningApiGetRoleMiningSessionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleMiningSessionsV1(requestParameters?: IAIRoleMiningApiGetRoleMiningSessionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * This method returns all saved potential roles (draft roles). * @summary Retrieves all saved potential roles * @param {IAIRoleMiningApiGetSavedPotentialRolesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSavedPotentialRolesV1(requestParameters?: IAIRoleMiningApiGetSavedPotentialRolesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise>; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role session * @param {IAIRoleMiningApiPatchPotentialRoleSessionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchPotentialRoleSessionV1(requestParameters: IAIRoleMiningApiPatchPotentialRoleSessionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role * @param {IAIRoleMiningApiPatchPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchPotentialRoleV1(requestParameters: IAIRoleMiningApiPatchPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. * @summary Patch a role mining session * @param {IAIRoleMiningApiPatchRoleMiningSessionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleMiningSessionV1(requestParameters: IAIRoleMiningApiPatchRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint adds or removes entitlements from an exclusion list for a potential role. * @summary Edit entitlements for a potential role to exclude some entitlements * @param {IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createPotentialRoleProvisionRequestV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1Request */ export interface IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1 */ readonly potentialRoleId: string; /** * Minimum popularity required for an entitlement to be included in the provisioned role. * @type {number} * @memberof IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1 */ readonly minEntitlementPopularity?: number; /** * Boolean determining whether common access entitlements will be included in the provisioned role. * @type {boolean} * @memberof IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1 */ readonly includeCommonAccess?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1 */ readonly xSailPointExperimental?: string; /** * Required information to create a new role * @type {RoleMiningPotentialRoleProvisionRequest} * @memberof IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1 */ readonly roleMiningPotentialRoleProvisionRequest?: RoleMiningPotentialRoleProvisionRequest; } /** * Request parameters for createRoleMiningSessionsV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiCreateRoleMiningSessionsV1Request */ export interface IAIRoleMiningApiCreateRoleMiningSessionsV1Request { /** * Role mining session parameters * @type {RoleMiningSessionDto} * @memberof IAIRoleMiningApiCreateRoleMiningSessionsV1 */ readonly roleMiningSessionDto: RoleMiningSessionDto; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiCreateRoleMiningSessionsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for downloadRoleMiningPotentialRoleZipV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1Request */ export interface IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1 */ readonly potentialRoleId: string; /** * The id of a previously run export job for this potential role * @type {string} * @memberof IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1 */ readonly exportId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for exportRoleMiningPotentialRoleAsyncV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1Request */ export interface IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1 */ readonly potentialRoleId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1 */ readonly xSailPointExperimental?: string; /** * * @type {RoleMiningPotentialRoleExportRequest} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1 */ readonly roleMiningPotentialRoleExportRequest?: RoleMiningPotentialRoleExportRequest; } /** * Request parameters for exportRoleMiningPotentialRoleStatusV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1Request */ export interface IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1 */ readonly potentialRoleId: string; /** * The id of a previously run export job for this potential role * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1 */ readonly exportId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for exportRoleMiningPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiExportRoleMiningPotentialRoleV1Request */ export interface IAIRoleMiningApiExportRoleMiningPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleV1 */ readonly potentialRoleId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiExportRoleMiningPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getAllPotentialRoleSummariesV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetAllPotentialRoleSummariesV1Request */ export interface IAIRoleMiningApiGetAllPotentialRoleSummariesV1Request { /** * 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: **createdDate, identityCount, entitlementCount, freshness, quality** * @type {string} * @memberof IAIRoleMiningApiGetAllPotentialRoleSummariesV1 */ readonly sorters?: string; /** * 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* * @type {string} * @memberof IAIRoleMiningApiGetAllPotentialRoleSummariesV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetAllPotentialRoleSummariesV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetAllPotentialRoleSummariesV1 */ readonly limit?: 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 IAIRoleMiningApiGetAllPotentialRoleSummariesV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetAllPotentialRoleSummariesV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getEntitlementDistributionPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1Request */ export interface IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1 */ readonly potentialRoleId: string; /** * Boolean determining whether common access entitlements will be included or not * @type {boolean} * @memberof IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1 */ readonly includeCommonAccess?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getEntitlementsPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetEntitlementsPotentialRoleV1Request */ export interface IAIRoleMiningApiGetEntitlementsPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly potentialRoleId: string; /** * Boolean determining whether common access entitlements will be included or not * @type {boolean} * @memberof IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly includeCommonAccess?: boolean; /** * 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: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. * @type {string} * @memberof IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly sorters?: string; /** * 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: **applicationName**: *sw* **entitlementRef.name**: *sw* * @type {string} * @memberof IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly limit?: 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 IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetEntitlementsPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getExcludedEntitlementsPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1Request */ export interface IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly potentialRoleId: 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: **popularity** * @type {string} * @memberof IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly sorters?: string; /** * 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: **applicationName**: *sw* **entitlementRef.name**: *sw* * @type {string} * @memberof IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly limit?: 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 IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getIdentitiesPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetIdentitiesPotentialRoleV1Request */ export interface IAIRoleMiningApiGetIdentitiesPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly potentialRoleId: 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: **name** * @type {string} * @memberof IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly sorters?: string; /** * 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: **name**: *sw* * @type {string} * @memberof IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly limit?: 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 IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetIdentitiesPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getPotentialRoleApplicationsV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetPotentialRoleApplicationsV1Request */ export interface IAIRoleMiningApiGetPotentialRoleApplicationsV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly potentialRoleId: string; /** * 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: **applicationName**: *sw* * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly limit?: 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 IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleApplicationsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getPotentialRoleEntitlementsV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetPotentialRoleEntitlementsV1Request */ export interface IAIRoleMiningApiGetPotentialRoleEntitlementsV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly potentialRoleId: string; /** * 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: **entitlementRef.name**: *sw* * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly limit?: 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 IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleEntitlementsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getPotentialRoleSourceIdentityUsageV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1Request */ export interface IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1Request { /** * A potential role id * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly potentialRoleId: string; /** * A source id * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly sourceId: string; /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly sorters?: string; /** * 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 IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly limit?: 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 IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getPotentialRoleSummariesV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetPotentialRoleSummariesV1Request */ export interface IAIRoleMiningApiGetPotentialRoleSummariesV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly sessionId: 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: **createdDate** * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly sorters?: string; /** * 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly filters?: string; /** * 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 IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly limit?: 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 IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleSummariesV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetPotentialRoleV1Request */ export interface IAIRoleMiningApiGetPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleV1 */ readonly potentialRoleId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getRoleMiningPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetRoleMiningPotentialRoleV1Request */ export interface IAIRoleMiningApiGetRoleMiningPotentialRoleV1Request { /** * A potential role id * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningPotentialRoleV1 */ readonly potentialRoleId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getRoleMiningSessionStatusV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetRoleMiningSessionStatusV1Request */ export interface IAIRoleMiningApiGetRoleMiningSessionStatusV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionStatusV1 */ readonly sessionId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionStatusV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getRoleMiningSessionV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetRoleMiningSessionV1Request */ export interface IAIRoleMiningApiGetRoleMiningSessionV1Request { /** * The role mining session id to be retrieved. * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionV1 */ readonly sessionId: string; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getRoleMiningSessionsV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetRoleMiningSessionsV1Request */ export interface IAIRoleMiningApiGetRoleMiningSessionsV1Request { /** * 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: **saved**: *eq* **name**: *eq, sw* * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionsV1 */ 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: **createdBy, createdDate** * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionsV1 */ readonly sorters?: string; /** * 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 IAIRoleMiningApiGetRoleMiningSessionsV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetRoleMiningSessionsV1 */ readonly limit?: 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 IAIRoleMiningApiGetRoleMiningSessionsV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetRoleMiningSessionsV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for getSavedPotentialRolesV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiGetSavedPotentialRolesV1Request */ export interface IAIRoleMiningApiGetSavedPotentialRolesV1Request { /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** * @type {string} * @memberof IAIRoleMiningApiGetSavedPotentialRolesV1 */ readonly sorters?: string; /** * 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 IAIRoleMiningApiGetSavedPotentialRolesV1 */ readonly offset?: number; /** * 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 IAIRoleMiningApiGetSavedPotentialRolesV1 */ readonly limit?: 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 IAIRoleMiningApiGetSavedPotentialRolesV1 */ readonly count?: boolean; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiGetSavedPotentialRolesV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for patchPotentialRoleSessionV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiPatchPotentialRoleSessionV1Request */ export interface IAIRoleMiningApiPatchPotentialRoleSessionV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiPatchPotentialRoleSessionV1 */ readonly sessionId: string; /** * The potential role summary id * @type {string} * @memberof IAIRoleMiningApiPatchPotentialRoleSessionV1 */ readonly potentialRoleId: string; /** * * @type {Array} * @memberof IAIRoleMiningApiPatchPotentialRoleSessionV1 */ readonly jsonPatchOperationRoleMining: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiPatchPotentialRoleSessionV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for patchPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiPatchPotentialRoleV1Request */ export interface IAIRoleMiningApiPatchPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiPatchPotentialRoleV1 */ readonly sessionId: string; /** * The potential role summary id * @type {string} * @memberof IAIRoleMiningApiPatchPotentialRoleV1 */ readonly potentialRoleId: string; /** * * @type {Array} * @memberof IAIRoleMiningApiPatchPotentialRoleV1 */ readonly jsonPatchOperationRoleMining: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiPatchPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for patchRoleMiningSessionV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiPatchRoleMiningSessionV1Request */ export interface IAIRoleMiningApiPatchRoleMiningSessionV1Request { /** * The role mining session id to be patched * @type {string} * @memberof IAIRoleMiningApiPatchRoleMiningSessionV1 */ readonly sessionId: string; /** * Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. * @type {Array} * @memberof IAIRoleMiningApiPatchRoleMiningSessionV1 */ readonly jsonPatchOperation: Array; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiPatchRoleMiningSessionV1 */ readonly xSailPointExperimental?: string; } /** * Request parameters for updateEntitlementsPotentialRoleV1 operation in IAIRoleMiningApi. * @export * @interface IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1Request */ export interface IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1Request { /** * The role mining session id * @type {string} * @memberof IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1 */ readonly sessionId: string; /** * A potential role id in a role mining session * @type {string} * @memberof IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1 */ readonly potentialRoleId: string; /** * Role mining session parameters * @type {RoleMiningPotentialRoleEditEntitlements} * @memberof IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1 */ readonly roleMiningPotentialRoleEditEntitlements: RoleMiningPotentialRoleEditEntitlements; /** * Use this header to enable this experimental API. * @type {string} * @memberof IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1 */ readonly xSailPointExperimental?: string; } /** * IAIRoleMiningApi - object-oriented interface * @export * @class IAIRoleMiningApi * @extends {BaseAPI} */ export declare class IAIRoleMiningApi extends BaseAPI { /** * This method starts a job to provision a potential role * @summary Create request to provision a potential role into an actual role. * @param {IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ createPotentialRoleProvisionRequestV1(requestParameters: IAIRoleMiningApiCreatePotentialRoleProvisionRequestV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This submits a create role mining session request to the role mining application. * @summary Create a role mining session * @param {IAIRoleMiningApiCreateRoleMiningSessionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ createRoleMiningSessionsV1(requestParameters: IAIRoleMiningApiCreateRoleMiningSessionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint downloads a completed export of information for a potential role in a role mining session. * @summary Export (download) details for a potential role in a role mining session * @param {IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ downloadRoleMiningPotentialRoleZipV1(requestParameters: IAIRoleMiningApiDownloadRoleMiningPotentialRoleZipV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. * @summary Asynchronously export details for a potential role in a role mining session and upload to S3 * @param {IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ exportRoleMiningPotentialRoleAsyncV1(requestParameters: IAIRoleMiningApiExportRoleMiningPotentialRoleAsyncV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint retrieves information about the current status of a potential role export. * @summary Retrieve status of a potential role export job * @param {IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ exportRoleMiningPotentialRoleStatusV1(requestParameters: IAIRoleMiningApiExportRoleMiningPotentialRoleStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. * @summary Export (download) details for a potential role in a role mining session * @param {IAIRoleMiningApiExportRoleMiningPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ exportRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningApiExportRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns all potential role summaries that match the query parameters * @summary Retrieves all potential role summaries * @param {IAIRoleMiningApiGetAllPotentialRoleSummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getAllPotentialRoleSummariesV1(requestParameters?: IAIRoleMiningApiGetAllPotentialRoleSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns entitlement popularity distribution for a potential role in a role mining session. * @summary Retrieves entitlement popularity distribution for a potential role in a role mining session * @param {IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getEntitlementDistributionPotentialRoleV1(requestParameters: IAIRoleMiningApiGetEntitlementDistributionPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns entitlements for a potential role in a role mining session. * @summary Retrieves entitlements for a potential role in a role mining session * @param {IAIRoleMiningApiGetEntitlementsPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningApiGetEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns excluded entitlements for a potential role in a role mining session. * @summary Retrieves excluded entitlements for a potential role in a role mining session * @param {IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getExcludedEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningApiGetExcludedEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns identities for a potential role in a role mining session. * @summary Retrieves identities for a potential role in a role mining session * @param {IAIRoleMiningApiGetIdentitiesPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getIdentitiesPotentialRoleV1(requestParameters: IAIRoleMiningApiGetIdentitiesPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns the applications of a potential role for a role mining session. * @summary Retrieves the applications of a potential role for a role mining session * @param {IAIRoleMiningApiGetPotentialRoleApplicationsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getPotentialRoleApplicationsV1(requestParameters: IAIRoleMiningApiGetPotentialRoleApplicationsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns the entitlements of a potential role for a role mining session. * @summary Retrieves the entitlements of a potential role for a role mining session * @param {IAIRoleMiningApiGetPotentialRoleEntitlementsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getPotentialRoleEntitlementsV1(requestParameters: IAIRoleMiningApiGetPotentialRoleEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. * @summary Retrieves potential role source usage * @param {IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getPotentialRoleSourceIdentityUsageV1(requestParameters: IAIRoleMiningApiGetPotentialRoleSourceIdentityUsageV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns the potential role summaries for a role mining session. * @summary Retrieves all potential role summaries * @param {IAIRoleMiningApiGetPotentialRoleSummariesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getPotentialRoleSummariesV1(requestParameters: IAIRoleMiningApiGetPotentialRoleSummariesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns a specific potential role for a role mining session. * @summary Retrieves a specific potential role * @param {IAIRoleMiningApiGetPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getPotentialRoleV1(requestParameters: IAIRoleMiningApiGetPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns a specific potential role. * @summary Retrieves a specific potential role * @param {IAIRoleMiningApiGetRoleMiningPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getRoleMiningPotentialRoleV1(requestParameters: IAIRoleMiningApiGetRoleMiningPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns a role mining session status for a customer. * @summary Get role mining session status state * @param {IAIRoleMiningApiGetRoleMiningSessionStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getRoleMiningSessionStatusV1(requestParameters: IAIRoleMiningApiGetRoleMiningSessionStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * The method retrieves a role mining session. * @summary Get a role mining session * @param {IAIRoleMiningApiGetRoleMiningSessionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getRoleMiningSessionV1(requestParameters: IAIRoleMiningApiGetRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns all role mining sessions that match the query parameters * @summary Retrieves all role mining sessions * @param {IAIRoleMiningApiGetRoleMiningSessionsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getRoleMiningSessionsV1(requestParameters?: IAIRoleMiningApiGetRoleMiningSessionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This method returns all saved potential roles (draft roles). * @summary Retrieves all saved potential roles * @param {IAIRoleMiningApiGetSavedPotentialRolesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ getSavedPotentialRolesV1(requestParameters?: IAIRoleMiningApiGetSavedPotentialRolesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role session * @param {IAIRoleMiningApiPatchPotentialRoleSessionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ patchPotentialRoleSessionV1(requestParameters: IAIRoleMiningApiPatchPotentialRoleSessionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * The method updates an existing potential role using. The following fields can be modified: * `description` * `name` * `saved` >**NOTE: All other fields cannot be modified.** * @summary Update a potential role * @param {IAIRoleMiningApiPatchPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ patchPotentialRoleV1(requestParameters: IAIRoleMiningApiPatchPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * The method updates an existing role mining session using PATCH. Supports op in {\"replace\"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. * @summary Patch a role mining session * @param {IAIRoleMiningApiPatchRoleMiningSessionV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ patchRoleMiningSessionV1(requestParameters: IAIRoleMiningApiPatchRoleMiningSessionV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint adds or removes entitlements from an exclusion list for a potential role. * @summary Edit entitlements for a potential role to exclude some entitlements * @param {IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IAIRoleMiningApi */ updateEntitlementsPotentialRoleV1(requestParameters: IAIRoleMiningApiUpdateEntitlementsPotentialRoleV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }