/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Identity History * 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 globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface AccessItemAccessProfileResponse */ export interface AccessItemAccessProfileResponse { /** * the access item id * @type {string} * @memberof AccessItemAccessProfileResponse */ 'id'?: string; /** * the access item type. accessProfile in this case * @type {string} * @memberof AccessItemAccessProfileResponse */ 'accessType'?: string; /** * the display name of the identity * @type {string} * @memberof AccessItemAccessProfileResponse */ 'displayName'?: string; /** * the name of the source * @type {string} * @memberof AccessItemAccessProfileResponse */ 'sourceName'?: string; /** * the number of entitlements the access profile will create * @type {number} * @memberof AccessItemAccessProfileResponse */ 'entitlementCount': number; /** * the description for the access profile * @type {string} * @memberof AccessItemAccessProfileResponse */ 'description'?: string | null; /** * the id of the source * @type {string} * @memberof AccessItemAccessProfileResponse */ 'sourceId'?: string; /** * the list of app ids associated with the access profile * @type {Array} * @memberof AccessItemAccessProfileResponse */ 'appRefs': Array; /** * the date the access profile will be assigned to the specified identity, in case requested with a future start date * @type {string} * @memberof AccessItemAccessProfileResponse */ 'startDate'?: string | null; /** * the date the access profile is no longer assigned to the specified identity * @type {string} * @memberof AccessItemAccessProfileResponse */ 'removeDate'?: string | null; /** * indicates whether the access profile is standalone * @type {boolean} * @memberof AccessItemAccessProfileResponse */ 'standalone': boolean | null; /** * indicates whether the access profile is revocable * @type {boolean} * @memberof AccessItemAccessProfileResponse */ 'revocable': boolean | null; } /** * * @export * @interface AccessItemAccessProfileResponseAppRefsInner */ export interface AccessItemAccessProfileResponseAppRefsInner { /** * the cloud app id associated with the access profile * @type {string} * @memberof AccessItemAccessProfileResponseAppRefsInner */ 'cloudAppId'?: string; /** * the cloud app name associated with the access profile * @type {string} * @memberof AccessItemAccessProfileResponseAppRefsInner */ 'cloudAppName'?: string; } /** * * @export * @interface AccessItemAccountResponse */ export interface AccessItemAccountResponse { /** * the access item id * @type {string} * @memberof AccessItemAccountResponse */ 'id'?: string; /** * the access item type. account in this case * @type {string} * @memberof AccessItemAccountResponse */ 'accessType'?: string; /** * the display name of the identity * @type {string} * @memberof AccessItemAccountResponse */ 'displayName'?: string; /** * the name of the source * @type {string} * @memberof AccessItemAccountResponse */ 'sourceName'?: string; /** * the native identifier used to uniquely identify an acccount * @type {string} * @memberof AccessItemAccountResponse */ 'nativeIdentity': string; /** * the id of the source * @type {string} * @memberof AccessItemAccountResponse */ 'sourceId'?: string; /** * the number of entitlements the account will create * @type {number} * @memberof AccessItemAccountResponse */ 'entitlementCount'?: number; } /** * * @export * @interface AccessItemAppResponse */ export interface AccessItemAppResponse { /** * the access item id * @type {string} * @memberof AccessItemAppResponse */ 'id'?: string; /** * the access item type. entitlement in this case * @type {string} * @memberof AccessItemAppResponse */ 'accessType'?: string; /** * the access item display name * @type {string} * @memberof AccessItemAppResponse */ 'displayName'?: string; /** * the associated source name if it exists * @type {string} * @memberof AccessItemAppResponse */ 'sourceName'?: string | null; /** * the app role id * @type {string} * @memberof AccessItemAppResponse */ 'appRoleId': string | null; } /** * * @export * @interface AccessItemAssociated */ export interface AccessItemAssociated { /** * the event type * @type {string} * @memberof AccessItemAssociated */ 'eventType'?: string; /** * the date of event * @type {string} * @memberof AccessItemAssociated */ 'dateTime'?: string; /** * the identity id * @type {string} * @memberof AccessItemAssociated */ 'identityId'?: string; /** * * @type {AccessItemAssociatedAccessItem} * @memberof AccessItemAssociated */ 'accessItem': AccessItemAssociatedAccessItem; /** * * @type {CorrelatedGovernanceEvent} * @memberof AccessItemAssociated */ 'governanceEvent': CorrelatedGovernanceEvent | null; /** * the access item type * @type {string} * @memberof AccessItemAssociated */ 'accessItemType'?: AccessItemAssociatedAccessItemTypeEnum; } export const AccessItemAssociatedAccessItemTypeEnum = { Account: 'account', App: 'app', Entitlement: 'entitlement', Role: 'role', AccessProfile: 'accessProfile' } as const; export type AccessItemAssociatedAccessItemTypeEnum = typeof AccessItemAssociatedAccessItemTypeEnum[keyof typeof AccessItemAssociatedAccessItemTypeEnum]; /** * * @export * @interface AccessItemAssociatedAccessItem */ export interface AccessItemAssociatedAccessItem { /** * the access item id * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'id'?: string; /** * the access item type. entitlement in this case * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'accessType'?: string; /** * the access item display name * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'displayName'?: string; /** * the associated source name if it exists * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'sourceName'?: string | null; /** * the entitlement attribute * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'attribute': string; /** * the associated value * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'value': string; /** * the type of entitlement * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'type': string; /** * the description for the role * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'description'?: string; /** * the id of the source * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'sourceId'?: string; /** * indicates whether the access profile is standalone * @type {boolean} * @memberof AccessItemAssociatedAccessItem */ 'standalone': boolean | null; /** * indicates whether the entitlement is privileged * @type {boolean} * @memberof AccessItemAssociatedAccessItem */ 'privileged': boolean | null; /** * indicates whether the entitlement is cloud governed * @type {boolean} * @memberof AccessItemAssociatedAccessItem */ 'cloudGoverned': boolean | null; /** * the number of entitlements the account will create * @type {number} * @memberof AccessItemAssociatedAccessItem */ 'entitlementCount': number; /** * the list of app ids associated with the access profile * @type {Array} * @memberof AccessItemAssociatedAccessItem */ 'appRefs': Array; /** * the date the access profile will be assigned to the specified identity, in case requested with a future start date * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'startDate'?: string | null; /** * the date the role is no longer assigned to the specified identity * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'removeDate'?: string; /** * indicates whether the role is revocable * @type {boolean} * @memberof AccessItemAssociatedAccessItem */ 'revocable': boolean; /** * the native identifier used to uniquely identify an acccount * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'nativeIdentity': string; /** * the app role id * @type {string} * @memberof AccessItemAssociatedAccessItem */ 'appRoleId': string | null; } /** * * @export * @interface AccessItemDiff */ export interface AccessItemDiff { /** * the id of the access item * @type {string} * @memberof AccessItemDiff */ 'id'?: string; /** * * @type {string} * @memberof AccessItemDiff */ 'eventType'?: AccessItemDiffEventTypeEnum; /** * the display name of the access item * @type {string} * @memberof AccessItemDiff */ 'displayName'?: string; /** * the source name of the access item * @type {string} * @memberof AccessItemDiff */ 'sourceName'?: string; } export const AccessItemDiffEventTypeEnum = { Add: 'ADD', Remove: 'REMOVE' } as const; export type AccessItemDiffEventTypeEnum = typeof AccessItemDiffEventTypeEnum[keyof typeof AccessItemDiffEventTypeEnum]; /** * * @export * @interface AccessItemEntitlementResponse */ export interface AccessItemEntitlementResponse { /** * the access item id * @type {string} * @memberof AccessItemEntitlementResponse */ 'id'?: string; /** * the access item type. entitlement in this case * @type {string} * @memberof AccessItemEntitlementResponse */ 'accessType'?: string; /** * the display name of the identity * @type {string} * @memberof AccessItemEntitlementResponse */ 'displayName'?: string; /** * the name of the source * @type {string} * @memberof AccessItemEntitlementResponse */ 'sourceName'?: string; /** * the entitlement attribute * @type {string} * @memberof AccessItemEntitlementResponse */ 'attribute': string; /** * the associated value * @type {string} * @memberof AccessItemEntitlementResponse */ 'value': string; /** * the type of entitlement * @type {string} * @memberof AccessItemEntitlementResponse */ 'type': string; /** * the description for the entitlment * @type {string} * @memberof AccessItemEntitlementResponse */ 'description'?: string | null; /** * the id of the source * @type {string} * @memberof AccessItemEntitlementResponse */ 'sourceId'?: string; /** * indicates whether the entitlement is standalone * @type {boolean} * @memberof AccessItemEntitlementResponse */ 'standalone': boolean | null; /** * indicates whether the entitlement is privileged * @type {boolean} * @memberof AccessItemEntitlementResponse */ 'privileged': boolean | null; /** * indicates whether the entitlement is cloud governed * @type {boolean} * @memberof AccessItemEntitlementResponse */ 'cloudGoverned': boolean | null; } /** * * @export * @interface AccessItemRemoved */ export interface AccessItemRemoved { /** * * @type {AccessItemAssociatedAccessItem} * @memberof AccessItemRemoved */ 'accessItem': AccessItemAssociatedAccessItem; /** * the identity id * @type {string} * @memberof AccessItemRemoved */ 'identityId'?: string; /** * the event type * @type {string} * @memberof AccessItemRemoved */ 'eventType'?: string; /** * the date of event * @type {string} * @memberof AccessItemRemoved */ 'dateTime'?: string; /** * the access item type * @type {string} * @memberof AccessItemRemoved */ 'accessItemType'?: AccessItemRemovedAccessItemTypeEnum; /** * * @type {CorrelatedGovernanceEvent} * @memberof AccessItemRemoved */ 'governanceEvent'?: CorrelatedGovernanceEvent | null; } export const AccessItemRemovedAccessItemTypeEnum = { Account: 'account', App: 'app', Entitlement: 'entitlement', Role: 'role', AccessProfile: 'accessProfile' } as const; export type AccessItemRemovedAccessItemTypeEnum = typeof AccessItemRemovedAccessItemTypeEnum[keyof typeof AccessItemRemovedAccessItemTypeEnum]; /** * * @export * @interface AccessItemRoleResponse */ export interface AccessItemRoleResponse { /** * the access item id * @type {string} * @memberof AccessItemRoleResponse */ 'id'?: string; /** * the access item type. role in this case * @type {string} * @memberof AccessItemRoleResponse */ 'accessType'?: string; /** * the role display name * @type {string} * @memberof AccessItemRoleResponse */ 'displayName'?: string; /** * the associated source name if it exists * @type {string} * @memberof AccessItemRoleResponse */ 'sourceName'?: string | null; /** * the description for the role * @type {string} * @memberof AccessItemRoleResponse */ 'description'?: string; /** * the date the access profile will be assigned to the specified identity, in case requested with a future start date * @type {string} * @memberof AccessItemRoleResponse */ 'startDate'?: string | null; /** * the date the role is no longer assigned to the specified identity * @type {string} * @memberof AccessItemRoleResponse */ 'removeDate'?: string; /** * indicates whether the role is revocable * @type {boolean} * @memberof AccessItemRoleResponse */ 'revocable': boolean; } /** * * @export * @interface AccessRequestItemResponse */ export interface AccessRequestItemResponse { /** * the access request item operation * @type {string} * @memberof AccessRequestItemResponse */ 'operation'?: string; /** * the access item type * @type {string} * @memberof AccessRequestItemResponse */ 'accessItemType'?: string; /** * the name of access request item * @type {string} * @memberof AccessRequestItemResponse */ 'name'?: string; /** * the final decision for the access request * @type {string} * @memberof AccessRequestItemResponse */ 'decision'?: AccessRequestItemResponseDecisionEnum; /** * the description of access request item * @type {string} * @memberof AccessRequestItemResponse */ 'description'?: string; /** * the source id * @type {string} * @memberof AccessRequestItemResponse */ 'sourceId'?: string; /** * the source Name * @type {string} * @memberof AccessRequestItemResponse */ 'sourceName'?: string; /** * * @type {Array} * @memberof AccessRequestItemResponse */ 'approvalInfos'?: Array; } export const AccessRequestItemResponseDecisionEnum = { Approved: 'APPROVED', Rejected: 'REJECTED' } as const; export type AccessRequestItemResponseDecisionEnum = typeof AccessRequestItemResponseDecisionEnum[keyof typeof AccessRequestItemResponseDecisionEnum]; /** * * @export * @interface AccessRequestResponse2 */ export interface AccessRequestResponse2 { /** * the requester Id * @type {string} * @memberof AccessRequestResponse2 */ 'requesterId'?: string; /** * the requesterName * @type {string} * @memberof AccessRequestResponse2 */ 'requesterName'?: string; /** * * @type {Array} * @memberof AccessRequestResponse2 */ 'items'?: Array; } /** * * @export * @interface AccessRequested */ export interface AccessRequested { /** * * @type {AccessRequestResponse2} * @memberof AccessRequested */ 'accessRequest': AccessRequestResponse2; /** * the identity id * @type {string} * @memberof AccessRequested */ 'identityId'?: string; /** * the event type * @type {string} * @memberof AccessRequested */ 'eventType'?: string; /** * the date of event * @type {string} * @memberof AccessRequested */ 'dateTime'?: string; } /** * * @export * @interface AccountStatusChanged */ export interface AccountStatusChanged { /** * the event type * @type {string} * @memberof AccountStatusChanged */ 'eventType'?: string; /** * the identity id * @type {string} * @memberof AccountStatusChanged */ 'identityId'?: string; /** * the date of event * @type {string} * @memberof AccountStatusChanged */ 'dateTime'?: string; /** * * @type {AccountStatusChangedAccount} * @memberof AccountStatusChanged */ 'account': AccountStatusChangedAccount; /** * * @type {AccountStatusChangedStatusChange} * @memberof AccountStatusChanged */ 'statusChange': AccountStatusChangedStatusChange; } /** * * @export * @interface AccountStatusChangedAccount */ export interface AccountStatusChangedAccount { /** * the ID of the account in the database * @type {string} * @memberof AccountStatusChangedAccount */ 'id'?: string; /** * the native identifier of the account * @type {string} * @memberof AccountStatusChangedAccount */ 'nativeIdentity'?: string; /** * the display name of the account * @type {string} * @memberof AccountStatusChangedAccount */ 'displayName'?: string; /** * the ID of the source for this account * @type {string} * @memberof AccountStatusChangedAccount */ 'sourceId'?: string; /** * the name of the source for this account * @type {string} * @memberof AccountStatusChangedAccount */ 'sourceName'?: string; /** * the number of entitlements on this account * @type {number} * @memberof AccountStatusChangedAccount */ 'entitlementCount'?: number; /** * this value is always \"account\" * @type {string} * @memberof AccountStatusChangedAccount */ 'accessType'?: string; } /** * * @export * @interface AccountStatusChangedStatusChange */ export interface AccountStatusChangedStatusChange { /** * the previous status of the account * @type {string} * @memberof AccountStatusChangedStatusChange */ 'previousStatus'?: AccountStatusChangedStatusChangePreviousStatusEnum; /** * the new status of the account * @type {string} * @memberof AccountStatusChangedStatusChange */ 'newStatus'?: AccountStatusChangedStatusChangeNewStatusEnum; } export const AccountStatusChangedStatusChangePreviousStatusEnum = { Enabled: 'enabled', Disabled: 'disabled', Locked: 'locked' } as const; export type AccountStatusChangedStatusChangePreviousStatusEnum = typeof AccountStatusChangedStatusChangePreviousStatusEnum[keyof typeof AccountStatusChangedStatusChangePreviousStatusEnum]; export const AccountStatusChangedStatusChangeNewStatusEnum = { Enabled: 'enabled', Disabled: 'disabled', Locked: 'locked' } as const; export type AccountStatusChangedStatusChangeNewStatusEnum = typeof AccountStatusChangedStatusChangeNewStatusEnum[keyof typeof AccountStatusChangedStatusChangeNewStatusEnum]; /** * * @export * @interface ApprovalInfoResponse */ export interface ApprovalInfoResponse { /** * the id of approver * @type {string} * @memberof ApprovalInfoResponse */ 'id'?: string; /** * the name of approver * @type {string} * @memberof ApprovalInfoResponse */ 'name'?: string; /** * the status of the approval request * @type {string} * @memberof ApprovalInfoResponse */ 'status'?: string; } /** * * @export * @interface AttributeChange */ export interface AttributeChange { /** * the attribute name * @type {string} * @memberof AttributeChange */ 'name'?: string; /** * the old value of attribute * @type {string} * @memberof AttributeChange */ 'previousValue'?: string; /** * the new value of attribute * @type {string} * @memberof AttributeChange */ 'newValue'?: string; } /** * * @export * @interface AttributesChanged */ export interface AttributesChanged { /** * * @type {Array} * @memberof AttributesChanged */ 'attributeChanges': Array; /** * the event type * @type {string} * @memberof AttributesChanged */ 'eventType'?: string; /** * the identity id * @type {string} * @memberof AttributesChanged */ 'identityId'?: string; /** * the date of event * @type {string} * @memberof AttributesChanged */ 'dateTime'?: string; } /** * * @export * @interface CertifierResponse */ export interface CertifierResponse { /** * the id of the certifier * @type {string} * @memberof CertifierResponse */ 'id'?: string; /** * the name of the certifier * @type {string} * @memberof CertifierResponse */ 'displayName'?: string; } /** * * @export * @interface CorrelatedGovernanceEvent */ export interface CorrelatedGovernanceEvent { /** * The name of the governance event, such as the certification name or access request ID. * @type {string} * @memberof CorrelatedGovernanceEvent */ 'name'?: string; /** * The date that the certification or access request was completed. * @type {string} * @memberof CorrelatedGovernanceEvent */ 'dateTime'?: string; /** * The type of governance event. * @type {string} * @memberof CorrelatedGovernanceEvent */ 'type'?: CorrelatedGovernanceEventTypeEnum; /** * The ID of the instance that caused the event - either the certification ID or access request ID. * @type {string} * @memberof CorrelatedGovernanceEvent */ 'governanceId'?: string; /** * The owners of the governance event (the certifiers or approvers) * @type {Array} * @memberof CorrelatedGovernanceEvent */ 'owners'?: Array; /** * The owners of the governance event (the certifiers or approvers), this field should be preferred over owners * @type {Array} * @memberof CorrelatedGovernanceEvent */ 'reviewers'?: Array; /** * * @type {CertifierResponse} * @memberof CorrelatedGovernanceEvent */ 'decisionMaker'?: CertifierResponse; } export const CorrelatedGovernanceEventTypeEnum = { Certification: 'certification', AccessRequest: 'accessRequest' } as const; export type CorrelatedGovernanceEventTypeEnum = typeof CorrelatedGovernanceEventTypeEnum[keyof typeof CorrelatedGovernanceEventTypeEnum]; /** * * @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 GetHistoricalIdentityEventsV1200ResponseInner */ export interface GetHistoricalIdentityEventsV1200ResponseInner { /** * the id of the certification item * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'certificationId': string; /** * the certification item name * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'certificationName': string; /** * the date ceritification was signed * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'signedDate'?: string; /** * this field is deprecated and may go away * @type {Array} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'certifiers'?: Array; /** * The list of identities who review this certification * @type {Array} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'reviewers'?: Array; /** * * @type {CertifierResponse} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'signer'?: CertifierResponse; /** * the event type * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'eventType'?: string; /** * the date of event * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'dateTime'?: string; /** * the identity id * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'identityId'?: string; /** * * @type {AccessItemAssociatedAccessItem} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'accessItem': AccessItemAssociatedAccessItem; /** * * @type {CorrelatedGovernanceEvent} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'governanceEvent': CorrelatedGovernanceEvent | null; /** * the access item type * @type {string} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'accessItemType'?: GetHistoricalIdentityEventsV1200ResponseInnerAccessItemTypeEnum; /** * * @type {Array} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'attributeChanges': Array; /** * * @type {AccessRequestResponse2} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'accessRequest': AccessRequestResponse2; /** * * @type {AccountStatusChangedAccount} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'account': AccountStatusChangedAccount; /** * * @type {AccountStatusChangedStatusChange} * @memberof GetHistoricalIdentityEventsV1200ResponseInner */ 'statusChange': AccountStatusChangedStatusChange; } export const GetHistoricalIdentityEventsV1200ResponseInnerAccessItemTypeEnum = { Account: 'account', App: 'app', Entitlement: 'entitlement', Role: 'role', AccessProfile: 'accessProfile' } as const; export type GetHistoricalIdentityEventsV1200ResponseInnerAccessItemTypeEnum = typeof GetHistoricalIdentityEventsV1200ResponseInnerAccessItemTypeEnum[keyof typeof GetHistoricalIdentityEventsV1200ResponseInnerAccessItemTypeEnum]; /** * * @export * @interface IdentityCertified */ export interface IdentityCertified { /** * the id of the certification item * @type {string} * @memberof IdentityCertified */ 'certificationId': string; /** * the certification item name * @type {string} * @memberof IdentityCertified */ 'certificationName': string; /** * the date ceritification was signed * @type {string} * @memberof IdentityCertified */ 'signedDate'?: string; /** * this field is deprecated and may go away * @type {Array} * @memberof IdentityCertified */ 'certifiers'?: Array; /** * The list of identities who review this certification * @type {Array} * @memberof IdentityCertified */ 'reviewers'?: Array; /** * * @type {CertifierResponse} * @memberof IdentityCertified */ 'signer'?: CertifierResponse; /** * the event type * @type {string} * @memberof IdentityCertified */ 'eventType'?: string; /** * the date of event * @type {string} * @memberof IdentityCertified */ 'dateTime'?: string; } /** * * @export * @interface IdentityCompareResponse */ export interface IdentityCompareResponse { /** * Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. * @type {{ [key: string]: object; }} * @memberof IdentityCompareResponse */ 'accessItemDiff'?: { [key: string]: object; }; } /** * * @export * @interface IdentityHistoryResponse */ export interface IdentityHistoryResponse { /** * the identity ID * @type {string} * @memberof IdentityHistoryResponse */ 'id'?: string; /** * the display name of the identity * @type {string} * @memberof IdentityHistoryResponse */ 'displayName'?: string; /** * the date when the identity record was created * @type {string} * @memberof IdentityHistoryResponse */ 'snapshot'?: string; /** * the date when the identity was deleted * @type {string} * @memberof IdentityHistoryResponse */ 'deletedDate'?: string; /** * A map containing the count of each access item * @type {{ [key: string]: number; }} * @memberof IdentityHistoryResponse */ 'accessItemCount'?: { [key: string]: number; }; /** * A map containing the identity attributes * @type {{ [key: string]: any; }} * @memberof IdentityHistoryResponse */ 'attributes'?: { [key: string]: any; }; } /** * * @export * @interface IdentityListItem */ export interface IdentityListItem { /** * the identity ID * @type {string} * @memberof IdentityListItem */ 'id'?: string; /** * the display name of the identity * @type {string} * @memberof IdentityListItem */ 'displayName'?: string; /** * the first name of the identity * @type {string} * @memberof IdentityListItem */ 'firstName'?: string | null; /** * the last name of the identity * @type {string} * @memberof IdentityListItem */ 'lastName'?: string | null; /** * indicates if an identity is active or not * @type {boolean} * @memberof IdentityListItem */ 'active'?: boolean; /** * the date when the identity was deleted * @type {string} * @memberof IdentityListItem */ 'deletedDate'?: string | null; } /** * * @export * @interface IdentitySnapshotSummaryResponse */ export interface IdentitySnapshotSummaryResponse { /** * the date when the identity record was created * @type {string} * @memberof IdentitySnapshotSummaryResponse */ 'snapshot'?: string; } /** * * @export * @interface ListHistoricalIdentitiesV1401Response */ export interface ListHistoricalIdentitiesV1401Response { /** * A message describing the error * @type {any} * @memberof ListHistoricalIdentitiesV1401Response */ 'error'?: any; } /** * * @export * @interface ListHistoricalIdentitiesV1429Response */ export interface ListHistoricalIdentitiesV1429Response { /** * A message describing the error * @type {any} * @memberof ListHistoricalIdentitiesV1429Response */ 'message'?: any; } /** * * @export * @interface ListIdentityAccessItemsV1200ResponseInner */ export interface ListIdentityAccessItemsV1200ResponseInner { /** * the access item id * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'id'?: string; /** * the access item type. entitlement in this case * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'accessType'?: string; /** * the access item display name * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'displayName'?: string; /** * the associated source name if it exists * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'sourceName'?: string | null; /** * the entitlement attribute * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'attribute': string; /** * the associated value * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'value': string; /** * the type of entitlement * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'type': string; /** * the description for the role * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'description'?: string; /** * the id of the source * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'sourceId'?: string; /** * indicates whether the access profile is standalone * @type {boolean} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'standalone': boolean | null; /** * indicates whether the entitlement is privileged * @type {boolean} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'privileged': boolean | null; /** * indicates whether the entitlement is cloud governed * @type {boolean} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'cloudGoverned': boolean | null; /** * the number of entitlements the account will create * @type {number} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'entitlementCount': number; /** * the list of app ids associated with the access profile * @type {Array} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'appRefs': Array; /** * the date the access profile will be assigned to the specified identity, in case requested with a future start date * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'startDate'?: string | null; /** * the date the role is no longer assigned to the specified identity * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'removeDate'?: string; /** * indicates whether the role is revocable * @type {boolean} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'revocable': boolean; /** * the native identifier used to uniquely identify an acccount * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'nativeIdentity': string; /** * the app role id * @type {string} * @memberof ListIdentityAccessItemsV1200ResponseInner */ 'appRoleId': string | null; } /** * @type ListIdentitySnapshotAccessItemsV1200ResponseInner * @export */ export type ListIdentitySnapshotAccessItemsV1200ResponseInner = AccessItemAccessProfileResponse | AccessItemAccountResponse | AccessItemAppResponse | AccessItemEntitlementResponse | AccessItemRoleResponse; /** * 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 const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface MetricResponse */ export interface MetricResponse { /** * the name of metric * @type {string} * @memberof MetricResponse */ 'name'?: string; /** * the value associated to the metric * @type {number} * @memberof MetricResponse */ 'value'?: number; } /** * IdentityHistoryApi - axios parameter creator * @export */ export const IdentityHistoryApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots * @param {string} id The identity id * @param {CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum} accessType The specific type which needs to be compared * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed * @param {string} [snapshot1] The snapshot 1 of identity * @param {string} [snapshot2] The snapshot 2 of identity * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ compareIdentitySnapshotsAccessTypeV1: async (id: string, accessType: CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('compareIdentitySnapshotsAccessTypeV1', 'id', id) // verify required parameter 'accessType' is not null or undefined assertParamExists('compareIdentitySnapshotsAccessTypeV1', 'accessType', accessType) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/compare/{access-type}` .replace(`{${"id"}}`, encodeURIComponent(String(id))) .replace(`{${"accessType"}}`, encodeURIComponent(String(accessType))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (accessAssociated !== undefined) { localVarQueryParameter['access-associated'] = accessAssociated; } if (snapshot1 !== undefined) { localVarQueryParameter['snapshot1'] = snapshot1; } if (snapshot2 !== undefined) { localVarQueryParameter['snapshot2'] = snapshot2; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots * @param {string} id The identity id * @param {string} [snapshot1] The snapshot 1 of identity * @param {string} [snapshot2] The snapshot 2 of identity * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ compareIdentitySnapshotsV1: async (id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('compareIdentitySnapshotsV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/compare` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (snapshot1 !== undefined) { localVarQueryParameter['snapshot1'] = snapshot1; } if (snapshot2 !== undefined) { localVarQueryParameter['snapshot2'] = snapshot2; } if (accessItemTypes) { localVarQueryParameter['accessItemTypes'] = accessItemTypes; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary List identity event history * @param {string} id The identity id * @param {string} [from] The optional instant until which access events are returned * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getHistoricalIdentityEventsV1: async (id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getHistoricalIdentityEventsV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/events` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (from !== undefined) { localVarQueryParameter['from'] = from; } if (eventTypes) { localVarQueryParameter['eventTypes'] = eventTypes; } if (accessItemTypes) { localVarQueryParameter['accessItemTypes'] = accessItemTypes; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' * @summary Get latest snapshot of identity * @param {string} id The identity id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getHistoricalIdentityV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getHistoricalIdentityV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the summary for the event count for a specific identity * @param {string} id The identity id * @param {string} [before] The date before which snapshot summary is required * @param {GetIdentitySnapshotSummaryV1IntervalEnum} [interval] The interval indicating day or month. Defaults to month if not specified * @param {string} [timeZone] The time zone. Defaults to UTC if not provided * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySnapshotSummaryV1: async (id: string, before?: string, interval?: GetIdentitySnapshotSummaryV1IntervalEnum, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentitySnapshotSummaryV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/snapshot-summary` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (before !== undefined) { localVarQueryParameter['before'] = before; } if (interval !== undefined) { localVarQueryParameter['interval'] = interval; } if (timeZone !== undefined) { localVarQueryParameter['time-zone'] = timeZone; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' * @summary Gets an identity snapshot at a given date * @param {string} id The identity id * @param {string} date The specified date * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySnapshotV1: async (id: string, date: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentitySnapshotV1', 'id', id) // verify required parameter 'date' is not null or undefined assertParamExists('getIdentitySnapshotV1', 'date', date) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/snapshots/{date}` .replace(`{${"id"}}`, encodeURIComponent(String(id))) .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the start date of the identity * @param {string} id The identity id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityStartDateV1: async (id: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getIdentityStartDateV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/start-date` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the identities * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listHistoricalIdentitiesV1: async (startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (startsWithQuery !== undefined) { localVarQueryParameter['starts-with-query'] = startsWithQuery; } if (isDeleted !== undefined) { localVarQueryParameter['is-deleted'] = isDeleted; } if (isActive !== undefined) { localVarQueryParameter['is-active'] = isActive; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves a list of access item for the identity filtered by the access item type * @summary List access items by identity * @param {string} id The identity id * @param {ListIdentityAccessItemsV1TypeEnum} [type] The type of access item for the identity. If not provided, it defaults to account * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @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 {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 {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityAccessItemsV1: async (id: string, type?: ListIdentityAccessItemsV1TypeEnum, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('listIdentityAccessItemsV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/access-items` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (type !== undefined) { localVarQueryParameter['type'] = type; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the list of identity access items at a given date filterd by item type * @param {string} id The identity id * @param {string} date The specified date * @param {string} [type] The access item type * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentitySnapshotAccessItemsV1: async (id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('listIdentitySnapshotAccessItemsV1', 'id', id) // verify required parameter 'date' is not null or undefined assertParamExists('listIdentitySnapshotAccessItemsV1', 'date', date) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/snapshots/{date}/access-items` .replace(`{${"id"}}`, encodeURIComponent(String(id))) .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (type !== undefined) { localVarQueryParameter['type'] = type; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the snapshots for the identity * @param {string} id The identity id * @param {string} [start] The specified start date * @param {ListIdentitySnapshotsV1IntervalEnum} [interval] The interval indicating the range in day or month for the specified interval-name * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentitySnapshotsV1: async (id: string, start?: string, interval?: ListIdentitySnapshotsV1IntervalEnum, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('listIdentitySnapshotsV1', 'id', id) if (xSailPointExperimental === undefined) { xSailPointExperimental = 'true'; } const localVarPath = `/historical-identities/v1/{id}/snapshots` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (start !== undefined) { localVarQueryParameter['start'] = start; } if (interval !== undefined) { localVarQueryParameter['interval'] = interval; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (xSailPointExperimental != null) { localVarHeaderParameter['X-SailPoint-Experimental'] = String(xSailPointExperimental); } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * IdentityHistoryApi - functional programming interface * @export */ export const IdentityHistoryApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = IdentityHistoryApiAxiosParamCreator(configuration) return { /** * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots * @param {string} id The identity id * @param {CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum} accessType The specific type which needs to be compared * @param {boolean} [accessAssociated] Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed * @param {string} [snapshot1] The snapshot 1 of identity * @param {string} [snapshot2] The snapshot 2 of identity * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async compareIdentitySnapshotsAccessTypeV1(id: string, accessType: CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum, accessAssociated?: boolean, snapshot1?: string, snapshot2?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsAccessTypeV1(id, accessType, accessAssociated, snapshot1, snapshot2, limit, offset, count, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.compareIdentitySnapshotsAccessTypeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots * @param {string} id The identity id * @param {string} [snapshot1] The snapshot 1 of identity * @param {string} [snapshot2] The snapshot 2 of identity * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async compareIdentitySnapshotsV1(id: string, snapshot1?: string, snapshot2?: string, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.compareIdentitySnapshotsV1(id, snapshot1, snapshot2, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.compareIdentitySnapshotsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary List identity event history * @param {string} id The identity id * @param {string} [from] The optional instant until which access events are returned * @param {Array} [eventTypes] An optional list of event types to return. If null or empty, all events are returned * @param {Array} [accessItemTypes] An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getHistoricalIdentityEventsV1(id: string, from?: string, eventTypes?: Array, accessItemTypes?: Array, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityEventsV1(id, from, eventTypes, accessItemTypes, limit, offset, count, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.getHistoricalIdentityEventsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' * @summary Get latest snapshot of identity * @param {string} id The identity id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getHistoricalIdentityV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getHistoricalIdentityV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.getHistoricalIdentityV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the summary for the event count for a specific identity * @param {string} id The identity id * @param {string} [before] The date before which snapshot summary is required * @param {GetIdentitySnapshotSummaryV1IntervalEnum} [interval] The interval indicating day or month. Defaults to month if not specified * @param {string} [timeZone] The time zone. Defaults to UTC if not provided * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentitySnapshotSummaryV1(id: string, before?: string, interval?: GetIdentitySnapshotSummaryV1IntervalEnum, timeZone?: string, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotSummaryV1(id, before, interval, timeZone, limit, offset, count, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.getIdentitySnapshotSummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' * @summary Gets an identity snapshot at a given date * @param {string} id The identity id * @param {string} date The specified date * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentitySnapshotV1(id: string, date: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentitySnapshotV1(id, date, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.getIdentitySnapshotV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the start date of the identity * @param {string} id The identity id * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getIdentityStartDateV1(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIdentityStartDateV1(id, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.getIdentityStartDateV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the identities * @param {string} [startsWithQuery] This param is used for starts-with search for first, last and display name of the identity * @param {boolean} [isDeleted] Indicates if we want to only list down deleted identities or not. * @param {boolean} [isActive] Indicates if we want to only list active or inactive identities. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listHistoricalIdentitiesV1(startsWithQuery?: string, isDeleted?: boolean, isActive?: boolean, limit?: number, offset?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listHistoricalIdentitiesV1(startsWithQuery, isDeleted, isActive, limit, offset, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.listHistoricalIdentitiesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves a list of access item for the identity filtered by the access item type * @summary List access items by identity * @param {string} id The identity id * @param {ListIdentityAccessItemsV1TypeEnum} [type] The type of access item for the identity. If not provided, it defaults to account * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @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 {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 {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentityAccessItemsV1(id: string, type?: ListIdentityAccessItemsV1TypeEnum, xSailPointExperimental?: string, limit?: number, count?: boolean, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentityAccessItemsV1(id, type, xSailPointExperimental, limit, count, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.listIdentityAccessItemsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the list of identity access items at a given date filterd by item type * @param {string} id The identity id * @param {string} date The specified date * @param {string} [type] The access item type * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentitySnapshotAccessItemsV1(id: string, date: string, type?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotAccessItemsV1(id, date, type, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.listIdentitySnapshotAccessItemsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the snapshots for the identity * @param {string} id The identity id * @param {string} [start] The specified start date * @param {ListIdentitySnapshotsV1IntervalEnum} [interval] The interval indicating the range in day or month for the specified interval-name * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [xSailPointExperimental] Use this header to enable this experimental API. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listIdentitySnapshotsV1(id: string, start?: string, interval?: ListIdentitySnapshotsV1IntervalEnum, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listIdentitySnapshotsV1(id, start, interval, limit, offset, count, xSailPointExperimental, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['IdentityHistoryApi.listIdentitySnapshotsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * IdentityHistoryApi - factory interface * @export */ export const IdentityHistoryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = IdentityHistoryApiFp(configuration) return { /** * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots * @param {IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ compareIdentitySnapshotsAccessTypeV1(requestParameters: IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.compareIdentitySnapshotsAccessTypeV1(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots * @param {IdentityHistoryApiCompareIdentitySnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ compareIdentitySnapshotsV1(requestParameters: IdentityHistoryApiCompareIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.compareIdentitySnapshotsV1(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary List identity event history * @param {IdentityHistoryApiGetHistoricalIdentityEventsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getHistoricalIdentityEventsV1(requestParameters: IdentityHistoryApiGetHistoricalIdentityEventsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getHistoricalIdentityEventsV1(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' * @summary Get latest snapshot of identity * @param {IdentityHistoryApiGetHistoricalIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getHistoricalIdentityV1(requestParameters: IdentityHistoryApiGetHistoricalIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getHistoricalIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the summary for the event count for a specific identity * @param {IdentityHistoryApiGetIdentitySnapshotSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySnapshotSummaryV1(requestParameters: IdentityHistoryApiGetIdentitySnapshotSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getIdentitySnapshotSummaryV1(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' * @summary Gets an identity snapshot at a given date * @param {IdentityHistoryApiGetIdentitySnapshotV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentitySnapshotV1(requestParameters: IdentityHistoryApiGetIdentitySnapshotV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentitySnapshotV1(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the start date of the identity * @param {IdentityHistoryApiGetIdentityStartDateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityStartDateV1(requestParameters: IdentityHistoryApiGetIdentityStartDateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getIdentityStartDateV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the identities * @param {IdentityHistoryApiListHistoricalIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listHistoricalIdentitiesV1(requestParameters: IdentityHistoryApiListHistoricalIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listHistoricalIdentitiesV1(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves a list of access item for the identity filtered by the access item type * @summary List access items by identity * @param {IdentityHistoryApiListIdentityAccessItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentityAccessItemsV1(requestParameters: IdentityHistoryApiListIdentityAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentityAccessItemsV1(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the list of identity access items at a given date filterd by item type * @param {IdentityHistoryApiListIdentitySnapshotAccessItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentitySnapshotAccessItemsV1(requestParameters: IdentityHistoryApiListIdentitySnapshotAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentitySnapshotAccessItemsV1(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, /** * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the snapshots for the identity * @param {IdentityHistoryApiListIdentitySnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listIdentitySnapshotsV1(requestParameters: IdentityHistoryApiListIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listIdentitySnapshotsV1(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for compareIdentitySnapshotsAccessTypeV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1Request */ export interface IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly id: string /** * The specific type which needs to be compared * @type {'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly accessType: CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum /** * Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed * @type {boolean} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly accessAssociated?: boolean /** * The snapshot 1 of identity * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly snapshot1?: string /** * The snapshot 2 of identity * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly snapshot2?: string /** * 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 IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly count?: boolean /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for compareIdentitySnapshotsV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiCompareIdentitySnapshotsV1Request */ export interface IdentityHistoryApiCompareIdentitySnapshotsV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly id: string /** * The snapshot 1 of identity * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly snapshot1?: string /** * The snapshot 2 of identity * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly snapshot2?: string /** * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned * @type {Array} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly accessItemTypes?: Array /** * 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 IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly count?: boolean /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiCompareIdentitySnapshotsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getHistoricalIdentityEventsV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiGetHistoricalIdentityEventsV1Request */ export interface IdentityHistoryApiGetHistoricalIdentityEventsV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly id: string /** * The optional instant until which access events are returned * @type {string} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly from?: string /** * An optional list of event types to return. If null or empty, all events are returned * @type {Array} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly eventTypes?: Array /** * An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned * @type {Array} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly accessItemTypes?: Array /** * 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 IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly count?: boolean /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiGetHistoricalIdentityEventsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getHistoricalIdentityV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiGetHistoricalIdentityV1Request */ export interface IdentityHistoryApiGetHistoricalIdentityV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiGetHistoricalIdentityV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiGetHistoricalIdentityV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getIdentitySnapshotSummaryV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiGetIdentitySnapshotSummaryV1Request */ export interface IdentityHistoryApiGetIdentitySnapshotSummaryV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly id: string /** * The date before which snapshot summary is required * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly before?: string /** * The interval indicating day or month. Defaults to month if not specified * @type {'day' | 'month'} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly interval?: GetIdentitySnapshotSummaryV1IntervalEnum /** * The time zone. Defaults to UTC if not provided * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly timeZone?: string /** * 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 IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly count?: boolean /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotSummaryV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getIdentitySnapshotV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiGetIdentitySnapshotV1Request */ export interface IdentityHistoryApiGetIdentitySnapshotV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotV1 */ readonly id: string /** * The specified date * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotV1 */ readonly date: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiGetIdentitySnapshotV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for getIdentityStartDateV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiGetIdentityStartDateV1Request */ export interface IdentityHistoryApiGetIdentityStartDateV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiGetIdentityStartDateV1 */ readonly id: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiGetIdentityStartDateV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for listHistoricalIdentitiesV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiListHistoricalIdentitiesV1Request */ export interface IdentityHistoryApiListHistoricalIdentitiesV1Request { /** * This param is used for starts-with search for first, last and display name of the identity * @type {string} * @memberof IdentityHistoryApiListHistoricalIdentitiesV1 */ readonly startsWithQuery?: string /** * Indicates if we want to only list down deleted identities or not. * @type {boolean} * @memberof IdentityHistoryApiListHistoricalIdentitiesV1 */ readonly isDeleted?: boolean /** * Indicates if we want to only list active or inactive identities. * @type {boolean} * @memberof IdentityHistoryApiListHistoricalIdentitiesV1 */ readonly isActive?: boolean /** * 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 IdentityHistoryApiListHistoricalIdentitiesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentityHistoryApiListHistoricalIdentitiesV1 */ readonly offset?: number /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiListHistoricalIdentitiesV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for listIdentityAccessItemsV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiListIdentityAccessItemsV1Request */ export interface IdentityHistoryApiListIdentityAccessItemsV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiListIdentityAccessItemsV1 */ readonly id: string /** * The type of access item for the identity. If not provided, it defaults to account * @type {'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'} * @memberof IdentityHistoryApiListIdentityAccessItemsV1 */ readonly type?: ListIdentityAccessItemsV1TypeEnum /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiListIdentityAccessItemsV1 */ readonly xSailPointExperimental?: string /** * 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 IdentityHistoryApiListIdentityAccessItemsV1 */ 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 IdentityHistoryApiListIdentityAccessItemsV1 */ readonly count?: boolean /** * 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 IdentityHistoryApiListIdentityAccessItemsV1 */ readonly offset?: number } /** * Request parameters for listIdentitySnapshotAccessItemsV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiListIdentitySnapshotAccessItemsV1Request */ export interface IdentityHistoryApiListIdentitySnapshotAccessItemsV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotAccessItemsV1 */ readonly id: string /** * The specified date * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotAccessItemsV1 */ readonly date: string /** * The access item type * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotAccessItemsV1 */ readonly type?: string /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotAccessItemsV1 */ readonly xSailPointExperimental?: string } /** * Request parameters for listIdentitySnapshotsV1 operation in IdentityHistoryApi. * @export * @interface IdentityHistoryApiListIdentitySnapshotsV1Request */ export interface IdentityHistoryApiListIdentitySnapshotsV1Request { /** * The identity id * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotsV1 */ readonly id: string /** * The specified start date * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotsV1 */ readonly start?: string /** * The interval indicating the range in day or month for the specified interval-name * @type {'day' | 'month'} * @memberof IdentityHistoryApiListIdentitySnapshotsV1 */ readonly interval?: ListIdentitySnapshotsV1IntervalEnum /** * 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 IdentityHistoryApiListIdentitySnapshotsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof IdentityHistoryApiListIdentitySnapshotsV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof IdentityHistoryApiListIdentitySnapshotsV1 */ readonly count?: boolean /** * Use this header to enable this experimental API. * @type {string} * @memberof IdentityHistoryApiListIdentitySnapshotsV1 */ readonly xSailPointExperimental?: string } /** * IdentityHistoryApi - object-oriented interface * @export * @class IdentityHistoryApi * @extends {BaseAPI} */ export class IdentityHistoryApi extends BaseAPI { /** * This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a list of differences of specific accesstype for the given identity between 2 snapshots * @param {IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public compareIdentitySnapshotsAccessTypeV1(requestParameters: IdentityHistoryApiCompareIdentitySnapshotsAccessTypeV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).compareIdentitySnapshotsAccessTypeV1(requestParameters.id, requestParameters.accessType, requestParameters.accessAssociated, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of \'idn:identity-history:read\' * @summary Gets a difference of count for each access item types for the given identity between 2 snapshots * @param {IdentityHistoryApiCompareIdentitySnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public compareIdentitySnapshotsV1(requestParameters: IdentityHistoryApiCompareIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).compareIdentitySnapshotsV1(requestParameters.id, requestParameters.snapshot1, requestParameters.snapshot2, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves all access events for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary List identity event history * @param {IdentityHistoryApiGetHistoricalIdentityEventsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public getHistoricalIdentityEventsV1(requestParameters: IdentityHistoryApiGetHistoricalIdentityEventsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).getHistoricalIdentityEventsV1(requestParameters.id, requestParameters.from, requestParameters.eventTypes, requestParameters.accessItemTypes, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves a specified identity Requires authorization scope of \'idn:identity-history:read\' * @summary Get latest snapshot of identity * @param {IdentityHistoryApiGetHistoricalIdentityV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public getHistoricalIdentityV1(requestParameters: IdentityHistoryApiGetHistoricalIdentityV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).getHistoricalIdentityV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the summary for the event count for a specific identity * @param {IdentityHistoryApiGetIdentitySnapshotSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public getIdentitySnapshotSummaryV1(requestParameters: IdentityHistoryApiGetIdentitySnapshotSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).getIdentitySnapshotSummaryV1(requestParameters.id, requestParameters.before, requestParameters.interval, requestParameters.timeZone, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves a specified identity snapshot at a given date Requires authorization scope of \'idn:identity-history:read\' * @summary Gets an identity snapshot at a given date * @param {IdentityHistoryApiGetIdentitySnapshotV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public getIdentitySnapshotV1(requestParameters: IdentityHistoryApiGetIdentitySnapshotV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).getIdentitySnapshotV1(requestParameters.id, requestParameters.date, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves start date of the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the start date of the identity * @param {IdentityHistoryApiGetIdentityStartDateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public getIdentityStartDateV1(requestParameters: IdentityHistoryApiGetIdentityStartDateV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).getIdentityStartDateV1(requestParameters.id, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the identities * @param {IdentityHistoryApiListHistoricalIdentitiesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public listHistoricalIdentitiesV1(requestParameters: IdentityHistoryApiListHistoricalIdentitiesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).listHistoricalIdentitiesV1(requestParameters.startsWithQuery, requestParameters.isDeleted, requestParameters.isActive, requestParameters.limit, requestParameters.offset, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves a list of access item for the identity filtered by the access item type * @summary List access items by identity * @param {IdentityHistoryApiListIdentityAccessItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public listIdentityAccessItemsV1(requestParameters: IdentityHistoryApiListIdentityAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).listIdentityAccessItemsV1(requestParameters.id, requestParameters.type, requestParameters.xSailPointExperimental, requestParameters.limit, requestParameters.count, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of \'idn:identity-history:read\' * @summary Gets the list of identity access items at a given date filterd by item type * @param {IdentityHistoryApiListIdentitySnapshotAccessItemsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public listIdentitySnapshotAccessItemsV1(requestParameters: IdentityHistoryApiListIdentitySnapshotAccessItemsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).listIdentitySnapshotAccessItemsV1(requestParameters.id, requestParameters.date, requestParameters.type, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This method retrieves all the snapshots for the identity Requires authorization scope of \'idn:identity-history:read\' * @summary Lists all the snapshots for the identity * @param {IdentityHistoryApiListIdentitySnapshotsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityHistoryApi */ public listIdentitySnapshotsV1(requestParameters: IdentityHistoryApiListIdentitySnapshotsV1Request, axiosOptions?: RawAxiosRequestConfig) { return IdentityHistoryApiFp(this.configuration).listIdentitySnapshotsV1(requestParameters.id, requestParameters.start, requestParameters.interval, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.xSailPointExperimental, axiosOptions).then((request) => request(this.axios, this.basePath)); } } /** * @export */ export const CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum = { AccessProfile: 'accessProfile', Account: 'account', App: 'app', Entitlement: 'entitlement', Role: 'role' } as const; export type CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum = typeof CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum[keyof typeof CompareIdentitySnapshotsAccessTypeV1AccessTypeEnum]; /** * @export */ export const GetIdentitySnapshotSummaryV1IntervalEnum = { Day: 'day', Month: 'month' } as const; export type GetIdentitySnapshotSummaryV1IntervalEnum = typeof GetIdentitySnapshotSummaryV1IntervalEnum[keyof typeof GetIdentitySnapshotSummaryV1IntervalEnum]; /** * @export */ export const ListIdentityAccessItemsV1TypeEnum = { Account: 'account', Entitlement: 'entitlement', App: 'app', AccessProfile: 'accessProfile', Role: 'role' } as const; export type ListIdentityAccessItemsV1TypeEnum = typeof ListIdentityAccessItemsV1TypeEnum[keyof typeof ListIdentityAccessItemsV1TypeEnum]; /** * @export */ export const ListIdentitySnapshotsV1IntervalEnum = { Day: 'day', Month: 'month' } as const; export type ListIdentitySnapshotsV1IntervalEnum = typeof ListIdentitySnapshotsV1IntervalEnum[keyof typeof ListIdentitySnapshotsV1IntervalEnum];