Skip to content

Commit

Permalink
Merge pull request #398 from sailpoint-oss/cli-doc-updates
Browse files Browse the repository at this point in the history
Updated documentation to reflect new CLI sanitize command
  • Loading branch information
Luke Hagar authored Nov 16, 2023
2 parents 8691062 + 699cf55 commit eed04bd
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 3 deletions.
4 changes: 2 additions & 2 deletions products/idn/tools/cli/connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: cli-connectors
title: Connectors
pagination_label: CLI Connectors
sidebar_label: Connectors
sidebar_position: 2
sidebar_position: 1
sidebar_class_name: cli-connectors
keywords: ['cli', 'cli connectors', 'connectors']
description: Learn how to use the CLI to create, manage, and test SaaS connectors in this guide.
Expand Down Expand Up @@ -172,4 +172,4 @@ To get detailed logging statistics on each connector, run this command:
sail conn stats
```

For more information about connector logging, refer to [Logging](/idn/docs/saas-connectivity/in-depth/logging/).
For more information about connector logging, refer to [Logging](/idn/docs/saas-connectivity/in-depth/logging/).
59 changes: 59 additions & 0 deletions products/idn/tools/cli/sanitize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: cli-sanitize
title: Sanitize
pagination_label: CLI-Sanitize
sidebar_label: Sanitize
sidebar_position: 2
sidebar_class_name: cli
keywords: ['cli', 'sanitize']
description: Learn how to use the CLI to sanitize your HAR files in this guide.
slug: /tools/cli/sanitize
tags: ['CLI']
---


## Sanitize

Learn how to use the CLI to sanitize your HAR files in this guide.

When you're troubleshooting issues you encounter using Identity Security Cloud, some of the most helpful data can be contained in a HAR file collected from your browser's API calls made while replicating the issue.

The problem lies in the amount of information, specifically sensitive information that the HAR file contains, due to the nature of the data it's capturing. The CLI is very useful for this. You can use the CLI to sanitize the HAR file, which removes sensitive information but still still leaves the file in a useful state for troubleshooting the issue.

The existing support guide for collecting and sanitizing the HAR file [can be found here](https://support.sailpoint.com/csm?id=kb_article_view&sysparm_article=KB0011711#_gl=1*17esz5f*_gcl_au*MTczOTU0NDU4NC4xNjkxNjc5NzY2).

- [Sanitize](#sanitize)
- [Functionality](#functionality)
- [Command](#command)

### Functionality

The sanitize command sanitizes a HAR file of sensitive data.
It only removes access tokens matching the Identity Security Cloud format and origin urls similar to the examples below:

Access Token
```
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRfaWQiOiI1OGViMDZhNC1kY2Q3LTRlOTYtOGZhYy1jY2EyYWZjMDNlNjEiLCJpbnRlcm5hbCI6dHJ1ZSwicG9kIjoiY29vayIsIm9yZyI6ImV4YW1wbGUiLCJpZGVudGl0eV9pZCI6ImZmODA4MTgxNTVmZThjMDgwMTU1ZmU4ZDkyNWIwMzE2IiwidXNlcl9uYW1lIjoic2xwdC5zZXJ2aWNlcyIsInN0cm9uZ19hdXRoIjp0cnVlLCJhdXRob3JpdGllcyI6WyJPUkdfQURNSU4iXSwiY2xpZW50X2lkIjoibktCUE93akpIOExYU2pJbCIsInN0cm9uZ19hdXRoX3N1cHBvcnRlZCI6dHJ1ZSwidXNlcl9pZCI6IjU5NTgyNiIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJleHAiOjE1NjU4ODgzMTksImp0aSI6ImM5OGQxMjM2LTQ1MTMtNGM4OS1hMGQwLTBjYjlmMzI3NmI1NiJ9.SAY4ZQkXGi2cY_qz57Ah9_zDq4-bnF-oDJKotXa-LCY
```

Origin URLs
```json
{
"name": "origin",
"value": "https://example.identitynow.com"
}
```
### Command

To use the CLI to sanitize HAR files, you can run this command:

```shell
sail sanitize ./path/to/har/file.har
```

You can also sanitize multiple files at once:

```shell
sail sanitize ./path/to/har/file1.har ./path/to/har/file2.har ./path/to/har/file3.har
```

4 changes: 3 additions & 1 deletion products/idn/tools/cli/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ 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.
Expand All @@ -169,4 +170,5 @@ Here is an example of a `template` command that specifies a `folderPath`:

```shell
sail search template all-provisioning-events-90-days --folderPath ./local/folder/path
```
```

0 comments on commit eed04bd

Please sign in to comment.