SavedSearch

Use this API to implement saved search functionality. With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them.

Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. Refer to Scheduled Search for more information about running saved searches on a schedule.

In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want.

Refer to Managing Saved Searches for more information about saving searches and using them.

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

Method	HTTP request	Description
New-V2024SavedSearch	POST /saved-searches	Create a saved search
Remove-V2024SavedSearch	DELETE /saved-searches/{id}	Delete document by ID
Invoke-V2024ExecuteSavedSearch	POST /saved-searches/{id}/execute	Execute a saved search by ID
Get-V2024SavedSearch	GET /saved-searches/{id}	Return saved search by ID
Get-V2024SavedSearches	GET /saved-searches	A list of Saved Searches
Send-V2024SavedSearch	PUT /saved-searches/{id}	Updates an existing saved search

create-saved-search

Creates a new saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	CreateSavedSearchRequest	CreateSavedSearchRequest	True	The saved search to persist.

Return type

SavedSearch

Responses

Code	Description	Data Type
201	The persisted saved search.	SavedSearch
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$CreateSavedSearchRequest = @""@

# Create a saved search

try {
    $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
    New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-saved-search

Deletes the specified saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the requested document.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No Content - Indicates the request was successful but there is no content to be returned in the response.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.

# Delete document by ID

try {
    Remove-V2024SavedSearch -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024SavedSearch -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch"
    Write-Host $_.ErrorDetails
}

[Back to top]

execute-saved-search

Executes the specified saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the requested document.
Body	SearchArguments	SearchArguments	True	When saved search execution is triggered by a scheduled search, scheduleId will specify the ID of the triggering scheduled search. If scheduleId is not specified (when execution is triggered by a UI test), the owner and recipients arguments must be provided.

Return type

(empty response body)

Responses

Code	Description	Data Type
202	Accepted - Returned if the request was successfully accepted into the system.
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
$SearchArguments = @"{
  "owner" : "",
  "recipients" : [ {
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  }, {
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  } ],
  "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8"
}"@

# Execute a saved search by ID

try {
    $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
    Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result 
    
    # Below is a request that includes all optional parameters
    # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-saved-search

Returns the specified saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the requested document.

Return type

SavedSearch

Responses

Code	Description	Data Type
200	The requested saved search.	SavedSearch
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.

# Return saved search by ID

try {
    Get-V2024SavedSearch -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SavedSearch -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-saved-searches

Returns a list of saved searches.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(optional) (default to $false)	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.
Query	Filters	String	(optional)	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

Return type

SavedSearch[]

Responses

Code	Description	Data Type
200	The list of requested saved searches.	SavedSearch[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Offset = 0 # Int32 | 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) (default to 0)
$Limit = 250 # Int32 | 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) (default to 250)
$Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **owner.id**: *eq* (optional)

# A list of Saved Searches

try {
    Get-V2024SavedSearches 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-saved-search

Updates an existing saved search.

NOTE: You cannot update the owner of the saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the requested document.
Body	SavedSearch	SavedSearch	True	The saved search to persist.

Return type

SavedSearch

Responses

Code	Description	Data Type
200	The persisted saved search.	SavedSearch
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
$SavedSearch = @"{
  "owner" : {
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  },
  "created" : "2018-06-25T20:22:28.104Z",
  "columns" : {
    "identity" : [ {
      "field" : "displayName",
      "header" : "Display Name"
    }, {
      "field" : "e-mail",
      "header" : "Work Email"
    } ]
  },
  "query" : "@accounts(disabled:true)",
  "description" : "Disabled accounts",
  "orderBy" : {
    "identity" : [ "lastName", "firstName" ],
    "role" : [ "name" ]
  },
  "sort" : [ "displayName" ],
  "filters" : {
    "terms" : [ "account_count", "account_count" ],
    "range" : {
      "lower" : {
        "inclusive" : false,
        "value" : "1"
      },
      "upper" : {
        "inclusive" : false,
        "value" : "1"
      }
    },
    "exclude" : false,
    "type" : "RANGE"
  },
  "ownerId" : "2c91808568c529c60168cca6f90c1313",
  "indices" : [ "identities" ],
  "public" : false,
  "name" : "Disabled accounts",
  "modified" : "2018-06-25T20:22:28.104Z",
  "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64",
  "fields" : [ "disabled" ]
}"@

# Updates an existing saved search 

try {
    $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
    Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result 
    
    # Below is a request that includes all optional parameters
    # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch"
    Write-Host $_.ErrorDetails
}

[Back to top]