Skip to content

Commit 347502d

Browse files
jpipkin1jpipkin1
committed
Add reuse file
1 parent 3bf1067 commit 347502d

File tree

2 files changed

+35
-26
lines changed

2 files changed

+35
-26
lines changed

‎docs/manage/users-roles/roles/role-capabilities.md‎

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,17 @@ title: Role Capabilities
44
description: Assign any of these capabilities when you create user roles.
55
---
66

7-
Following are the capabilities you can assign when you [create roles](create-manage-roles.md), including the [APIs](/docs/api/about-apis/) available when you have the role.
7+
import ApiCreateRole from '../../../reuse/api-create-role.md';
8+
9+
Following are the capabilities you can assign when you [create roles](create-manage-roles.md).
10+
11+
:::note
12+
If you use the [createRoleV2 API](https://api.sumologic.com/docs/#operation/createRoleV2) to create a role, enter the corresponding role capability value in the `capabilities` parameter of the API.
13+
:::
814

915
## Data Management
1016

11-
| Capability | Description | API |
17+
| Capability | Description | <ApiCreateRole/> |
1218
| :-- | :-- | :-- |
1319
| View Collectors | View collectors and sources that have already been installed or added. | `viewCollectors` |
1420
| Manage Collectors | [View and manage](/docs/send-data) installed and hosted collectors as well as sources. | `manageCollectors` |
@@ -43,21 +49,21 @@ Following are the capabilities you can assign when you [create roles](create-man
4349

4450
## Entity Management
4551

46-
| Capability | Description | API |
52+
| Capability | Description | <ApiCreateRole/> |
4753
| :-- | :-- | :-- |
4854
| Manage Entity Type Configs | Reserved for internal use. | `manageEntityTypeConfigs` |
4955

5056
## Metrics
5157

52-
| Capability | Description | API |
58+
| Capability | Description | Corresponding value in the *capabilities* field of the [createRoleV2 API](https://api.sumologic.com/docs/#operation/createRoleV2) |
5359
| :-- | :-- | :-- |
5460
| Manage Metrics Transformation Rules | Create, edit, or delete [metrics transformation rules](/docs/metrics/metrics-transformation-rules). | `manageMetricsTransformationRules` |
5561
| Manage Logs-to-Metrics | Create, edit, or delete [Logs-to-Metrics](/docs/metrics/logs-to-metrics) rules. | `manageLogsToMetrics` |
5662
| Manage Metrics Rules | Create, edit, or delete [metrics rules](/docs/metrics/metric-rules-editor/). | `manageMetricsRules` |
5763

5864
## Security
5965

60-
| Capability | Description | API |
66+
| Capability | Description | <ApiCreateRole/> |
6167
| :-- | :-- | :-- |
6268
| Manage Password Policy|Set the password policy for your Sumo Logic account. | `managePasswordPolicy` |
6369
|Allowlist IP Addresses | [Explicitly grant access](/docs/manage/security/create-allowlist-ip-cidr-addresses) to specific IP addresses or address ranges. | `allowlistIpAddresses` |
@@ -72,27 +78,27 @@ Following are the capabilities you can assign when you [create roles](create-man
7278

7379
## Dashboards
7480

75-
| Capability | Description | API |
81+
| Capability | Description | <ApiCreateRole/> |
7682
| :-- | :-- | :-- |
7783
| Share Dashboards with the World | [Share dashboards](/docs/dashboards/share-dashboard-outside-org) in view-only mode with no login required. | `shareDashboardsWithTheWorld` |
78-
| Share Dashboards with the Allowlist | [Share dashboards](/docs/dashboards/share-dashboard-new/) in view-only mode; viewers must be on your service allowlist. | `shareDashboardsWithYourAllowlist` and `shareDashboardWhitelist` |
84+
| Share Dashboards with the Allowlist | [Share dashboards](/docs/dashboards/share-dashboard-new/) in view-only mode; viewers must be on your service allowlist. | `shareDashboardsWithYourAllowlist` |
7985

8086
## User Management
8187

82-
| Capability | Description | API |
88+
| Capability | Description | <ApiCreateRole/> |
8389
| :-- | :-- | :-- |
8490
| Manage Users And Roles | Access the UI pages to manage [users](/docs/manage/users-roles/users) and [roles](/docs/manage/users-roles/roles). | `manageUsersAndRoles` |
8591

8692
## Audit Event Management
8793

88-
| Capability | Description | API |
94+
| Capability | Description | <ApiCreateRole/> |
8995
| :-- | :-- | :-- |
9096
| Access Search Audit Events | View and download audit logs of search queries executed in the UI. | `accessSearchAuditEvents` |
9197
| Access Audit Events | View and download audit logs of admin and config events. | `accessAuditEvents` |
9298

9399
## Automation Service
94100

95-
| Capability | Description | API |
101+
| Capability | Description | <ApiCreateRole/> |
96102
| :-- | :-- | :-- |
97103
| Task View|See tasks in [playbooks](/docs/platform-services/automation-service/playbooks/). | `taskView` |
98104
| Task Access | Access your tasks in playbooks. | `taskAccess` |
@@ -111,7 +117,7 @@ Following are the capabilities you can assign when you [create roles](create-man
111117

112118
## Alerting
113119

114-
| Capability | Description | API |
120+
| Capability | Description | <ApiCreateRole/> |
115121
| :-- | :-- | :-- |
116122
| View Monitors |If folder perms are enabled, view folders & monitors you have access to. | `viewMonitors` |
117123
| Manage Monitors | Create folders & monitors, grant perms, and (with folder perms) full CRUD on folders you control. | `manageMonitors` |
@@ -123,51 +129,53 @@ Following are the capabilities you can assign when you [create roles](create-man
123129
<!--
124130
## Open Analytics
125131
126-
| Capability | Description | API |
132+
| Capability | Description | <ApiCreateRole/> |
127133
| :-- | :-- | :-- |
128134
| Manage Open Analytics Endpoint | ? | ? |
129135
-->
130136

131137
## Usage Management
132138

133-
| Capability | Description | API |
139+
<!-- `viewBudgets` is a guess. It doesn't appear in the `capabilities` parameter list. -->
140+
141+
| Capability | Description | <ApiCreateRole/> |
134142
| :-- | :-- | :-- |
135-
| View Usage Management | View [usage management](/docs/manage/manage-subscription/usage-management/). | `getBudgets`, `getBudget`, `getBudgetUsages`, `getBudgetUsage` |
136-
| Manage Usage Management | Manage usage management. | `createBudget`, `updateBudget`, `deleteBudget` |
143+
| View Usage Management | View [usage management](/docs/manage/manage-subscription/usage-management/). | `viewBudgets` |
144+
| Manage Usage Management | Manage usage management. | `manageBudgets` |
137145

138146
## Reliability Management
139147

140-
| Capability | Description | API |
148+
| Capability | Description | <ApiCreateRole/> |
141149
| :-- | :-- | :-- |
142150
| View SLOs | View [Service Level Objectives (SLOs)](/docs/observability/reliability-management-slo/create-slo/). | `viewSLOs` |
143151
| Manage SLOs | Create, edit, and delete SLOs. | `manageSLOs` |
144152

145153
## Threat Intel
146154

147-
| Capability | Description | API |
155+
| Capability | Description | <ApiCreateRole/> |
148156
| :-- | :-- | :-- |
149157
| View Threat Intel Data Store | View the [Threat Intelligence](/docs/security/threat-intelligence/about-threat-intelligence/) tab. | `viewThreatIntelDataStore` |
150158
| Manage Threat Intel Data Store | Create, edit, and delete threat intel sources. | `manageThreatIntelDataStore` |
151159

152160
<!--
153161
## Macros
154162
155-
| Capability | Description | API |
163+
| Capability | Description | <ApiCreateRole/> |
156164
| :-- | :-- | :-- |
157165
| Manage Macros | ? | ? |
158166
-->
159167

160168
<!--
161169
## Data Masking
162170
163-
| Capability | Description | API |
171+
| Capability | Description | <ApiCreateRole/> |
164172
| :-- | :-- | :-- |
165173
| View Unmasked Data | ? | ? |
166174
-->
167175

168176
## Organizations
169177

170-
| Capability | Description | API |
178+
| Capability | Description | <ApiCreateRole/> |
171179
| :-- | :-- | :-- |
172180
| View Organizations | View the [Organizations](/docs/manage/manage-subscription/create-and-manage-orgs/create-manage-orgs) UI. | `viewOrganizations` |
173181
| Create Organizations | Create and provision child organizations. | `createOrganizations` |
@@ -184,7 +192,7 @@ Following are the capabilities you can assign when you [create roles](create-man
184192
This section is for our Cloud SOAR SaaS version. If you have a legacy Cloud SOAR instance URL matching the pattern `*.soar.sumologic.com`, see [Legacy Cloud SOAR](#legacy-cloud-soar).
185193
:::
186194

187-
| Capability category | Capability | Description| API |
195+
| Capability category | Capability | Description| <ApiCreateRole/> |
188196
| :-- | :-- | :-- |:--|
189197
|View Cloud SOAR||Show “Cloud SOAR” link in nav.|`viewCloudSoar`|
190198
|Incident|View|View all [incidents](/docs/cloud-soar/incidents-triage/).|`cloudSoarIncidentView`|
@@ -238,7 +246,7 @@ This section is for our Cloud SOAR SaaS version. If you have a legacy Cloud SOAR
238246

239247
### Legacy Cloud SOAR
240248

241-
| Capability | Description | API |
249+
| Capability | Description | <ApiCreateRole/> |
242250
| :-- | :-- | :-- |
243251
| View Cloud SOAR|Show “Cloud SOAR” link in nav (legacy URL). | `viewCloudSoarLegacy` |
244252
| Settings General| Configure legacy settings. | `settingsGeneralLegacy` |
@@ -248,13 +256,13 @@ This section is for our Cloud SOAR SaaS version. If you have a legacy Cloud SOAR
248256

249257
[Cloud SIEM](/docs/cse/) features only show if enabled.
250258

251-
| Capability| Description | API |
259+
| Capability| Description | <ApiCreateRole/> |
252260
| :-- | :-- | :-- |
253261
|View Cloud SIEM|Show “Cloud SIEM” link in nav.|`viewCse`|
254262

255263
### Insights
256264

257-
| Capability| Description | API |
265+
| Capability| Description | <ApiCreateRole/> |
258266
| :-- | :-- | :-- |
259267
|Comment on Insights|Add comments to [Insights](/docs/cse/get-started-with-cloud-siem/about-cse-insight-ui).|`cseCommentOnInsights`|
260268
|Create Insights|Create new Insights.|`cseCreateInsights`|
@@ -267,7 +275,7 @@ This section is for our Cloud SOAR SaaS version. If you have a legacy Cloud SOAR
267275

268276
### Content
269277

270-
| Capability| Description | API |
278+
| Capability| Description | <ApiCreateRole/> |
271279
| :-- | :-- | :-- |
272280
|View Rules|View [rules](/docs/cse/rules/about-cse-rules).|`cseViewRules`|
273281
|Manage Rules|Create, edit, delete rules.|`cseManageRules`|
@@ -286,7 +294,7 @@ This section is for our Cloud SOAR SaaS version. If you have a legacy Cloud SOAR
286294

287295
### Configuration
288296

289-
| Capability| Description | API |
297+
| Capability| Description | <ApiCreateRole/> |
290298
| :-- | :-- | :-- |
291299
|View Mappings|View [mappings](/docs/cse/schema/create-structured-log-mapping).|`cseViewMappings`|
292300
|Manage Mappings|Create, edit, delete mappings.|`cseManageMappings`|

‎docs/reuse/api-create-role.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Value in *capabilities* parameter of [createRoleV2 API](https://api.sumologic.com/docs/#operation/createRoleV2)

0 commit comments

Comments
 (0)