Skip to main content

Search

Learn how to use the CLI to search your IDN tenant in this guide.

In IdentityNow (IDN), you can search across all the sources connected to your tenant and return virtually any information you have access to. The search command allows you to access IDN search functionality within the CLI. For more information about the search command, refer to the CLI Search guide. For more information about search in IDN, refer to Search.

Commands

To use the CLI to search your IDN tenant, you can use these commands:

Query

Search queries in IDN are flexible - they can be very broad or very narrow, and you can further narrow your results by using IDN's specific syntax to structure your queries. Refer to Building a Search Query for more information about how specific search queries are constructed in IDN.

To create a search query, run this command and provide your desired search attributes:

sail search query {search query string} --indices {index to search}

For example, running this command would return all identities starting with the letter "a":

sail search query "name:a*" --indices identities

Flags

You can add these flags to the query command:

  • indices: Use this flag to specify the indices you want to search. The following indices are searchable: identities, roles, access profiles, entitlements, events, and account activities. The earlier example shows how to specify a single index in a search query. You can also search multiple indices. For example, running this command would return all identities and access profiles starting with the letter "a": shell sail search query "name:a*" --indices identities --indices accessprofiles
  • sort: Use this flag to specify the sort strings your search query uses. You can also specify multiple sorting criteria. For example, running this command would sort search results by starting with the letter "a" first by the name attribute in ascending order and then the created attribute in descending order, as indicated by the - prefix:
    sail search query "name:a*" --indices identities --sort name --sort "-created"
  • outputTypes: Use this flag to specify the output data type. This example shows how running this command would return search results in a json output. Currently only csv and json are supported.
  • folderPath: Use this flag to specify the folder path you want to save the search results in. If the directory doesn't exist, the CLI creates it. The default folder path is the current working directory.

Template

For more detailed search queries, you can provide a predefined template instead of constructing the whole query every time. This allows you to run very detailed search queries quickly and easily. To search with a predefined template, run this command and provide your template filename:

sail search template {template name}

For example, if you had a template, "all-provisioning-events-90-days," which provided everything you needed to search for all provisioning events performed within your tenant in the last 90 days, you could run this command to search with the template:

sail search template all-provisioning-events-90-days

Flags

You can add these flags to your template command:

  • outputTypes: Use this flag to specify the output data type. In this example, running this command would return search results in a json output:
    sail search template all-provisioning-events-90-days --outputTypes json
    Currently only csv and json are supported.
  • folderPath: Use this flag to specify the folder path you want to save the search results in. For example, running this command would save search results to "./local/folder/path":
    sail search template all-provisioning-events-90-days --folderPath ./local/folder/path
    If the directory doesn't exist, the CLI creates it. The default folder path is the current working directory.