sailpoint-api-client 2.0.2 → 2.0.4

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.
Files changed (119) hide show
  1. package/access_model_metadata/docs/Methods/AccessModelMetadataApi.md +11 -11
  2. package/access_profiles/docs/Methods/AccessProfilesApi.md +8 -8
  3. package/access_request_approvals/docs/Methods/AccessRequestApprovalsApi.md +7 -7
  4. package/access_request_identity_metrics/docs/Methods/AccessRequestIdentityMetricsApi.md +1 -1
  5. package/access_requests/docs/Methods/AccessRequestsApi.md +13 -13
  6. package/account_activities/docs/Methods/AccountActivitiesApi.md +2 -2
  7. package/account_aggregations/docs/Methods/AccountAggregationsApi.md +1 -1
  8. package/account_deletion_requests/docs/Methods/AccountDeletionRequestsApi.md +2 -2
  9. package/account_usages/docs/Methods/AccountUsagesApi.md +1 -1
  10. package/accounts/docs/Methods/AccountsApi.md +16 -16
  11. package/api_usage/docs/Methods/ApiUsageApi.md +2 -2
  12. package/application_discovery/docs/Methods/ApplicationDiscoveryApi.md +4 -4
  13. package/approvals/docs/Methods/ApprovalsApi.md +15 -15
  14. package/apps/docs/Methods/AppsApi.md +14 -14
  15. package/auth_profile/docs/Methods/AuthProfileApi.md +3 -3
  16. package/auth_users/docs/Methods/AuthUsersApi.md +2 -2
  17. package/branding/docs/Methods/BrandingApi.md +5 -5
  18. package/certification_campaign_filters/docs/Methods/CertificationCampaignFiltersApi.md +5 -5
  19. package/certification_campaigns/docs/Methods/CertificationCampaignsApi.md +22 -22
  20. package/certification_summaries/docs/Methods/CertificationSummariesApi.md +4 -4
  21. package/certifications/docs/Methods/CertificationsApi.md +11 -11
  22. package/classify_source/docs/Methods/ClassifySourceApi.md +3 -3
  23. package/configuration_hub/docs/Methods/ConfigurationHubApi.md +20 -20
  24. package/connector_customizers/docs/Methods/ConnectorCustomizersApi.md +6 -6
  25. package/connector_rule_management/docs/Methods/ConnectorRuleManagementApi.md +6 -6
  26. package/connectors/docs/Methods/ConnectorsApi.md +13 -13
  27. package/custom_forms/docs/Methods/CustomFormsApi.md +18 -18
  28. package/custom_password_instructions/docs/Methods/CustomPasswordInstructionsApi.md +3 -3
  29. package/custom_user_levels/docs/Methods/CustomUserLevelsApi.md +9 -9
  30. package/data_access_security/docs/Methods/DataAccessSecurityApi.md +25 -25
  31. package/data_segmentation/docs/Methods/DataSegmentationApi.md +8 -8
  32. package/declassify_source/docs/Methods/DeclassifySourceApi.md +1 -1
  33. package/dimensions/docs/Methods/DimensionsApi.md +8 -8
  34. package/dist/nerm/common.js +2 -2
  35. package/dist/nermv2025/common.js +2 -2
  36. package/entitlement_connections/docs/Methods/EntitlementConnectionsApi.md +5 -5
  37. package/entitlements/docs/Methods/EntitlementsApi.md +13 -13
  38. package/global_tenant_security_settings/docs/Methods/GlobalTenantSecuritySettingsApi.md +9 -9
  39. package/governance_groups/docs/Methods/GovernanceGroupsApi.md +10 -10
  40. package/iai_access_request_recommendations/docs/Methods/IAIAccessRequestRecommendationsApi.md +10 -10
  41. package/iai_common_access/docs/Methods/IAICommonAccessApi.md +3 -3
  42. package/iai_outliers/docs/Methods/IAIOutliersApi.md +9 -9
  43. package/iai_peer_group_strategies/docs/Methods/IAIPeerGroupStrategiesApi.md +1 -1
  44. package/iai_recommendations/docs/Methods/IAIRecommendationsApi.md +3 -3
  45. package/iai_role_mining/docs/Methods/IAIRoleMiningApi.md +25 -25
  46. package/icons/docs/Methods/IconsApi.md +2 -2
  47. package/identities/docs/Methods/IdentitiesApi.md +12 -12
  48. package/identity_attributes/docs/Methods/IdentityAttributesApi.md +6 -6
  49. package/identity_history/docs/Methods/IdentityHistoryApi.md +11 -11
  50. package/identity_profiles/docs/Methods/IdentityProfilesApi.md +11 -11
  51. package/jit_access/docs/Methods/JITAccessApi.md +2 -2
  52. package/jit_activations/docs/Methods/JITActivationsApi.md +3 -3
  53. package/launchers/docs/Methods/LaunchersApi.md +6 -6
  54. package/lifecycle_states/docs/Methods/LifecycleStatesApi.md +6 -6
  55. package/machine_account_classify/docs/Methods/MachineAccountClassifyApi.md +1 -1
  56. package/machine_account_creation_request/docs/Methods/MachineAccountCreationRequestApi.md +3 -3
  57. package/machine_account_mappings/docs/Methods/MachineAccountMappingsApi.md +4 -4
  58. package/machine_account_subtypes/docs/Methods/MachineAccountSubtypesApi.md +8 -8
  59. package/machine_accounts/docs/Methods/MachineAccountsApi.md +9 -9
  60. package/machine_classification_config/docs/Methods/MachineClassificationConfigApi.md +3 -3
  61. package/machine_identities/docs/Methods/MachineIdentitiesApi.md +7 -7
  62. package/managed_clients/docs/Methods/ManagedClientsApi.md +7 -7
  63. package/managed_cluster_types/docs/Methods/ManagedClusterTypesApi.md +5 -5
  64. package/managed_clusters/docs/Methods/ManagedClustersApi.md +8 -8
  65. package/mfa_configuration/docs/Methods/MFAConfigurationApi.md +7 -7
  66. package/multi_host_integration/docs/Methods/MultiHostIntegrationApi.md +14 -14
  67. package/nerm/README.md +2 -2
  68. package/nerm/common.ts +2 -2
  69. package/nerm/package.json +1 -1
  70. package/nermv2025/README.md +2 -2
  71. package/nermv2025/common.ts +2 -2
  72. package/nermv2025/package.json +1 -1
  73. package/non_employee_lifecycle_management/docs/Methods/NonEmployeeLifecycleManagementApi.md +32 -32
  74. package/notifications/docs/Methods/NotificationsApi.md +16 -16
  75. package/oauth_clients/docs/Methods/OAuthClientsApi.md +5 -5
  76. package/org_config/docs/Methods/OrgConfigApi.md +3 -3
  77. package/package.json +1 -1
  78. package/parameter_storage/docs/Methods/ParameterStorageApi.md +8 -8
  79. package/password_configuration/docs/Methods/PasswordConfigurationApi.md +3 -3
  80. package/password_dictionary/docs/Methods/PasswordDictionaryApi.md +2 -2
  81. package/password_management/docs/Methods/PasswordManagementApi.md +4 -4
  82. package/password_policies/docs/Methods/PasswordPoliciesApi.md +5 -5
  83. package/password_sync_groups/docs/Methods/PasswordSyncGroupsApi.md +5 -5
  84. package/personal_access_tokens/docs/Methods/PersonalAccessTokensApi.md +4 -4
  85. package/privilege_criteria/docs/Methods/PrivilegeCriteriaApi.md +5 -5
  86. package/privilege_criteria_configuration/docs/Methods/PrivilegeCriteriaConfigurationApi.md +3 -3
  87. package/prompt_insights/docs/Methods/PromptInsightsApi.md +2 -2
  88. package/public_identities/docs/Methods/PublicIdentitiesApi.md +1 -1
  89. package/public_identities_config/docs/Methods/PublicIdentitiesConfigApi.md +2 -2
  90. package/reports_data_extraction/docs/Methods/ReportsDataExtractionApi.md +4 -4
  91. package/requestable_objects/docs/Methods/RequestableObjectsApi.md +1 -1
  92. package/role_insights/docs/Methods/RoleInsightsApi.md +9 -9
  93. package/role_propagation/docs/Methods/RolePropagationApi.md +6 -6
  94. package/roles/docs/Methods/RolesApi.md +16 -16
  95. package/saved_search/docs/Methods/SavedSearchApi.md +6 -6
  96. package/scheduled_search/docs/Methods/ScheduledSearchApi.md +6 -6
  97. package/search/docs/Methods/SearchApi.md +4 -4
  98. package/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationApi.md +5 -5
  99. package/segments/docs/Methods/SegmentsApi.md +5 -5
  100. package/service_desk_integration/docs/Methods/ServiceDeskIntegrationApi.md +10 -10
  101. package/shared_signals_framework_ssf/docs/Methods/SharedSignalsFrameworkSSFApi.md +10 -10
  102. package/sim_integrations/docs/Methods/SIMIntegrationsApi.md +7 -7
  103. package/sod_policies/docs/Methods/SODPoliciesApi.md +17 -17
  104. package/sod_violations/docs/Methods/SODViolationsApi.md +2 -2
  105. package/source_usages/docs/Methods/SourceUsagesApi.md +2 -2
  106. package/sources/docs/Methods/SourcesApi.md +56 -56
  107. package/sp_config/docs/Methods/SPConfigApi.md +7 -7
  108. package/suggested_entitlement_description/docs/Methods/SuggestedEntitlementDescriptionApi.md +15 -15
  109. package/tagged_objects/docs/Methods/TaggedObjectsApi.md +8 -8
  110. package/tags/docs/Methods/TagsApi.md +4 -4
  111. package/task_management/docs/Methods/TaskManagementApi.md +3 -3
  112. package/tenant/docs/Methods/TenantApi.md +1 -1
  113. package/tenant_context/docs/Methods/TenantContextApi.md +2 -2
  114. package/transforms/docs/Methods/TransformsApi.md +5 -5
  115. package/triggers/docs/Methods/TriggersApi.md +10 -10
  116. package/ui_metadata/docs/Methods/UIMetadataApi.md +2 -2
  117. package/work_items/docs/Methods/WorkItemsApi.md +13 -13
  118. package/work_reassignment/docs/Methods/WorkReassignmentApi.md +9 -9
  119. package/workflows/docs/Methods/WorkflowsApi.md +19 -19
@@ -34,7 +34,7 @@ This API is currently in an experimental state. The API is subject to change bas
34
34
  Terminate Role Propagation process
35
35
  This endpoint terminates the ongoing role change propagation process for a tenant.
36
36
 
37
- [API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-role-propagation-v1)
37
+ [API Spec](https://developer.sailpoint.com/docs/api/cancel-role-propagation-v-1)
38
38
 
39
39
  ### Parameters
40
40
 
@@ -74,7 +74,7 @@ This API is currently in an experimental state. The API is subject to change bas
74
74
  Get ongoing Role Propagation process
75
75
  This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated.
76
76
 
77
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-ongoing-role-propagation-v1)
77
+ [API Spec](https://developer.sailpoint.com/docs/api/get-ongoing-role-propagation-v-1)
78
78
 
79
79
  ### Parameters
80
80
 
@@ -114,7 +114,7 @@ This API is currently in an experimental state. The API is subject to change bas
114
114
  Get Role Change Propagation Configuration
115
115
  This endpoint fetches the Role Change Propagation Configuration for the tenant
116
116
 
117
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-propagation-config-v1)
117
+ [API Spec](https://developer.sailpoint.com/docs/api/get-role-propagation-config-v-1)
118
118
 
119
119
  ### Parameters
120
120
 
@@ -160,7 +160,7 @@ This endpoint returns the information of the specified role change propagation p
160
160
  - FAILED - The role propagation process has failed.
161
161
  - TERMINATED - The role propagation process was externally terminated.
162
162
 
163
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-propagation-status-v1)
163
+ [API Spec](https://developer.sailpoint.com/docs/api/get-role-propagation-status-v-1)
164
164
 
165
165
  ### Parameters
166
166
 
@@ -202,7 +202,7 @@ This API is currently in an experimental state. The API is subject to change bas
202
202
  Update Role Change Propagation Configuration
203
203
  This endpoint enables or disables the Role Change Propagation Process for the tenant
204
204
 
205
- [API Spec](https://developer.sailpoint.com/docs/api/v1/set-role-propagation-config-v1)
205
+ [API Spec](https://developer.sailpoint.com/docs/api/set-role-propagation-config-v-1)
206
206
 
207
207
  ### Parameters
208
208
 
@@ -245,7 +245,7 @@ Initiate Role Propagation process
245
245
  This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status.
246
246
  API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant
247
247
 
248
- [API Spec](https://developer.sailpoint.com/docs/api/v1/start-role-propagation-v1)
248
+ [API Spec](https://developer.sailpoint.com/docs/api/start-role-propagation-v-1)
249
249
 
250
250
  ### Parameters
251
251
 
@@ -80,7 +80,7 @@ In addition, a ROLE_SUBADMIN may not create a role including an access profile i
80
80
 
81
81
  The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
82
82
 
83
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-role-v1)
83
+ [API Spec](https://developer.sailpoint.com/docs/api/create-role-v-1)
84
84
 
85
85
  ### Parameters
86
86
 
@@ -120,7 +120,7 @@ When the request is successful, the endpoint returns the bulk delete's task resu
120
120
  This endpoint can only bulk delete up to a limit of 50 roles per request.
121
121
  A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of.
122
122
 
123
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-bulk-roles-v1)
123
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-bulk-roles-v-1)
124
124
 
125
125
  ### Parameters
126
126
 
@@ -157,7 +157,7 @@ console.log(result);
157
157
  Remove a metadata from role.
158
158
  This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
159
159
 
160
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-metadata-from-role-by-key-and-value-v1)
160
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-metadata-from-role-by-key-and-value-v-1)
161
161
 
162
162
  ### Parameters
163
163
 
@@ -200,7 +200,7 @@ This API deletes a Role by its ID.
200
200
 
201
201
  A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
202
202
 
203
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-role-v1)
203
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-role-v-1)
204
204
 
205
205
  ### Parameters
206
206
 
@@ -239,7 +239,7 @@ Get bulk-update status by id
239
239
  This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process.
240
240
  A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
241
241
 
242
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-bulk-update-status-by-id-v1)
242
+ [API Spec](https://developer.sailpoint.com/docs/api/get-bulk-update-status-by-id-v-1)
243
243
 
244
244
  ### Parameters
245
245
 
@@ -276,7 +276,7 @@ console.log(result);
276
276
  Get bulk-update statuses
277
277
  This API returns a list of all unfinished bulk update process status of the tenant.
278
278
 
279
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-bulk-update-status-v1)
279
+ [API Spec](https://developer.sailpoint.com/docs/api/get-bulk-update-status-v-1)
280
280
 
281
281
  ### Parameters
282
282
 
@@ -309,7 +309,7 @@ console.log(result);
309
309
  List identities assigned a role
310
310
 
311
311
 
312
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-assigned-identities-v1)
312
+ [API Spec](https://developer.sailpoint.com/docs/api/get-role-assigned-identities-v-1)
313
313
 
314
314
  ### Parameters
315
315
 
@@ -359,7 +359,7 @@ This API is currently in an experimental state. The API is subject to change bas
359
359
  List role\'s entitlements
360
360
  Get a list of entitlements associated with a specified role.
361
361
 
362
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-entitlements-v1)
362
+ [API Spec](https://developer.sailpoint.com/docs/api/get-role-entitlements-v-1)
363
363
 
364
364
  ### Parameters
365
365
 
@@ -409,7 +409,7 @@ Get a role
409
409
  This API returns a Role by its ID.
410
410
  A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
411
411
 
412
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-v1)
412
+ [API Spec](https://developer.sailpoint.com/docs/api/get-role-v-1)
413
413
 
414
414
  ### Parameters
415
415
 
@@ -448,7 +448,7 @@ This API returns a list of Roles.
448
448
 
449
449
  A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
450
450
 
451
- [API Spec](https://developer.sailpoint.com/docs/api/v1/list-roles-v1)
451
+ [API Spec](https://developer.sailpoint.com/docs/api/list-roles-v-1)
452
452
 
453
453
  ### Parameters
454
454
 
@@ -520,7 +520,7 @@ The maximum supported length for the description field is 2000 characters. Longe
520
520
 
521
521
  When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
522
522
 
523
- [API Spec](https://developer.sailpoint.com/docs/api/v1/patch-role-v1)
523
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-role-v-1)
524
524
 
525
525
  ### Parameters
526
526
 
@@ -560,7 +560,7 @@ Filter roles by metadata
560
560
  This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values.
561
561
  A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API.
562
562
 
563
- [API Spec](https://developer.sailpoint.com/docs/api/v1/search-roles-by-filter-v1)
563
+ [API Spec](https://developer.sailpoint.com/docs/api/search-roles-by-filter-v-1)
564
564
 
565
565
  ### Parameters
566
566
 
@@ -611,7 +611,7 @@ console.log(result);
611
611
  Add a metadata to role.
612
612
  This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed.
613
613
 
614
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-attribute-key-and-value-to-role-v1)
614
+ [API Spec](https://developer.sailpoint.com/docs/api/update-attribute-key-and-value-to-role-v-1)
615
615
 
616
616
  ### Parameters
617
617
 
@@ -655,7 +655,7 @@ A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call t
655
655
  The maximum metadata value count for a single role is 25.
656
656
  Custom metadata update, including add, replace need suit licensed.
657
657
 
658
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-roles-metadata-by-filter-v1)
658
+ [API Spec](https://developer.sailpoint.com/docs/api/update-roles-metadata-by-filter-v-1)
659
659
 
660
660
  ### Parameters
661
661
 
@@ -695,7 +695,7 @@ A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call t
695
695
  The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25.
696
696
  Custom metadata update, including add, replace need suit licensed.
697
697
 
698
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-roles-metadata-by-ids-v1)
698
+ [API Spec](https://developer.sailpoint.com/docs/api/update-roles-metadata-by-ids-v-1)
699
699
 
700
700
  ### Parameters
701
701
 
@@ -735,7 +735,7 @@ A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call t
735
735
  The maximum metadata value count for a single role is 25.
736
736
  Custom metadata update, including add, replace need suit licensed.
737
737
 
738
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-roles-metadata-by-query-v1)
738
+ [API Spec](https://developer.sailpoint.com/docs/api/update-roles-metadata-by-query-v-1)
739
739
 
740
740
  ### Parameters
741
741
 
@@ -38,7 +38,7 @@ Create a saved search
38
38
  Creates a new saved search.
39
39
 
40
40
 
41
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-saved-search-v1)
41
+ [API Spec](https://developer.sailpoint.com/docs/api/create-saved-search-v-1)
42
42
 
43
43
  ### Parameters
44
44
 
@@ -76,7 +76,7 @@ Delete document by id
76
76
  Deletes the specified saved search.
77
77
 
78
78
 
79
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-saved-search-v1)
79
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-saved-search-v-1)
80
80
 
81
81
  ### Parameters
82
82
 
@@ -114,7 +114,7 @@ Execute a saved search by id
114
114
  Executes the specified saved search.
115
115
 
116
116
 
117
- [API Spec](https://developer.sailpoint.com/docs/api/v1/execute-saved-search-v1)
117
+ [API Spec](https://developer.sailpoint.com/docs/api/execute-saved-search-v-1)
118
118
 
119
119
  ### Parameters
120
120
 
@@ -154,7 +154,7 @@ Return saved search by id
154
154
  Returns the specified saved search.
155
155
 
156
156
 
157
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-saved-search-v1)
157
+ [API Spec](https://developer.sailpoint.com/docs/api/get-saved-search-v-1)
158
158
 
159
159
  ### Parameters
160
160
 
@@ -192,7 +192,7 @@ A list of saved searches
192
192
  Returns a list of saved searches.
193
193
 
194
194
 
195
- [API Spec](https://developer.sailpoint.com/docs/api/v1/list-saved-searches-v1)
195
+ [API Spec](https://developer.sailpoint.com/docs/api/list-saved-searches-v-1)
196
196
 
197
197
  ### Parameters
198
198
 
@@ -238,7 +238,7 @@ Updates an existing saved search.
238
238
  >**NOTE: You cannot update the `owner` of the saved search.**
239
239
 
240
240
 
241
- [API Spec](https://developer.sailpoint.com/docs/api/v1/put-saved-search-v1)
241
+ [API Spec](https://developer.sailpoint.com/docs/api/put-saved-search-v-1)
242
242
 
243
243
  ### Parameters
244
244
 
@@ -54,7 +54,7 @@ Create a new scheduled search
54
54
  Creates a new scheduled search.
55
55
 
56
56
 
57
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-scheduled-search-v1)
57
+ [API Spec](https://developer.sailpoint.com/docs/api/create-scheduled-search-v-1)
58
58
 
59
59
  ### Parameters
60
60
 
@@ -92,7 +92,7 @@ Delete a scheduled search
92
92
  Deletes the specified scheduled search.
93
93
 
94
94
 
95
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-scheduled-search-v1)
95
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-scheduled-search-v-1)
96
96
 
97
97
  ### Parameters
98
98
 
@@ -129,7 +129,7 @@ console.log(result);
129
129
  Get a scheduled search
130
130
  Returns the specified scheduled search.
131
131
 
132
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-scheduled-search-v1)
132
+ [API Spec](https://developer.sailpoint.com/docs/api/get-scheduled-search-v-1)
133
133
 
134
134
  ### Parameters
135
135
 
@@ -167,7 +167,7 @@ List scheduled searches
167
167
  Returns a list of scheduled searches.
168
168
 
169
169
 
170
- [API Spec](https://developer.sailpoint.com/docs/api/v1/list-scheduled-search-v1)
170
+ [API Spec](https://developer.sailpoint.com/docs/api/list-scheduled-search-v-1)
171
171
 
172
172
  ### Parameters
173
173
 
@@ -211,7 +211,7 @@ Unsubscribe a recipient from scheduled search
211
211
  Unsubscribes a recipient from the specified scheduled search.
212
212
 
213
213
 
214
- [API Spec](https://developer.sailpoint.com/docs/api/v1/unsubscribe-scheduled-search-v1)
214
+ [API Spec](https://developer.sailpoint.com/docs/api/unsubscribe-scheduled-search-v-1)
215
215
 
216
216
  ### Parameters
217
217
 
@@ -251,7 +251,7 @@ Update an existing scheduled search
251
251
  Updates an existing scheduled search.
252
252
 
253
253
 
254
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-scheduled-search-v1)
254
+ [API Spec](https://developer.sailpoint.com/docs/api/update-scheduled-search-v-1)
255
255
 
256
256
  ### Parameters
257
257
 
@@ -48,7 +48,7 @@ Method | HTTP request | Description
48
48
  Perform a search query aggregation
49
49
  Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. 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.
50
50
 
51
- [API Spec](https://developer.sailpoint.com/docs/api/v1/search-aggregate-v1)
51
+ [API Spec](https://developer.sailpoint.com/docs/api/search-aggregate-v-1)
52
52
 
53
53
  ### Parameters
54
54
 
@@ -91,7 +91,7 @@ console.log(result);
91
91
  Count documents satisfying a query
92
92
  Performs a search with a provided query and returns the count of results in the X-Total-Count header.
93
93
 
94
- [API Spec](https://developer.sailpoint.com/docs/api/v1/search-count-v1)
94
+ [API Spec](https://developer.sailpoint.com/docs/api/search-count-v-1)
95
95
 
96
96
  ### Parameters
97
97
 
@@ -128,7 +128,7 @@ console.log(result);
128
128
  Get a document by id
129
129
  Fetches a single document from the specified index, using the specified document ID.
130
130
 
131
- [API Spec](https://developer.sailpoint.com/docs/api/v1/search-get-v1)
131
+ [API Spec](https://developer.sailpoint.com/docs/api/search-get-v-1)
132
132
 
133
133
  ### Parameters
134
134
 
@@ -167,7 +167,7 @@ console.log(result);
167
167
  Perform search
168
168
  Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. 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. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists).
169
169
 
170
- [API Spec](https://developer.sailpoint.com/docs/api/v1/search-post-v1)
170
+ [API Spec](https://developer.sailpoint.com/docs/api/search-post-v-1)
171
171
 
172
172
  ### Parameters
173
173
 
@@ -48,7 +48,7 @@ Create extended search attributes
48
48
  Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig.
49
49
  >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.**
50
50
 
51
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-search-attribute-config-v1)
51
+ [API Spec](https://developer.sailpoint.com/docs/api/create-search-attribute-config-v-1)
52
52
 
53
53
  ### Parameters
54
54
 
@@ -90,7 +90,7 @@ This API is currently in an experimental state. The API is subject to change bas
90
90
  Delete extended search attribute
91
91
  Delete an extended attribute configuration by name.
92
92
 
93
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-search-attribute-config-v1)
93
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-search-attribute-config-v-1)
94
94
 
95
95
  ### Parameters
96
96
 
@@ -132,7 +132,7 @@ This API is currently in an experimental state. The API is subject to change bas
132
132
  List extended search attributes
133
133
  Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
134
134
 
135
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-search-attribute-config-v1)
135
+ [API Spec](https://developer.sailpoint.com/docs/api/get-search-attribute-config-v-1)
136
136
 
137
137
  ### Parameters
138
138
 
@@ -176,7 +176,7 @@ This API is currently in an experimental state. The API is subject to change bas
176
176
  Get extended search attribute
177
177
  Get an extended attribute configuration by name.
178
178
 
179
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-single-search-attribute-config-v1)
179
+ [API Spec](https://developer.sailpoint.com/docs/api/get-single-search-attribute-config-v-1)
180
180
 
181
181
  ### Parameters
182
182
 
@@ -220,7 +220,7 @@ Update an existing search attribute configuration.
220
220
  You can patch these fields:
221
221
  * name * displayName * applicationAttributes
222
222
 
223
- [API Spec](https://developer.sailpoint.com/docs/api/v1/patch-search-attribute-config-v1)
223
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-search-attribute-config-v-1)
224
224
 
225
225
  ### Parameters
226
226
 
@@ -44,7 +44,7 @@ Create segment
44
44
  This API creates a segment.
45
45
  >**Note:** Segment definitions may take time to propagate to all identities.
46
46
 
47
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-segment-v1)
47
+ [API Spec](https://developer.sailpoint.com/docs/api/create-segment-v-1)
48
48
 
49
49
  ### Parameters
50
50
 
@@ -82,7 +82,7 @@ Delete segment by id
82
82
  This API deletes the segment specified by the given ID.
83
83
  >**Note:** that segment deletion may take some time to become effective.
84
84
 
85
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-segment-v1)
85
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-segment-v-1)
86
86
 
87
87
  ### Parameters
88
88
 
@@ -119,7 +119,7 @@ console.log(result);
119
119
  Get segment by id
120
120
  This API returns the segment specified by the given ID.
121
121
 
122
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-segment-v1)
122
+ [API Spec](https://developer.sailpoint.com/docs/api/get-segment-v-1)
123
123
 
124
124
  ### Parameters
125
125
 
@@ -156,7 +156,7 @@ console.log(result);
156
156
  List segments
157
157
  This API returns a list of all segments.
158
158
 
159
- [API Spec](https://developer.sailpoint.com/docs/api/v1/list-segments-v1)
159
+ [API Spec](https://developer.sailpoint.com/docs/api/list-segments-v-1)
160
160
 
161
161
  ### Parameters
162
162
 
@@ -198,7 +198,7 @@ Update segment
198
198
  Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
199
199
  >**Note:** Changes to a segment may take some time to propagate to all identities.
200
200
 
201
- [API Spec](https://developer.sailpoint.com/docs/api/v1/patch-segment-v1)
201
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-segment-v-1)
202
202
 
203
203
  ### Parameters
204
204
 
@@ -55,7 +55,7 @@ Method | HTTP request | Description
55
55
  Create new service desk integration
56
56
  Create a new Service Desk integration.
57
57
 
58
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-service-desk-integration-v1)
58
+ [API Spec](https://developer.sailpoint.com/docs/api/create-service-desk-integration-v-1)
59
59
 
60
60
  ### Parameters
61
61
 
@@ -92,7 +92,7 @@ console.log(result);
92
92
  Delete a service desk integration
93
93
  Delete an existing Service Desk integration by ID.
94
94
 
95
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-service-desk-integration-v1)
95
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-service-desk-integration-v-1)
96
96
 
97
97
  ### Parameters
98
98
 
@@ -129,7 +129,7 @@ console.log(result);
129
129
  Service desk integration template by scriptname
130
130
  This API endpoint returns an existing Service Desk integration template by scriptName.
131
131
 
132
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integration-template-v1)
132
+ [API Spec](https://developer.sailpoint.com/docs/api/get-service-desk-integration-template-v-1)
133
133
 
134
134
  ### Parameters
135
135
 
@@ -166,7 +166,7 @@ console.log(result);
166
166
  List service desk integration types
167
167
  This API endpoint returns the current list of supported Service Desk integration types.
168
168
 
169
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integration-types-v1)
169
+ [API Spec](https://developer.sailpoint.com/docs/api/get-service-desk-integration-types-v-1)
170
170
 
171
171
  ### Parameters
172
172
 
@@ -199,7 +199,7 @@ console.log(result);
199
199
  Get a service desk integration
200
200
  Get an existing Service Desk integration by ID.
201
201
 
202
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integration-v1)
202
+ [API Spec](https://developer.sailpoint.com/docs/api/get-service-desk-integration-v-1)
203
203
 
204
204
  ### Parameters
205
205
 
@@ -236,7 +236,7 @@ console.log(result);
236
236
  List existing service desk integrations
237
237
  Get a list of Service Desk integration objects.
238
238
 
239
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integrations-v1)
239
+ [API Spec](https://developer.sailpoint.com/docs/api/get-service-desk-integrations-v-1)
240
240
 
241
241
  ### Parameters
242
242
 
@@ -281,7 +281,7 @@ console.log(result);
281
281
  Get the time check configuration
282
282
  Get the time check configuration of queued SDIM tickets.
283
283
 
284
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-status-check-details-v1)
284
+ [API Spec](https://developer.sailpoint.com/docs/api/get-status-check-details-v-1)
285
285
 
286
286
  ### Parameters
287
287
 
@@ -314,7 +314,7 @@ console.log(result);
314
314
  Patch a service desk integration
315
315
  Update an existing Service Desk integration by ID with a PATCH request.
316
316
 
317
- [API Spec](https://developer.sailpoint.com/docs/api/v1/patch-service-desk-integration-v1)
317
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-service-desk-integration-v-1)
318
318
 
319
319
  ### Parameters
320
320
 
@@ -353,7 +353,7 @@ console.log(result);
353
353
  Update a service desk integration
354
354
  Update an existing Service Desk integration by ID.
355
355
 
356
- [API Spec](https://developer.sailpoint.com/docs/api/v1/put-service-desk-integration-v1)
356
+ [API Spec](https://developer.sailpoint.com/docs/api/put-service-desk-integration-v-1)
357
357
 
358
358
  ### Parameters
359
359
 
@@ -392,7 +392,7 @@ console.log(result);
392
392
  Update the time check configuration
393
393
  Update the time check configuration of queued SDIM tickets.
394
394
 
395
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-status-check-details-v1)
395
+ [API Spec](https://developer.sailpoint.com/docs/api/update-status-check-details-v-1)
396
396
 
397
397
  ### Parameters
398
398
 
@@ -42,7 +42,7 @@ One SSF stream is allowed for each client ID.
42
42
  You can create a maximum of 10 SSF stream configurations for one org.
43
43
 
44
44
 
45
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-stream-v1)
45
+ [API Spec](https://developer.sailpoint.com/docs/api/create-stream-v-1)
46
46
 
47
47
  ### Parameters
48
48
 
@@ -83,7 +83,7 @@ query parameter `stream_id`. On success the response has no body (204 No Content
83
83
  The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
84
84
 
85
85
 
86
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-stream-v1)
86
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-stream-v-1)
87
87
 
88
88
  ### Parameters
89
89
 
@@ -120,7 +120,7 @@ console.log(result);
120
120
  Get JWKS
121
121
  Returns the transmitter's JSON Web Key Set (JWKS) for verifying signed delivery requests.
122
122
 
123
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-jwks-data-v1)
123
+ [API Spec](https://developer.sailpoint.com/docs/api/get-jwks-data-v-1)
124
124
 
125
125
  ### Parameters
126
126
 
@@ -153,7 +153,7 @@ console.log(result);
153
153
  Get SSF configuration
154
154
  Returns the SSF transmitter discovery metadata (well-known configuration).
155
155
 
156
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-ssf-configuration-v1)
156
+ [API Spec](https://developer.sailpoint.com/docs/api/get-ssf-configuration-v-1)
157
157
 
158
158
  ### Parameters
159
159
 
@@ -186,7 +186,7 @@ console.log(result);
186
186
  Get stream status
187
187
  Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request's OAuth 2.0 access token. The stream_id query parameter is required.
188
188
 
189
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-stream-status-v1)
189
+ [API Spec](https://developer.sailpoint.com/docs/api/get-stream-status-v-1)
190
190
 
191
191
  ### Parameters
192
192
 
@@ -229,7 +229,7 @@ of the request OAuth 2.0 access token.
229
229
  Query parameter `aud` (co filter) can be used to filter by audience.
230
230
 
231
231
 
232
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-stream-v1)
232
+ [API Spec](https://developer.sailpoint.com/docs/api/get-stream-v-1)
233
233
 
234
234
  ### Parameters
235
235
 
@@ -266,7 +266,7 @@ console.log(result);
266
266
  Verify stream
267
267
  Verifies an SSF stream by publishing a verification event requested by a security events provider.
268
268
 
269
- [API Spec](https://developer.sailpoint.com/docs/api/v1/send-stream-verification-v1)
269
+ [API Spec](https://developer.sailpoint.com/docs/api/send-stream-verification-v-1)
270
270
 
271
271
  ### Parameters
272
272
 
@@ -306,7 +306,7 @@ Replaces a stream's configuration (PUT). stream_id and delivery are required; fu
306
306
  The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
307
307
 
308
308
 
309
- [API Spec](https://developer.sailpoint.com/docs/api/v1/set-stream-configuration-v1)
309
+ [API Spec](https://developer.sailpoint.com/docs/api/set-stream-configuration-v-1)
310
310
 
311
311
  ### Parameters
312
312
 
@@ -346,7 +346,7 @@ Partially updates a stream's configuration (PATCH). Only provided fields are upd
346
346
  The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
347
347
 
348
348
 
349
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-stream-configuration-v1)
349
+ [API Spec](https://developer.sailpoint.com/docs/api/update-stream-configuration-v-1)
350
350
 
351
351
  ### Parameters
352
352
 
@@ -383,7 +383,7 @@ console.log(result);
383
383
  Update stream status
384
384
  Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request's OAuth 2.0 access token.
385
385
 
386
- [API Spec](https://developer.sailpoint.com/docs/api/v1/update-stream-status-v1)
386
+ [API Spec](https://developer.sailpoint.com/docs/api/update-stream-status-v-1)
387
387
 
388
388
  ### Parameters
389
389
 
@@ -38,7 +38,7 @@ This API is currently in an experimental state. The API is subject to change bas
38
38
  Create new sim integration
39
39
  Create a new SIM Integrations.
40
40
 
41
- [API Spec](https://developer.sailpoint.com/docs/api/v1/create-sim-integration-v1)
41
+ [API Spec](https://developer.sailpoint.com/docs/api/create-sim-integration-v-1)
42
42
 
43
43
  ### Parameters
44
44
 
@@ -80,7 +80,7 @@ This API is currently in an experimental state. The API is subject to change bas
80
80
  Delete a sim integration
81
81
  Get the details of a SIM integration.
82
82
 
83
- [API Spec](https://developer.sailpoint.com/docs/api/v1/delete-sim-integration-v1)
83
+ [API Spec](https://developer.sailpoint.com/docs/api/delete-sim-integration-v-1)
84
84
 
85
85
  ### Parameters
86
86
 
@@ -122,7 +122,7 @@ This API is currently in an experimental state. The API is subject to change bas
122
122
  Get a sim integration details.
123
123
  Get the details of a SIM integration.
124
124
 
125
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-sim-integration-v1)
125
+ [API Spec](https://developer.sailpoint.com/docs/api/get-sim-integration-v-1)
126
126
 
127
127
  ### Parameters
128
128
 
@@ -164,7 +164,7 @@ This API is currently in an experimental state. The API is subject to change bas
164
164
  List the existing sim integrations.
165
165
  List the existing SIM integrations.
166
166
 
167
- [API Spec](https://developer.sailpoint.com/docs/api/v1/get-sim-integrations-v1)
167
+ [API Spec](https://developer.sailpoint.com/docs/api/get-sim-integrations-v-1)
168
168
 
169
169
  ### Parameters
170
170
 
@@ -204,7 +204,7 @@ This API is currently in an experimental state. The API is subject to change bas
204
204
  Patch a sim beforeprovisioningrule attribute.
205
205
  Patch a SIM beforeProvisioningRule attribute given a JsonPatch object.
206
206
 
207
- [API Spec](https://developer.sailpoint.com/docs/api/v1/patch-before-provisioning-rule-v1)
207
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-before-provisioning-rule-v-1)
208
208
 
209
209
  ### Parameters
210
210
 
@@ -248,7 +248,7 @@ This API is currently in an experimental state. The API is subject to change bas
248
248
  Patch a sim attribute.
249
249
  Patch a SIM attribute given a JsonPatch object.
250
250
 
251
- [API Spec](https://developer.sailpoint.com/docs/api/v1/patch-sim-attributes-v1)
251
+ [API Spec](https://developer.sailpoint.com/docs/api/patch-sim-attributes-v-1)
252
252
 
253
253
  ### Parameters
254
254
 
@@ -292,7 +292,7 @@ This API is currently in an experimental state. The API is subject to change bas
292
292
  Update an existing sim integration
293
293
  Update an existing SIM integration.
294
294
 
295
- [API Spec](https://developer.sailpoint.com/docs/api/v1/put-sim-integration-v1)
295
+ [API Spec](https://developer.sailpoint.com/docs/api/put-sim-integration-v-1)
296
296
 
297
297
  ### Parameters
298
298