Skip to content

Commit

Permalink
[doc] update capabilities (issue/#5550)
Browse files Browse the repository at this point in the history
  • Loading branch information
@frapuks
frapuks authored Jun 28, 2024
2 parents f01383b + 84723d8 commit 579a5e4
Showing 1 changed file with 39 additions and 27 deletions.
66 changes: 39 additions & 27 deletions docs/administration/users.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,45 @@ Roles are used in the platform to grant the given groups with some **capabilitie

### List of capabilities

| Capability | Description |
|:-------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
| `Bypass all capabilities` | Just bypass everything including data segregation and enforcements. |
| `Access knowledge` | Access in read-only to all the knowledge in the platform. |
|   `Access to collaborative creation` | Create notes and opinions (and modify its own) on entities and relations. |
|   `Create / Update knowledge` | Create and update existing entities and relationships. |
|     `Restrict organization access` | Share entities and relationships with other organizations. |
|     `Delete knowledge` | Delete entities and relationships. |
|   `Upload knowledge files` | Upload files in the `Data` and `Content` section of entities. |
|   `Download knowledge export` | Download the exports generated in the entities (in the `Data` section). |
|   `Ask for knowledge enrichment` | Trigger an enrichment for a given entity. |
| `Access Dashboards and investigations` | Access to existing custom dashboards and investigations. |
|   `Create / Update Dashboards and investigations` | Create and update custom dashboards and investigations. |
|     `Delete Dashboards and investigations` | Delete existing custom dashboards and investigations. |
|     `Manage Public Dashboards` | Manage public dashboards |
| `Access connectors` | Read information in the `Data > Connectors` section. |
|   `Manage connector state` | Reset the connector state to restart ingestion from the beginning. |
| `Access data sharing & ingestion` | Access and consume data such as TAXII collections. |
|   `Manage data sharing & ingestion` | Share data such as TAXII collections or custom dashboards. |
|   `Manage CSV mappers` | Create, update and delete CSV mappers. |
| `Access administration` | Access and manage overall parameters of the platform in `Settings > Parameters`. |
|   `Manage credentials` | Access and manage roles, groups, users, organizations and security policies. |
|   `Manage marking definitions` | Update and delete marking definitions. |
|   `Manage labels & Attributes` | Update and delete labels, custom taxonomies, workflow and case templates. |
| `Connectors API usage: register, ping, export push ...` | Connectors specific permissions for register, ping, push export files, etc. |
| `Connect and consume the platform streams (/stream, /stream/live)` | List and consume the OpenCTI live streams. |
| `Bypass mandatory references if any` | If external references enforced in a type of entity, be able to bypass the enforcement. |
| Capability | Description |
|:--------------------------------------------------------|:----------------------------------------------------------------------------------------|
| `Bypass all capabilities` | Just bypass everything including data segregation and enforcements. |
| `Access knowledge` | Access in read-only to all the knowledge in the platform. |
|   `Access to collaborative creation` | Create notes and opinions (and modify its own) on entities and relations. |
|   `Create / Update knowledge` | Create and update existing entities and relationships. |
|     `Restrict organization access` | Share entities and relationships with other organizations. |
|     `Delete knowledge` | Delete entities and relationships. |
|     `Manage authorized members` | Restrict the access to an entity to a user, group or organization. |
|     `Bypass enforced reference` | If external references enforced in a type of entity, be able to bypass the enforcement. |
|   `Upload knowledge files` | Upload files in the `Data` and `Content` section of entities. |
|   `Import knowledge` | Trigger the ingestion of an uploaded file. |
|   `Download knowledge export` | Download the exports generated in the entities (in the `Data` section). |
|     `Generate knowledge export` | Trigger the export of the knowledge of an entity. |
|   `Ask for knowledge enrichment` | Trigger an enrichment for a given entity. |
| `Access dashboards` | Access to existing custom dashboards. |
|   `Create / Update dashboards` | Create and update custom dashboards. |
|     `Delete dashboards` | Delete existing custom dashboards. |
|     `Manage public dashboards` | Manage public dashboards. |
| `Access investigations` | Access to existing investigations. |
|   `Create / Update investigations` | Create and update investigations. |
|     `Delete investigations` | Delete existing investigations. |
| `Access connectors` | Read information in the `Data > Connectors` section. |
|   `Manage connector state` | Reset the connector state to restart ingestion from the beginning. |
| `Connectors API usage: register, ping, export push ...` | Connectors specific permissions for register, ping, push export files, etc. |
| `Access data sharing` | Access and consume data such as TAXII collections, CSV feeds and live streams. |
|   `Manage data sharing` | Share data such as TAXII collections, CSV feeds and live streams or custom dashboards. |
| `Access ingestion` | Access (read only) remote OCTI streams, TAXII feeds, RSS feeds, CSV feeds. |
|   `Manage ingestion` | Create, update, delete any remote OCTI streams, TAXII feeds, RSS feeds, CSV feeds. |
| `Manage CSV mappers` | Create, update and delete CSV mappers. |
| `Access to admin functionalities` | Parent capability allowing users to only view the settings. |
|   `Access administration parameters` | Access and manage overall parameters of the platform in `Settings > Parameters`. |
|   `Manage credentials` | Access and manage roles, groups, users, organizations and security policies. |
|   `Manage marking definitions` | Update and delete marking definitions. |
|   `Manage customization` | Customize entity types, rules, notifiers retention policies and decays rules. |
|   `Manage taxonomies` | Manage labels, kill chain phases, vocabularies, status templates, cases templates. |
|   `Access to security activity` | Access to activity log. |
|   `Access to file indexing` | Manage file indexing. |
|   `Access to support` | Generate and download support packages. |


### Manage roles
Expand Down

0 comments on commit 579a5e4

Please sign in to comment.