-
Notifications
You must be signed in to change notification settings - Fork 240
DOCS-1615 - Add Data Masking Management API documentation #6694
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.
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
Open
JV0812
wants to merge
11
commits into
main
Choose a base branch
from
docs-data-masking-api
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8f3fc67
DOCS-1615 - Add Data Masking Management API documentation
JV0812 95733f8
Add Data Masking role capabilities to role capabilities doc
JV0812 3d6b280
Update role capabilities by removing private preview features
JV0812 713fa4f
Simplify description phrasing
JV0812 5059932
Apply suggestion from @JV0812
JV0812 d59a0fe
Apply suggestion from @kimsauce
JV0812 ddf08e3
Document CRUD operation delay for data masking
JV0812 466a718
Update docs/manage/users-roles/roles/role-capabilities.md
JV0812 3ddb5b6
Apply suggestion from @kimsauce
kimsauce 50d6f65
Rename data-masking-management.md to data-masking.md
kimsauce d8a4654
Apply suggestion from @kimsauce
kimsauce File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,52 @@ | ||
| --- | ||
| id: data-masking | ||
| title: Data Masking Management APIs | ||
| sidebar_label: Data Masking Management | ||
| description: Use Data Masking Management API endpoints to manage data masking rules that protect sensitive information in your logs. | ||
| --- | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import ApiIntro from '../reuse/api-intro.md'; | ||
| import ApiRoles from '../reuse/api-roles.md'; | ||
|
|
||
| <p> <a href={useBaseUrl('docs/preview')}><span className="preview-private">Private Preview</span></a> </p> | ||
|
|
||
| :::info | ||
| This feature is in Private Preview. For more information, contact your Sumo Logic account representative. | ||
| ::: | ||
|
|
||
| <img src={useBaseUrl('img/icons/security/security.png')} alt="Security icon" width="40"/> | ||
|
|
||
| Use Data Masking Management APIs to manage data masking rules that automatically redact or replace sensitive information in your logs at ingest time. These APIs help you enforce data protection standards consistently across your organization. | ||
|
|
||
| For more information, see [Data Masking](/docs/manage/data-masking). | ||
|
|
||
| :::info | ||
| Create, read, update, and delete (CRUD) operations may take up to 30 seconds to reflect changes, applied on a per-organization basis. | ||
| ::: | ||
|
|
||
| ## Documentation | ||
|
|
||
| <ApiIntro/> | ||
|
|
||
| | Region code | Region name | AWS region | API endpoint | | ||
| |:----|:----|:---|:-----| | ||
| | AU | Asia Pacific (Sydney) | ap-southeast-2 | https://api.au.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | CA | Canada (Central) | ca-central-1 | https://api.ca.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | CH | Switzerland (Zurich) | eu-central-2 | https://api.ch.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | DE | EU (Frankfurt) | eu-central-1 | https://api.de.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | EU | EU (Ireland) | eu-west-1 | https://api.eu.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | FED | US East (N. Virginia) | us-east-1 | https://api.fed.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | JP | Asia Pacific (Tokyo) | ap-northeast-1 | https://api.jp.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | KR | Asia Pacific (Seoul) | ap-northeast-2 | https://api.kr.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | US1 | US East (N. Virginia) | us-east-1 | https://api.sumologic.com/docs/#tag/dataMaskingManagement | | ||
| | US2 | US West (Oregon) | us-west-2 | https://api.us2.sumologic.com/docs/#tag/dataMaskingManagement | | ||
|
|
||
| ## Required role capabilities | ||
|
|
||
| <ApiRoles/> | ||
|
|
||
| * **Manage Data Masking Rules**. Required to create, update, enable, disable, or delete data masking rules. | ||
| * **View Unmasked Data**. Allows users to view log data in its original, unmasked form. | ||
|
JV0812 marked this conversation as resolved.
|
||
|
|
||
| These capabilities will be listed under [Security](/docs/manage/users-roles/roles/role-capabilities/#security) in Role Capabilities when this feature is GA. | ||
This file contains hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.