diff --git a/docs/jupiterone.md b/docs/jupiterone.md index f7691ef..a833c6a 100644 --- a/docs/jupiterone.md +++ b/docs/jupiterone.md @@ -18,7 +18,11 @@ ## Requirements - JupiterOne requires an API token. You need permission to create a user in - Sonarqube that will be used to obtain the API token. + Sonarqube that will be used to obtain the API token. The token should have the + `Administer System` permission to allow the ability to pull extra user + metadata. More information on this can be found in the sonarqube api + documentation of your instance + (`/web_api/api/users/search`). - You must have permission in JupiterOne to install new integrations. ## Support @@ -82,8 +86,17 @@ The following entities are created: | Resources | Entity `_type` | Entity `_class` | | --------- | ---------------------- | --------------- | | Project | `sonarqube_project` | `Project` | +| User | `sonarqube_user` | `User` | | UserGroup | `sonarqube_user_group` | `UserGroup` | +### Relationships + +The following relationships are created/mapped: + +| Source Entity `_type` | Relationship `_class` | Target Entity `_type` | +| ---------------------- | --------------------- | --------------------- | +| `sonarqube_user_group` | **HAS** | `sonarqube_user` | +