LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00

Files

darrell-thobe-sp c18583ede4 starting point for adding python sdk docs

2025-02-20 12:59:19 -05:00

22 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

sailpoint.v2024.SavedSearchApi

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
create_saved_search	POST `/saved-searches`	Create a saved search
delete_saved_search	DELETE `/saved-searches/{id}`	Delete document by ID
execute_saved_search	POST `/saved-searches/{id}/execute`	Execute a saved search by ID
get_saved_search	GET `/saved-searches/{id}`	Return saved search by ID
list_saved_searches	GET `/saved-searches`	A list of Saved Searches
put_saved_search	PUT `/saved-searches/{id}`	Updates an existing saved search

create-saved-search

Create a saved search Creates a new saved search.

API Spec

Parameters

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

Return type

SavedSearch

Responses

Code	Description	Data Type	Response headers
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

import sailpoint.v2024
from sailpoint.v2024.models.create_saved_search_request import CreateSavedSearchRequest
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    create_saved_search_request = sailpoint.v2024.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist.

    try:
        # Create a saved search
        Result = create_saved_search_request.from_json(create_saved_search_request)
        api_response = api_instance.create_saved_search(Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_saved_search(Result)
        print("The response of SavedSearchApi->create_saved_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e)

[Back to top]

delete-saved-search

Delete document by ID Deletes the specified saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	ID of the requested document.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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

import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.

    try:
        # Delete document by ID
        
        api_instance.delete_saved_search(id)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_saved_search(id)
    except Exception as e:
        print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e)

[Back to top]

execute-saved-search

Execute a saved search by ID Executes the specified saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	ID of the requested document.
Body	search_arguments	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	Response headers
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

import sailpoint.v2024
from sailpoint.v2024.models.search_arguments import SearchArguments
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
    search_arguments = {
          "owner" : "",
          "recipients" : [ {
            "id" : "2c91808568c529c60168cca6f90c1313",
            "type" : "IDENTITY"
          }, {
            "id" : "2c91808568c529c60168cca6f90c1313",
            "type" : "IDENTITY"
          } ],
          "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8"
        } # SearchArguments | 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. 

    try:
        # Execute a saved search by ID
        Result = search_arguments.from_json(search_arguments)
        api_instance.execute_saved_search(id, Result)
        
        # Below is a request that includes all optional parameters
        # api_instance.execute_saved_search(id, Result)
    except Exception as e:
        print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e)

[Back to top]

get-saved-search

Return saved search by ID Returns the specified saved search.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	id	str	True	ID of the requested document.

Return type

SavedSearch

Responses

Code	Description	Data Type	Response headers
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

import sailpoint.v2024
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.

    try:
        # Return saved search by ID
        
        api_response = api_instance.get_saved_search(id)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_saved_search(id)
        print("The response of SavedSearchApi->get_saved_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e)

[Back to top]

list-saved-searches

A list of Saved Searches Returns a list of saved searches.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	offset	int	(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	int	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	count	bool	(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	str	(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

List[SavedSearch]

Responses

Code	Description	Data Type	Response headers
200	The list of requested saved searches.	List[SavedSearch]	* X-Total-Count - The total result count.
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

import sailpoint.v2024
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    offset = 0 # int | 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) # int | 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 # int | 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) # int | 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 = False # bool | 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) # bool | 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\"' # str | 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) # str | 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)

    try:
        # A list of Saved Searches
        
        api_response = api_instance.list_saved_searches()
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_saved_searches(offset, limit, count, filters)
        print("The response of SavedSearchApi->list_saved_searches:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e)

[Back to top]

put-saved-search

Updates an existing 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	str	True	ID of the requested document.
Body	saved_search	SavedSearch	True	The saved search to persist.

Return type

SavedSearch

Responses

Code	Description	Data Type	Response headers
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

import sailpoint.v2024
from sailpoint.v2024.models.saved_search import SavedSearch
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
    saved_search = {
          "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" ]
        } # SavedSearch | The saved search to persist.

    try:
        # Updates an existing saved search 
        Result = saved_search.from_json(saved_search)
        api_response = api_instance.put_saved_search(id, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.put_saved_search(id, Result)
        print("The response of SavedSearchApi->put_saved_search:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e)

[Back to top]

22 KiB Raw Blame History

sailpoint.v2024.SavedSearchApi

create-saved-search

Parameters

Return type

Responses

HTTP request headers

Example

delete-saved-search

Parameters

Return type

Responses

HTTP request headers

Example

execute-saved-search

Parameters

Return type

Responses

HTTP request headers

Example

get-saved-search

Parameters

Return type

Responses

HTTP request headers

Example

list-saved-searches

Parameters

Return type

Responses

HTTP request headers

Example

put-saved-search

Parameters

Return type

Responses

HTTP request headers

Example

22 KiB

Raw Blame History