@sailpoint/api-client 2.2.48 → 2.2.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/accounts/api.d.ts +504 -0
- package/dist/accounts/api.js +146 -1
- package/dist/accounts/api.js.map +1 -1
- package/dist/esm/accounts/api.js +145 -0
- package/dist/esm/generic/api.js +262 -335
- package/dist/esm/generic/base.js +4 -4
- package/dist/esm/generic/common.js +44 -31
- package/dist/esm/generic/configuration.js +3 -3
- package/dist/esm/generic/index.js +3 -3
- package/dist/esm/index.js +3 -0
- package/dist/esm/machine_identities_lifecycle_actions/api.js +5 -5
- package/dist/esm/machine_identities_lifecycle_actions/base.js +1 -1
- package/dist/esm/machine_identities_lifecycle_actions/common.js +1 -1
- package/dist/esm/machine_identities_lifecycle_actions/configuration.js +1 -1
- package/dist/esm/machine_identities_lifecycle_actions/index.js +1 -1
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/esm/workflows/api.js +33 -7
- package/dist/generic/api.d.ts +166 -177
- package/dist/generic/api.js +265 -338
- package/dist/generic/api.js.map +1 -1
- package/dist/generic/base.d.ts +3 -3
- package/dist/generic/base.js +4 -4
- package/dist/generic/base.js.map +1 -1
- package/dist/generic/common.d.ts +4 -4
- package/dist/generic/common.js +44 -31
- package/dist/generic/common.js.map +1 -1
- package/dist/generic/configuration.d.ts +3 -3
- package/dist/generic/configuration.js +3 -3
- package/dist/generic/configuration.js.map +1 -1
- package/dist/generic/index.d.ts +3 -3
- package/dist/generic/index.js +3 -3
- package/dist/generic/index.js.map +1 -1
- package/dist/generic.spec.d.ts +1 -0
- package/dist/generic.spec.js +133 -0
- package/dist/generic.spec.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +5 -1
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +40 -0
- package/dist/index.spec.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/api.d.ts +5 -5
- package/dist/machine_identities_lifecycle_actions/api.js +5 -5
- package/dist/machine_identities_lifecycle_actions/api.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/base.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/base.js +1 -1
- package/dist/machine_identities_lifecycle_actions/base.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/common.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/common.js +1 -1
- package/dist/machine_identities_lifecycle_actions/common.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/configuration.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/configuration.js +1 -1
- package/dist/machine_identities_lifecycle_actions/configuration.js.map +1 -1
- package/dist/machine_identities_lifecycle_actions/index.d.ts +1 -1
- package/dist/machine_identities_lifecycle_actions/index.js +1 -1
- package/dist/machine_identities_lifecycle_actions/index.js.map +1 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/dist/workflows/api.d.ts +62 -4
- package/dist/workflows/api.js +34 -8
- package/dist/workflows/api.js.map +1 -1
- package/package.json +3 -2
- package/sailpoint-scopes.json +16392 -0
package/dist/accounts/api.d.ts
CHANGED
|
@@ -474,6 +474,416 @@ export interface AccountUnlockRequest {
|
|
|
474
474
|
*/
|
|
475
475
|
'forceProvisioning'?: boolean;
|
|
476
476
|
}
|
|
477
|
+
/**
|
|
478
|
+
* Account record returned by the search-backed accounts list API.
|
|
479
|
+
* @export
|
|
480
|
+
* @interface AccountV2
|
|
481
|
+
*/
|
|
482
|
+
export interface AccountV2 {
|
|
483
|
+
/**
|
|
484
|
+
* System-generated unique ID of the account.
|
|
485
|
+
* @type {string}
|
|
486
|
+
* @memberof AccountV2
|
|
487
|
+
*/
|
|
488
|
+
'id'?: string;
|
|
489
|
+
/**
|
|
490
|
+
* Display name of the account.
|
|
491
|
+
* @type {string}
|
|
492
|
+
* @memberof AccountV2
|
|
493
|
+
*/
|
|
494
|
+
'name'?: string | null;
|
|
495
|
+
/**
|
|
496
|
+
* The unique ID of the account as determined by the account schema.
|
|
497
|
+
* @type {string}
|
|
498
|
+
* @memberof AccountV2
|
|
499
|
+
*/
|
|
500
|
+
'uuid'?: string | null;
|
|
501
|
+
/**
|
|
502
|
+
* The unique ID of the account generated by the source system.
|
|
503
|
+
* @type {string}
|
|
504
|
+
* @memberof AccountV2
|
|
505
|
+
*/
|
|
506
|
+
'nativeIdentity'?: string | null;
|
|
507
|
+
/**
|
|
508
|
+
* A description of the account.
|
|
509
|
+
* @type {string}
|
|
510
|
+
* @memberof AccountV2
|
|
511
|
+
*/
|
|
512
|
+
'description'?: string | null;
|
|
513
|
+
/**
|
|
514
|
+
* The account type.
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof AccountV2
|
|
517
|
+
*/
|
|
518
|
+
'type'?: string | null;
|
|
519
|
+
/**
|
|
520
|
+
* Indicates if the account is currently disabled.
|
|
521
|
+
* @type {boolean}
|
|
522
|
+
* @memberof AccountV2
|
|
523
|
+
*/
|
|
524
|
+
'disabled'?: boolean;
|
|
525
|
+
/**
|
|
526
|
+
* Indicates if the account is currently locked.
|
|
527
|
+
* @type {boolean}
|
|
528
|
+
* @memberof AccountV2
|
|
529
|
+
*/
|
|
530
|
+
'locked'?: boolean;
|
|
531
|
+
/**
|
|
532
|
+
* Indicates if the account has entitlements.
|
|
533
|
+
* @type {boolean}
|
|
534
|
+
* @memberof AccountV2
|
|
535
|
+
*/
|
|
536
|
+
'hasEntitlements'?: boolean;
|
|
537
|
+
/**
|
|
538
|
+
* Indicates if the account has been manually correlated to an identity.
|
|
539
|
+
* @type {boolean}
|
|
540
|
+
* @memberof AccountV2
|
|
541
|
+
*/
|
|
542
|
+
'manuallyCorrelated'?: boolean;
|
|
543
|
+
/**
|
|
544
|
+
* Indicates if this account is correlated to an identity.
|
|
545
|
+
* @type {boolean}
|
|
546
|
+
* @memberof AccountV2
|
|
547
|
+
*/
|
|
548
|
+
'correlated'?: boolean;
|
|
549
|
+
/**
|
|
550
|
+
* Creation date of the account.
|
|
551
|
+
* @type {string}
|
|
552
|
+
* @memberof AccountV2
|
|
553
|
+
*/
|
|
554
|
+
'created'?: string | null;
|
|
555
|
+
/**
|
|
556
|
+
* Last modification date of the account.
|
|
557
|
+
* @type {string}
|
|
558
|
+
* @memberof AccountV2
|
|
559
|
+
*/
|
|
560
|
+
'modified'?: string | null;
|
|
561
|
+
/**
|
|
562
|
+
* Date the account was last synced to the search index.
|
|
563
|
+
* @type {string}
|
|
564
|
+
* @memberof AccountV2
|
|
565
|
+
*/
|
|
566
|
+
'synced'?: string | null;
|
|
567
|
+
/**
|
|
568
|
+
*
|
|
569
|
+
* @type {AccountV2Source}
|
|
570
|
+
* @memberof AccountV2
|
|
571
|
+
*/
|
|
572
|
+
'source'?: AccountV2Source | null;
|
|
573
|
+
/**
|
|
574
|
+
*
|
|
575
|
+
* @type {AccountV2Owner}
|
|
576
|
+
* @memberof AccountV2
|
|
577
|
+
*/
|
|
578
|
+
'owner'?: AccountV2Owner;
|
|
579
|
+
/**
|
|
580
|
+
* Identities who own this account. Never null; an empty array when the account has no owners.
|
|
581
|
+
* @type {Array<AccountV2Identity>}
|
|
582
|
+
* @memberof AccountV2
|
|
583
|
+
*/
|
|
584
|
+
'owners'?: Array<AccountV2Identity>;
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
* @type {AccountV2CorrelatedIdentity}
|
|
588
|
+
* @memberof AccountV2
|
|
589
|
+
*/
|
|
590
|
+
'correlatedIdentity'?: AccountV2CorrelatedIdentity;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {AccountV2Recommendation}
|
|
594
|
+
* @memberof AccountV2
|
|
595
|
+
*/
|
|
596
|
+
'recommendation'?: AccountV2Recommendation | null;
|
|
597
|
+
/**
|
|
598
|
+
*
|
|
599
|
+
* @type {AccountV2PrivilegeLevel}
|
|
600
|
+
* @memberof AccountV2
|
|
601
|
+
*/
|
|
602
|
+
'privilegeLevel'?: AccountV2PrivilegeLevel | null;
|
|
603
|
+
/**
|
|
604
|
+
* The account attributes that are aggregated.
|
|
605
|
+
* @type {{ [key: string]: any; }}
|
|
606
|
+
* @memberof AccountV2
|
|
607
|
+
*/
|
|
608
|
+
'attributes'?: {
|
|
609
|
+
[key: string]: any;
|
|
610
|
+
} | null;
|
|
611
|
+
/**
|
|
612
|
+
* The origin of the account, either aggregated or provisioned.
|
|
613
|
+
* @type {string}
|
|
614
|
+
* @memberof AccountV2
|
|
615
|
+
*/
|
|
616
|
+
'origin'?: AccountV2OriginEnum | null;
|
|
617
|
+
/**
|
|
618
|
+
* Method used to classify the account.
|
|
619
|
+
* @type {string}
|
|
620
|
+
* @memberof AccountV2
|
|
621
|
+
*/
|
|
622
|
+
'classificationMethod'?: AccountV2ClassificationMethodEnum | null;
|
|
623
|
+
/**
|
|
624
|
+
* The account subtype.
|
|
625
|
+
* @type {string}
|
|
626
|
+
* @memberof AccountV2
|
|
627
|
+
*/
|
|
628
|
+
'subType'?: string | null;
|
|
629
|
+
/**
|
|
630
|
+
* Correlated identities or machine identities associated with this account. Never null; an empty array when there are none.
|
|
631
|
+
* @type {Array<AccountV2CorrelatedEntity>}
|
|
632
|
+
* @memberof AccountV2
|
|
633
|
+
*/
|
|
634
|
+
'correlatedEntities'?: Array<AccountV2CorrelatedEntity>;
|
|
635
|
+
/**
|
|
636
|
+
* Capability features of the owning source for this account. Never null; empty when unset.
|
|
637
|
+
* @type {Array<string>}
|
|
638
|
+
* @memberof AccountV2
|
|
639
|
+
*/
|
|
640
|
+
'features'?: Array<string>;
|
|
641
|
+
}
|
|
642
|
+
export declare const AccountV2OriginEnum: {
|
|
643
|
+
readonly Aggregated: "AGGREGATED";
|
|
644
|
+
readonly Provisioned: "PROVISIONED";
|
|
645
|
+
};
|
|
646
|
+
export type AccountV2OriginEnum = typeof AccountV2OriginEnum[keyof typeof AccountV2OriginEnum];
|
|
647
|
+
export declare const AccountV2ClassificationMethodEnum: {
|
|
648
|
+
readonly Criteria: "CRITERIA";
|
|
649
|
+
readonly Source: "SOURCE";
|
|
650
|
+
readonly Discovery: "DISCOVERY";
|
|
651
|
+
readonly Manual: "MANUAL";
|
|
652
|
+
readonly ManuallyUnclassified: "MANUALLY_UNCLASSIFIED";
|
|
653
|
+
};
|
|
654
|
+
export type AccountV2ClassificationMethodEnum = typeof AccountV2ClassificationMethodEnum[keyof typeof AccountV2ClassificationMethodEnum];
|
|
655
|
+
/**
|
|
656
|
+
* A correlated identity or machine-identity associated with this account.
|
|
657
|
+
* @export
|
|
658
|
+
* @interface AccountV2CorrelatedEntity
|
|
659
|
+
*/
|
|
660
|
+
export interface AccountV2CorrelatedEntity {
|
|
661
|
+
/**
|
|
662
|
+
*
|
|
663
|
+
* @type {DtoType}
|
|
664
|
+
* @memberof AccountV2CorrelatedEntity
|
|
665
|
+
*/
|
|
666
|
+
'type'?: DtoType;
|
|
667
|
+
/**
|
|
668
|
+
* The unique ID of the correlated entity.
|
|
669
|
+
* @type {string}
|
|
670
|
+
* @memberof AccountV2CorrelatedEntity
|
|
671
|
+
*/
|
|
672
|
+
'id'?: string | null;
|
|
673
|
+
/**
|
|
674
|
+
* The display name of the correlated entity.
|
|
675
|
+
* @type {string}
|
|
676
|
+
* @memberof AccountV2CorrelatedEntity
|
|
677
|
+
*/
|
|
678
|
+
'name'?: string | null;
|
|
679
|
+
/**
|
|
680
|
+
* The identity state. Populated for IDENTITY entries only.
|
|
681
|
+
* @type {string}
|
|
682
|
+
* @memberof AccountV2CorrelatedEntity
|
|
683
|
+
*/
|
|
684
|
+
'state'?: string | null;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
*
|
|
688
|
+
* @export
|
|
689
|
+
* @interface AccountV2CorrelatedIdentity
|
|
690
|
+
*/
|
|
691
|
+
export interface AccountV2CorrelatedIdentity {
|
|
692
|
+
/**
|
|
693
|
+
* The unique ID of the identity.
|
|
694
|
+
* @type {string}
|
|
695
|
+
* @memberof AccountV2CorrelatedIdentity
|
|
696
|
+
*/
|
|
697
|
+
'id'?: string | null;
|
|
698
|
+
/**
|
|
699
|
+
* The DTO type of the identity.
|
|
700
|
+
* @type {string}
|
|
701
|
+
* @memberof AccountV2CorrelatedIdentity
|
|
702
|
+
*/
|
|
703
|
+
'type'?: AccountV2CorrelatedIdentityTypeEnum | null;
|
|
704
|
+
/**
|
|
705
|
+
* The display name of the identity.
|
|
706
|
+
* @type {string}
|
|
707
|
+
* @memberof AccountV2CorrelatedIdentity
|
|
708
|
+
*/
|
|
709
|
+
'name'?: string | null;
|
|
710
|
+
/**
|
|
711
|
+
* The identity state.
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof AccountV2CorrelatedIdentity
|
|
714
|
+
*/
|
|
715
|
+
'state'?: string | null;
|
|
716
|
+
}
|
|
717
|
+
export declare const AccountV2CorrelatedIdentityTypeEnum: {
|
|
718
|
+
readonly Identity: "IDENTITY";
|
|
719
|
+
};
|
|
720
|
+
export type AccountV2CorrelatedIdentityTypeEnum = typeof AccountV2CorrelatedIdentityTypeEnum[keyof typeof AccountV2CorrelatedIdentityTypeEnum];
|
|
721
|
+
/**
|
|
722
|
+
* An identity reference associated with this account.
|
|
723
|
+
* @export
|
|
724
|
+
* @interface AccountV2Identity
|
|
725
|
+
*/
|
|
726
|
+
export interface AccountV2Identity {
|
|
727
|
+
/**
|
|
728
|
+
* The unique ID of the identity.
|
|
729
|
+
* @type {string}
|
|
730
|
+
* @memberof AccountV2Identity
|
|
731
|
+
*/
|
|
732
|
+
'id'?: string | null;
|
|
733
|
+
/**
|
|
734
|
+
* The DTO type of the identity.
|
|
735
|
+
* @type {string}
|
|
736
|
+
* @memberof AccountV2Identity
|
|
737
|
+
*/
|
|
738
|
+
'type'?: AccountV2IdentityTypeEnum | null;
|
|
739
|
+
/**
|
|
740
|
+
* The display name of the identity.
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof AccountV2Identity
|
|
743
|
+
*/
|
|
744
|
+
'name'?: string | null;
|
|
745
|
+
/**
|
|
746
|
+
* The identity state.
|
|
747
|
+
* @type {string}
|
|
748
|
+
* @memberof AccountV2Identity
|
|
749
|
+
*/
|
|
750
|
+
'state'?: string | null;
|
|
751
|
+
}
|
|
752
|
+
export declare const AccountV2IdentityTypeEnum: {
|
|
753
|
+
readonly Identity: "IDENTITY";
|
|
754
|
+
};
|
|
755
|
+
export type AccountV2IdentityTypeEnum = typeof AccountV2IdentityTypeEnum[keyof typeof AccountV2IdentityTypeEnum];
|
|
756
|
+
/**
|
|
757
|
+
*
|
|
758
|
+
* @export
|
|
759
|
+
* @interface AccountV2Owner
|
|
760
|
+
*/
|
|
761
|
+
export interface AccountV2Owner {
|
|
762
|
+
/**
|
|
763
|
+
* The unique ID of the identity.
|
|
764
|
+
* @type {string}
|
|
765
|
+
* @memberof AccountV2Owner
|
|
766
|
+
*/
|
|
767
|
+
'id'?: string | null;
|
|
768
|
+
/**
|
|
769
|
+
* The DTO type of the identity.
|
|
770
|
+
* @type {string}
|
|
771
|
+
* @memberof AccountV2Owner
|
|
772
|
+
*/
|
|
773
|
+
'type'?: AccountV2OwnerTypeEnum | null;
|
|
774
|
+
/**
|
|
775
|
+
* The display name of the identity.
|
|
776
|
+
* @type {string}
|
|
777
|
+
* @memberof AccountV2Owner
|
|
778
|
+
*/
|
|
779
|
+
'name'?: string | null;
|
|
780
|
+
/**
|
|
781
|
+
* The identity state.
|
|
782
|
+
* @type {string}
|
|
783
|
+
* @memberof AccountV2Owner
|
|
784
|
+
*/
|
|
785
|
+
'state'?: string | null;
|
|
786
|
+
}
|
|
787
|
+
export declare const AccountV2OwnerTypeEnum: {
|
|
788
|
+
readonly Identity: "IDENTITY";
|
|
789
|
+
};
|
|
790
|
+
export type AccountV2OwnerTypeEnum = typeof AccountV2OwnerTypeEnum[keyof typeof AccountV2OwnerTypeEnum];
|
|
791
|
+
/**
|
|
792
|
+
* Effective privilege level of the account.
|
|
793
|
+
* @export
|
|
794
|
+
* @interface AccountV2PrivilegeLevel
|
|
795
|
+
*/
|
|
796
|
+
export interface AccountV2PrivilegeLevel {
|
|
797
|
+
/**
|
|
798
|
+
* The effective privilege level of the account.
|
|
799
|
+
* @type {string}
|
|
800
|
+
* @memberof AccountV2PrivilegeLevel
|
|
801
|
+
*/
|
|
802
|
+
'effective'?: string | null;
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* Indicates that the account is currently classified as one type but is recommended to be a different one.
|
|
806
|
+
* @export
|
|
807
|
+
* @interface AccountV2Recommendation
|
|
808
|
+
*/
|
|
809
|
+
export interface AccountV2Recommendation {
|
|
810
|
+
/**
|
|
811
|
+
* Recommended type of account.
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof AccountV2Recommendation
|
|
814
|
+
*/
|
|
815
|
+
'type'?: AccountV2RecommendationTypeEnum | null;
|
|
816
|
+
/**
|
|
817
|
+
* Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria.
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof AccountV2Recommendation
|
|
820
|
+
*/
|
|
821
|
+
'method'?: AccountV2RecommendationMethodEnum | null;
|
|
822
|
+
/**
|
|
823
|
+
* Ranked likelihood that this account is a machine account. Present when machine-account recommendation enrichment is available for the tenant.
|
|
824
|
+
* @type {number}
|
|
825
|
+
* @memberof AccountV2Recommendation
|
|
826
|
+
*/
|
|
827
|
+
'machineLikelihood'?: number | null;
|
|
828
|
+
/**
|
|
829
|
+
* Reasons supporting the machine-account recommendation. Never null; an empty array when no explanation is available.
|
|
830
|
+
* @type {Array<string>}
|
|
831
|
+
* @memberof AccountV2Recommendation
|
|
832
|
+
*/
|
|
833
|
+
'explanation'?: Array<string>;
|
|
834
|
+
}
|
|
835
|
+
export declare const AccountV2RecommendationTypeEnum: {
|
|
836
|
+
readonly Human: "HUMAN";
|
|
837
|
+
readonly Machine: "MACHINE";
|
|
838
|
+
};
|
|
839
|
+
export type AccountV2RecommendationTypeEnum = typeof AccountV2RecommendationTypeEnum[keyof typeof AccountV2RecommendationTypeEnum];
|
|
840
|
+
export declare const AccountV2RecommendationMethodEnum: {
|
|
841
|
+
readonly Discovery: "DISCOVERY";
|
|
842
|
+
readonly Source: "SOURCE";
|
|
843
|
+
readonly Criteria: "CRITERIA";
|
|
844
|
+
};
|
|
845
|
+
export type AccountV2RecommendationMethodEnum = typeof AccountV2RecommendationMethodEnum[keyof typeof AccountV2RecommendationMethodEnum];
|
|
846
|
+
/**
|
|
847
|
+
* The source this account belongs to.
|
|
848
|
+
* @export
|
|
849
|
+
* @interface AccountV2Source
|
|
850
|
+
*/
|
|
851
|
+
export interface AccountV2Source {
|
|
852
|
+
/**
|
|
853
|
+
* The unique ID of the source.
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof AccountV2Source
|
|
856
|
+
*/
|
|
857
|
+
'id'?: string | null;
|
|
858
|
+
/**
|
|
859
|
+
* The DTO type of the source.
|
|
860
|
+
* @type {string}
|
|
861
|
+
* @memberof AccountV2Source
|
|
862
|
+
*/
|
|
863
|
+
'type'?: AccountV2SourceTypeEnum | null;
|
|
864
|
+
/**
|
|
865
|
+
* The display name of the source.
|
|
866
|
+
* @type {string}
|
|
867
|
+
* @memberof AccountV2Source
|
|
868
|
+
*/
|
|
869
|
+
'name'?: string | null;
|
|
870
|
+
/**
|
|
871
|
+
* Indicates if this account is from an authoritative source.
|
|
872
|
+
* @type {boolean}
|
|
873
|
+
* @memberof AccountV2Source
|
|
874
|
+
*/
|
|
875
|
+
'authoritative'?: boolean;
|
|
876
|
+
/**
|
|
877
|
+
* The connection type of the source this account is from.
|
|
878
|
+
* @type {string}
|
|
879
|
+
* @memberof AccountV2Source
|
|
880
|
+
*/
|
|
881
|
+
'connectionType'?: string | null;
|
|
882
|
+
}
|
|
883
|
+
export declare const AccountV2SourceTypeEnum: {
|
|
884
|
+
readonly Source: "SOURCE";
|
|
885
|
+
};
|
|
886
|
+
export type AccountV2SourceTypeEnum = typeof AccountV2SourceTypeEnum[keyof typeof AccountV2SourceTypeEnum];
|
|
477
887
|
/**
|
|
478
888
|
* Accounts async response containing details on started async process
|
|
479
889
|
* @export
|
|
@@ -1121,6 +1531,20 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1121
1531
|
* @throws {RequiredError}
|
|
1122
1532
|
*/
|
|
1123
1533
|
listAccountsV1: (limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsV1DetailLevelEnum, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1534
|
+
/**
|
|
1535
|
+
* List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
|
|
1536
|
+
* @summary List accounts (search)
|
|
1537
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1538
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1539
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1540
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
1541
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw, isnull, pr* **uuid**: *eq, in, sw, isnull, pr* **nativeIdentity**: *eq, in, sw, isnull, pr* **description**: *eq, in, sw, isnull, pr* **type**: *eq, ne* **recommendation.type**: *eq, in, sw, isnull, pr* **recommendation.method**: *eq, in, sw, isnull, pr* **locked**: *eq* **disabled**: *eq* **hasEntitlements**: *eq* **manuallyCorrelated**: *eq* **privilegeLevel.effective**: *eq, in, isnull, pr* **correlated**: *eq* **classificationMethod**: *eq, ne, in, sw, isnull, pr* **subType**: *eq, ne, in, sw, isnull, pr* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **owner.id**: *eq, in, sw* **owner.name**: *eq, in, sw, isnull, pr* **owner.state**: *eq, in, sw, isnull, pr* **correlatedIdentity.id**: *eq, in, sw* **correlatedIdentity.name**: *eq, in, sw, isnull, pr* **correlatedIdentity.state**: *eq, in, sw, isnull, pr* **source.id**: *eq, in, sw* **source.name**: *eq, in, sw* **source.authoritative**: *eq* **source.connectionType**: *eq, in, isnull, pr* **origin**: *eq, in* Filter values are case-insensitive for **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Filter values remain case-sensitive for the identifier fields **id, uuid, nativeIdentity, source.id, owner.id, correlatedIdentity.id**.
|
|
1542
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, uuid, nativeIdentity, created, modified, manuallyCorrelated, description, type, recommendation.type, recommendation.method, locked, disabled, correlated, hasEntitlements, origin, privilegeLevel.effective, classificationMethod, subType, owner.id, owner.name, owner.state, correlatedIdentity.id, correlatedIdentity.name, correlatedIdentity.state, source.id, source.name, source.authoritative, source.connectionType, synced** Sorting on the following fields is case-insensitive: **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Identifier fields such as **id, uuid, nativeIdentity, source.id, owner.id,** and **correlatedIdentity.id** remain case-sensitive. Default sort is **created** when no collection parameters are sent.
|
|
1543
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1544
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1545
|
+
* @throws {RequiredError}
|
|
1546
|
+
*/
|
|
1547
|
+
listAccountsV2: (limit?: number, offset?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1124
1548
|
/**
|
|
1125
1549
|
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
1126
1550
|
* @summary Update account
|
|
@@ -1268,6 +1692,20 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
1268
1692
|
* @throws {RequiredError}
|
|
1269
1693
|
*/
|
|
1270
1694
|
listAccountsV1(limit?: number, offset?: number, count?: boolean, detailLevel?: ListAccountsV1DetailLevelEnum, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
1695
|
+
/**
|
|
1696
|
+
* List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
|
|
1697
|
+
* @summary List accounts (search)
|
|
1698
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1699
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1700
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1701
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
1702
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw, isnull, pr* **uuid**: *eq, in, sw, isnull, pr* **nativeIdentity**: *eq, in, sw, isnull, pr* **description**: *eq, in, sw, isnull, pr* **type**: *eq, ne* **recommendation.type**: *eq, in, sw, isnull, pr* **recommendation.method**: *eq, in, sw, isnull, pr* **locked**: *eq* **disabled**: *eq* **hasEntitlements**: *eq* **manuallyCorrelated**: *eq* **privilegeLevel.effective**: *eq, in, isnull, pr* **correlated**: *eq* **classificationMethod**: *eq, ne, in, sw, isnull, pr* **subType**: *eq, ne, in, sw, isnull, pr* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **owner.id**: *eq, in, sw* **owner.name**: *eq, in, sw, isnull, pr* **owner.state**: *eq, in, sw, isnull, pr* **correlatedIdentity.id**: *eq, in, sw* **correlatedIdentity.name**: *eq, in, sw, isnull, pr* **correlatedIdentity.state**: *eq, in, sw, isnull, pr* **source.id**: *eq, in, sw* **source.name**: *eq, in, sw* **source.authoritative**: *eq* **source.connectionType**: *eq, in, isnull, pr* **origin**: *eq, in* Filter values are case-insensitive for **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Filter values remain case-sensitive for the identifier fields **id, uuid, nativeIdentity, source.id, owner.id, correlatedIdentity.id**.
|
|
1703
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, uuid, nativeIdentity, created, modified, manuallyCorrelated, description, type, recommendation.type, recommendation.method, locked, disabled, correlated, hasEntitlements, origin, privilegeLevel.effective, classificationMethod, subType, owner.id, owner.name, owner.state, correlatedIdentity.id, correlatedIdentity.name, correlatedIdentity.state, source.id, source.name, source.authoritative, source.connectionType, synced** Sorting on the following fields is case-insensitive: **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Identifier fields such as **id, uuid, nativeIdentity, source.id, owner.id,** and **correlatedIdentity.id** remain case-sensitive. Default sort is **created** when no collection parameters are sent.
|
|
1704
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1705
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1706
|
+
* @throws {RequiredError}
|
|
1707
|
+
*/
|
|
1708
|
+
listAccountsV2(limit?: number, offset?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountV2>>>;
|
|
1271
1709
|
/**
|
|
1272
1710
|
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
1273
1711
|
* @summary Update account
|
|
@@ -1405,6 +1843,14 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
1405
1843
|
* @throws {RequiredError}
|
|
1406
1844
|
*/
|
|
1407
1845
|
listAccountsV1(requestParameters?: AccountsApiListAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Account>>;
|
|
1846
|
+
/**
|
|
1847
|
+
* List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
|
|
1848
|
+
* @summary List accounts (search)
|
|
1849
|
+
* @param {AccountsApiListAccountsV2Request} requestParameters Request parameters.
|
|
1850
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1851
|
+
* @throws {RequiredError}
|
|
1852
|
+
*/
|
|
1853
|
+
listAccountsV2(requestParameters?: AccountsApiListAccountsV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccountV2>>;
|
|
1408
1854
|
/**
|
|
1409
1855
|
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
1410
1856
|
* @summary Update account
|
|
@@ -1654,6 +2100,55 @@ export interface AccountsApiListAccountsV1Request {
|
|
|
1654
2100
|
*/
|
|
1655
2101
|
readonly sorters?: string;
|
|
1656
2102
|
}
|
|
2103
|
+
/**
|
|
2104
|
+
* Request parameters for listAccountsV2 operation in AccountsApi.
|
|
2105
|
+
* @export
|
|
2106
|
+
* @interface AccountsApiListAccountsV2Request
|
|
2107
|
+
*/
|
|
2108
|
+
export interface AccountsApiListAccountsV2Request {
|
|
2109
|
+
/**
|
|
2110
|
+
* Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2111
|
+
* @type {number}
|
|
2112
|
+
* @memberof AccountsApiListAccountsV2
|
|
2113
|
+
*/
|
|
2114
|
+
readonly limit?: number;
|
|
2115
|
+
/**
|
|
2116
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2117
|
+
* @type {number}
|
|
2118
|
+
* @memberof AccountsApiListAccountsV2
|
|
2119
|
+
*/
|
|
2120
|
+
readonly offset?: number;
|
|
2121
|
+
/**
|
|
2122
|
+
* 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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2123
|
+
* @type {boolean}
|
|
2124
|
+
* @memberof AccountsApiListAccountsV2
|
|
2125
|
+
*/
|
|
2126
|
+
readonly count?: boolean;
|
|
2127
|
+
/**
|
|
2128
|
+
* Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
2129
|
+
* @type {string}
|
|
2130
|
+
* @memberof AccountsApiListAccountsV2
|
|
2131
|
+
*/
|
|
2132
|
+
readonly searchAfter?: string;
|
|
2133
|
+
/**
|
|
2134
|
+
* Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw, isnull, pr* **uuid**: *eq, in, sw, isnull, pr* **nativeIdentity**: *eq, in, sw, isnull, pr* **description**: *eq, in, sw, isnull, pr* **type**: *eq, ne* **recommendation.type**: *eq, in, sw, isnull, pr* **recommendation.method**: *eq, in, sw, isnull, pr* **locked**: *eq* **disabled**: *eq* **hasEntitlements**: *eq* **manuallyCorrelated**: *eq* **privilegeLevel.effective**: *eq, in, isnull, pr* **correlated**: *eq* **classificationMethod**: *eq, ne, in, sw, isnull, pr* **subType**: *eq, ne, in, sw, isnull, pr* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **owner.id**: *eq, in, sw* **owner.name**: *eq, in, sw, isnull, pr* **owner.state**: *eq, in, sw, isnull, pr* **correlatedIdentity.id**: *eq, in, sw* **correlatedIdentity.name**: *eq, in, sw, isnull, pr* **correlatedIdentity.state**: *eq, in, sw, isnull, pr* **source.id**: *eq, in, sw* **source.name**: *eq, in, sw* **source.authoritative**: *eq* **source.connectionType**: *eq, in, isnull, pr* **origin**: *eq, in* Filter values are case-insensitive for **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Filter values remain case-sensitive for the identifier fields **id, uuid, nativeIdentity, source.id, owner.id, correlatedIdentity.id**.
|
|
2135
|
+
* @type {string}
|
|
2136
|
+
* @memberof AccountsApiListAccountsV2
|
|
2137
|
+
*/
|
|
2138
|
+
readonly filters?: string;
|
|
2139
|
+
/**
|
|
2140
|
+
* Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, uuid, nativeIdentity, created, modified, manuallyCorrelated, description, type, recommendation.type, recommendation.method, locked, disabled, correlated, hasEntitlements, origin, privilegeLevel.effective, classificationMethod, subType, owner.id, owner.name, owner.state, correlatedIdentity.id, correlatedIdentity.name, correlatedIdentity.state, source.id, source.name, source.authoritative, source.connectionType, synced** Sorting on the following fields is case-insensitive: **name, description, type, origin, source.name, source.connectionType, owner.name, correlatedIdentity.name, correlatedIdentity.state, privilegeLevel.effective, recommendation.type, recommendation.method, classificationMethod, subType**. Identifier fields such as **id, uuid, nativeIdentity, source.id, owner.id,** and **correlatedIdentity.id** remain case-sensitive. Default sort is **created** when no collection parameters are sent.
|
|
2141
|
+
* @type {string}
|
|
2142
|
+
* @memberof AccountsApiListAccountsV2
|
|
2143
|
+
*/
|
|
2144
|
+
readonly sorters?: string;
|
|
2145
|
+
/**
|
|
2146
|
+
* Use this header to enable this experimental API.
|
|
2147
|
+
* @type {string}
|
|
2148
|
+
* @memberof AccountsApiListAccountsV2
|
|
2149
|
+
*/
|
|
2150
|
+
readonly xSailPointExperimental?: string;
|
|
2151
|
+
}
|
|
1657
2152
|
/**
|
|
1658
2153
|
* Request parameters for putAccountV1 operation in AccountsApi.
|
|
1659
2154
|
* @export
|
|
@@ -1839,6 +2334,15 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
1839
2334
|
* @memberof AccountsApi
|
|
1840
2335
|
*/
|
|
1841
2336
|
listAccountsV1(requestParameters?: AccountsApiListAccountsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
|
|
2337
|
+
/**
|
|
2338
|
+
* List accounts from the accounts search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information.
|
|
2339
|
+
* @summary List accounts (search)
|
|
2340
|
+
* @param {AccountsApiListAccountsV2Request} requestParameters Request parameters.
|
|
2341
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2342
|
+
* @throws {RequiredError}
|
|
2343
|
+
* @memberof AccountsApi
|
|
2344
|
+
*/
|
|
2345
|
+
listAccountsV2(requestParameters?: AccountsApiListAccountsV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountV2[], any>>;
|
|
1842
2346
|
/**
|
|
1843
2347
|
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
1844
2348
|
* @summary Update account
|