ScheduledSearchApi

Use this API to implement scheduled search functionality. With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves.

One of the greatest benefits of saving searches is the ability to run those searches on a schedule. This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search.

In Identity Security Cloud, scheduling a search involves a subscription. Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails.

By default, subscriptions exclude detailed results from the emails, for security purposes. Including detailed results about user access in an email may expose sensitive information. However, the subscription creator can choose to include the information in the emails.

By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. However, the subscription creator can choose to suppress these empty emails.

Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. A saved search can have up to 10 subscriptions configured at a time.

The subscription creator can enable, disable, or delete the subscription.

Refer to Subscribing to Saved Searches for more information about scheduling searches and subscribing to them.

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-scheduled-search-v1	POST /scheduled-searches/v1	Create a new scheduled search
delete-scheduled-search-v1	DELETE /scheduled-searches/v1/{id}	Delete a scheduled search
get-scheduled-search-v1	GET /scheduled-searches/v1/{id}	Get a scheduled search
list-scheduled-search-v1	GET /scheduled-searches/v1	List scheduled searches
unsubscribe-scheduled-search-v1	POST /scheduled-searches/v1/{id}/unsubscribe	Unsubscribe a recipient from scheduled search
update-scheduled-search-v1	PUT /scheduled-searches/v1/{id}	Update an existing scheduled search

create-scheduled-search-v1

Create a new scheduled search Creates a new scheduled search.

API Spec

Parameters

Name	Type	Description	Notes
createScheduledSearchV1Request	CreateScheduledSearchV1Request	The scheduled search to persist.

Return type

Scheduledsearch

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ScheduledSearchApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ScheduledSearchApi(configuration);
const createScheduledSearchV1Request: CreateScheduledSearchV1Request = {"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"DAILY","hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}; // The scheduled search to persist.
const result = await apiInstance.createScheduledSearchV1({ createScheduledSearchV1Request: createScheduledSearchV1Request });
console.log(result);

[Back to top]

delete-scheduled-search-v1

Delete a scheduled search Deletes the specified scheduled search.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the requested document.	[default to undefined]

Return type

(empty response body)

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ScheduledSearchApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ScheduledSearchApi(configuration);
const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document.
const result = await apiInstance.deleteScheduledSearchV1({ id: id });
console.log(result);

[Back to top]

get-scheduled-search-v1

Get a scheduled search Returns the specified scheduled search.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the requested document.	[default to undefined]

Return type

Scheduledsearch

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ScheduledSearchApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ScheduledSearchApi(configuration);
const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document.
const result = await apiInstance.getScheduledSearchV1({ id: id });
console.log(result);

[Back to top]

list-scheduled-search-v1

List scheduled searches Returns a list of scheduled searches.

API Spec

Parameters

Name	Type	Description	Notes
offset	number	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	number	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	boolean	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 for more information.	[optional] [default to false]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: owner.id: eq savedSearchId: eq	[optional] [default to undefined]

Return type

Array<Scheduledsearch>

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import { ScheduledSearchApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ScheduledSearchApi(configuration);
const offset: number = 0; // 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. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // 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. (optional)
const filters: string = savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **owner.id**: *eq*  **savedSearchId**: *eq* (optional)
const result = await apiInstance.listScheduledSearchV1({  });
console.log(result);

[Back to top]

unsubscribe-scheduled-search-v1

Unsubscribe a recipient from scheduled search Unsubscribes a recipient from the specified scheduled search.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the requested document.	[default to undefined]
typedreference	Typedreference	The recipient to be removed from the scheduled search.

Return type

(empty response body)

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ScheduledSearchApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ScheduledSearchApi(configuration);
const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document.
const typedreference: Typedreference = ; // The recipient to be removed from the scheduled search. 
const result = await apiInstance.unsubscribeScheduledSearchV1({ id: id, typedreference: typedreference });
console.log(result);

[Back to top]

update-scheduled-search-v1

Update an existing scheduled search Updates an existing scheduled search.

API Spec

Parameters

Name	Type	Description	Notes
id	string	ID of the requested document.	[default to undefined]
scheduledsearch	Scheduledsearch	The scheduled search to persist.

Return type

Scheduledsearch

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import { ScheduledSearchApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new ScheduledSearchApi(configuration);
const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document.
const scheduledsearch: Scheduledsearch = ; // The scheduled search to persist.
const result = await apiInstance.updateScheduledSearchV1({ id: id, scheduledsearch: scheduledsearch });
console.log(result);

[Back to top]