-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #398 from sailpoint-oss/cli-doc-updates
Updated documentation to reflect new CLI sanitize command
- Loading branch information
Showing
3 changed files
with
64 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters