Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Corrected the CLI Search command documentation to reflect the removal of outputTypes #432

Merged
1 commit merged into from
Dec 1, 2023
Merged

Corrected the CLI Search command documentation to reflect the removal of outputTypes #432

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions products/idn/tools/cli/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,10 @@ The `search` command makes it easy to search in IdentityNow with the SailPoint C
- [Flags](#flags)
- [Indices](#indices)
- [Sort](#sort)
- [Output Types](#output-types)
- [Folder Path](#folder-path)
- [Template](#template)
- [Command](#command-1)
- [Flags](#flags-1)
- [Output Types](#output-types-1)
- [Folder Path](#folder-path-1)

## Query
Expand Down Expand Up @@ -67,8 +65,7 @@ You must start your search query with `sail search query`, and you must specify
You can append a number of flags to the `query` command to refine it:
- The first flag, `indices`, is required. It specifies the indices to run the search operation on.
- The second possible flag, `sort`, allows you to specify the sort strings to use for the search query, as well as the sorting arrangement for the results.
- The third possible flag, `outputTypes`, allows you to specify the output data format as either `json` or `csv`.
- The fourth possible flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.
- The third possible flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.

#### Indices

Expand Down Expand Up @@ -114,7 +111,7 @@ Use the `outputTypes` flag to specify the output data format for the search quer
Here is an example of a `query` command that specifies the `json` output type:

```shell
sail search query "name:a*" --indices identities --outputTypes json
sail search query "name:a*" --indices identities
```

#### Folder Path
Expand Down Expand Up @@ -147,19 +144,9 @@ The specified template file will give the CLI all the information it needs to pe
### Flags


You can append two flags to the `template` command to refine it:
- The first possible flag, `outputTypes`, allows you to specify the output data format as either `json` or `csv`.
- The second possible flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.

#### Output Types

Use the `outputTypes` flag to specify the output data format for the search template query results. Currently, the only supported output types are `json` and `csv`.
You can append one flag to the `template` command to refine it:
- The flag, `folderPath`, allows you to specify the folder path where you want to save the search query result files.

Here is an example of a `template` command that specifies the `json` output type:

```shell
sail search template all-provisioning-events-90-days --outputTypes json
```

#### Folder Path

Expand Down
Loading