Skip to content

DOCS-413 - Add roles to API docs #4980

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

Merged
merged 3 commits into from
Jan 22, 2025
Merged

DOCS-413 - Add roles to API docs #4980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f8bd2e
DOCS-413 - Add roles to API docs
jpipkin1 Jan 21, 2025
8c38ae2
Fix spelling errors
jpipkin1 Jan 21, 2025
fffb774
Merge branch 'main' into docs-413-add-roles-to-api-docs
jpipkin1 Jan 21, 2025
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
4 changes: 1 addition & 3 deletions docs/api/access-keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,10 @@ The [Access Keys](/docs/manage/security/access-keys) Management API allows you t
| US1 | https://api.sumologic.com/docs/#tag/accessKeyManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/accessKeyManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Security
* Create Access Keys
* Manage Access Keys

-->
5 changes: 1 addition & 4 deletions docs/api/account-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,8 @@ The Account Management API allows you to manage the custom subdomain for the URL
| US1 | https://api.sumologic.com/docs/#tag/accountManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/accountManagement |


<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>
* Data Management
* View Account Overview

-->
4 changes: 1 addition & 3 deletions docs/api/app-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@ View and install Sumo Logic applications that deliver out-of-the-box dashboards,
| US1 | https://api.sumologic.com/docs/#tag/appManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/appManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Apps

-->
4 changes: 1 addition & 3 deletions docs/api/archive-ingestion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,10 @@ You need the [Manage or View Collectors role capability](/docs/manage/users-role
| US1 | https://api.sumologic.com/docs/#tag/archiveManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/archiveManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Collectors
* View Collectors

-->
4 changes: 1 addition & 3 deletions docs/api/cloud-siem-enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,8 @@ The [Cloud SIEM](/docs/cse) API allows you to create and manage Entities, Custom

<CseTable/>

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Cloud SIEM (all role capabilities)

-->
4 changes: 1 addition & 3 deletions docs/api/cloud-soar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,8 @@ https://<cloudsoarhost>/incmansuite_ng/lib/gui/app.php#support_apidoc|api_docume

For more information, see [Legacy Cloud SOAR APIs](/docs/cloud-soar/legacy/legacy-cloud-soar-apis/).

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Cloud SOAR (all role capabilities)

-->
3 changes: 1 addition & 2 deletions docs/api/collector-management/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,13 @@ This API manages your OpenTelemetry collectors.
| US2 | https://api.us2.sumologic.com/docs/#tag/otCollectorManagementExternal |


<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Collectors
* View Collectors
-->

## Guide contents

Expand Down
3 changes: 1 addition & 2 deletions docs/api/connections-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@ Connections Management APIs let you set up connections to send alerts to third-p
| US2 | https://api.us2.sumologic.com/docs/#tag/connectionManagement |


<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* View Connections
* Manage Connections

-->
3 changes: 1 addition & 2 deletions docs/api/content-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,10 @@ The Content Management API allows you to manage content in your organization’s
| US1 | https://api.sumologic.com/docs/#tag/contentManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/contentManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Content

-->
3 changes: 1 addition & 2 deletions docs/api/content-permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Content Permissions API allows you to share your folders, searches, and dash
| US1 | https://api.sumologic.com/docs/#tag/contentPermissions |
| US2 | https://api.us2.sumologic.com/docs/#tag/contentPermissions |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

Expand All @@ -41,5 +41,4 @@ The Content Permissions API allows you to share your folders, searches, and dash
* Change Data Access Level
* Manage Share Dashboards Outside of Organization

-->

3 changes: 1 addition & 2 deletions docs/api/dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,9 @@ The Dashboard Management APIs allow you to create, retrieve, update, and delete
|US1 |https://api.sumologic.com/docs/#tag/dashboardManagement |
|US2 |https://api.us2.sumologic.com/docs/#tag/dashboardManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Dashboards (all capabilities)

-->
4 changes: 1 addition & 3 deletions docs/api/dynamic-parsing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Dynamic Parsing Management API allows you to configure Run Time Field Extrac
| US1 | https://api.sumologic.com/docs/#tag/dynamicParsingRuleManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/dynamicParsingRuleManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

Expand All @@ -39,5 +39,3 @@ The Dynamic Parsing Management API allows you to configure Run Time Field Extrac
* Manage Fields
* View Field Extraction Rules
* View Fields

-->
4 changes: 1 addition & 3 deletions docs/api/field-extraction-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Field Extraction Rules (FER) Management API allows you to configure FERs fro
| US1 | https://api.sumologic.com/docs/#tag/extractionRuleManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/extractionRuleManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

Expand All @@ -39,5 +39,3 @@ The Field Extraction Rules (FER) Management API allows you to configure FERs fro
* Manage Fields
* View Field Extraction Rules
* View Fields

-->
4 changes: 1 addition & 3 deletions docs/api/field-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Field Management API allows you to configure fields from HTTP endpoints. Fie
| US1 | https://api.sumologic.com/docs/#tag/fieldManagementV1 |
| US2 | https://api.us2.sumologic.com/docs/#tag/fieldManagementV1 |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

Expand All @@ -39,5 +39,3 @@ The Field Management API allows you to configure fields from HTTP endpoints. Fie
* Manage Fields
* View Field Extraction Rules
* View Fields

-->
3 changes: 1 addition & 2 deletions docs/api/folder-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,10 @@ The Folder Management API allows you to add folders and subfolders to the [Libra
| US1 | https://api.sumologic.com/docs/#tag/folderManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/folderManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Content

-->
4 changes: 1 addition & 3 deletions docs/api/health-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,10 @@ The [Health Events](/docs/manage/health-events) Management API allows you to vie
| US2 | https://api.us2.sumologic.com/docs/#tag/healthEvents |


<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Collectors
* View Collectors

-->
4 changes: 1 addition & 3 deletions docs/api/ingest-budget-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,11 @@ Ingest Budget Management V1 APIs have been removed and are no longer supported.
| US1 | https://api.sumologic.com/docs/#tag/ingestBudgetManagementV2 |
| US2 | https://api.us2.sumologic.com/docs/#tag/ingestBudgetManagementV2 |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Manage Ingest Budgets

-->

To manage ingest budgets, you must have the **Manage Ingest Budgets** role capability. Enabling this will automatically enable the **Manage Collectors** capability. The Manage Collectors capability on its own permits the re-assignment of budgets to different Collectors, but not creating or deleting them. For more information, see [Ingest Budgets](/docs/manage/ingestion-volume/ingest-budgets).
4 changes: 1 addition & 3 deletions docs/api/log-search-estimated-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,11 @@ In the Infrequent Data Tier and Flex, you pay per query, based on the amount of
| US1 | https://api.sumologic.com/docs/#operation/getLogSearchEstimatedUsageByMeteringType |
| US2 | https://api.us2.sumologic.com/docs/#operation/getLogSearchEstimatedUsageByMeteringType |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Download Search Results
* Manage Data Volume Feed
* View Collectors

-->
4 changes: 1 addition & 3 deletions docs/api/log-searches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,10 @@ Whether you're running ad hoc searches during a forensic investigation or runnin
| US1 | https://api.sumologic.com/docs/#tag/logSearchesManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/logSearchesManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Download Search Results
* View Collectors

-->
4 changes: 1 addition & 3 deletions docs/api/logs-data-forwarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The Logs Data Forwarding Management API allows you to forward log data from a Pa
| US1 | https://api.sumologic.com/docs/#tag/logsDataForwardingManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/logsDataForwardingManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

Expand All @@ -40,5 +40,3 @@ The Logs Data Forwarding Management API allows you to forward log data from a Pa
* Manage Scheduled Views
* View Partitions
* View Scheduled Views

-->
4 changes: 1 addition & 3 deletions docs/api/lookup-tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,11 @@ The Lookup Management API allows you to manage [Lookup Tables](/docs/search/look
| US1 | https://api.sumologic.com/docs/#tag/lookupManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/lookupManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Data Management
* Download Search Results
* Manage Content
* View Collectors

-->
4 changes: 1 addition & 3 deletions docs/api/metrics-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,8 @@ A metric query consists of a metric, one or more filters, and optionally, one or
| US1 | https://api.sumologic.com/docs/#tag/metricsQuery |
| US2 | https://api.us2.sumologic.com/docs/#tag/metricsQuery |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Metrics (all role capabilities)

-->
3 changes: 1 addition & 2 deletions docs/api/metrics-searches-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,9 @@ Use Metrics Search Management APIs V2 to save metrics searches in the content li
| US1 | https://api.sumologic.com/docs/#tag/metricsSearchesManagementV2 |
| US2 | https://api.us2.sumologic.com/docs/#tag/metricsSearchesManagementV2 |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Metrics (all role capabilities)

-->
4 changes: 1 addition & 3 deletions docs/api/metrics-searches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,8 @@ Use Metrics Search Management APIs to save metrics searches in your content libr
| US1 | https://api.sumologic.com/docs/#tag/metricsSearchesManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/metricsSearchesManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Metrics (all role capabilities)

-->
3 changes: 1 addition & 2 deletions docs/api/metrics-transformation-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ Metrics Transformation Rules APIs allow you control how long raw metrics are ret
| US1 | https://api.sumologic.com/docs/#tag/transformationRuleManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/transformationRuleManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Metrics (all role capabilities)

-->
4 changes: 1 addition & 3 deletions docs/api/monitors-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ The Monitor Management API allows you to manage Monitors from HTTP endpoints. Mo
| US1 | https://api.sumologic.com/docs/#tag/monitorsLibraryManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/monitorsLibraryManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Alerting (all role capabilities)

-->
4 changes: 1 addition & 3 deletions docs/api/muting-schedules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ The Muting Schedules Management API allows you to pause alert notifications from
| US1 | https://api.sumologic.com/docs/#tag/mutingSchedulesLibraryManagement |
| US2 | https://api.us2.sumologic.com/docs/#tag/mutingSchedulesLibraryManagement |

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Alerting (all role capabilities)

-->
3 changes: 1 addition & 2 deletions docs/api/organizations-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,9 @@ With the Organizations Management API, you can get the credits usage details of

<sup>`*`</sup> This assembly is exclusive to the US2 deployment and manages APIs for Sumo Logic orgs not tied to a specific deployment, such as parent orgs with child orgs across multiple deployments. It includes the [List Organizations API](https://organizations.sumologic.com/docs/#operation/listOrganizations) to support this setup.

<!-- ## Required role capabilities
## Required role capabilities

<ApiRoles/>

* Organizations (all role capabilities)

-->
Loading
Loading