Merge pull request #83 from secureCodeBox/docs/differences-ui-vs-rest

J12934 · web-flow · commit dfc7cb2fa02a · 2019-05-22T16:33:07.000+02:00
Clarifying differences ui vs rest
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
@@ -20,6 +20,7 @@
 Username: choosen Username
 Password: choosen Password
 ```
+
 4. You are now logged in. Additional users can be created in the user managment section. New users are created without any permissions by default. They are not even permitted to log in. This can be changed by assigning them to the pre-exsisting groups or by granting them the required permission individually.
 
 ![User management](../resources/userManagement.png)
@@ -56,11 +57,15 @@ Password: choosen Password
 
 The secureCodeBox can save the security tests results into different data stores. A list with all availible stores and how to configure and use them can be found [here](./persistence/README.md).
 
-## Meta Fields and How to use them
+## Starting securityTests
 
-MetaFields can be used to tag security tests with custom data relevant for you. We have encountered some data values which we found paticulary usefull and standardized their format to be used in multiple places. The list and formats can be found [here](./metafields/README.md).
+### Starting securityTests using the UI
+
+When a scan is started via the Camunda UI, the scan is considered to be a manual scans. This means that its results has to be confirmed before they it gets persisted by the configured persistence provider (e.g. elasticsearch). The results will show up in the tasklist and will get persistet once their the task has been marked as completed.
+
+### Starting securityTests using the REST-API
 
-## Starting securityTests using the REST-API
+When a scan is started via the REST-API, the scan is considered to be automated. This means that the results will get automatically persisted into the configured perssitence provider (e.g. elasticsearch). The results of the securityTest will however **not** show up in the tasklist. The securityTest will be completed directly and the results are only availible via the persistence provider or by accessing it via the Rest-API.
 
 In order to start a scan via the REST-API, send a PUT-Request to the following URL:
 `<<Engine_Address>>/box/securityTests`.
@@ -85,6 +90,12 @@ The scanning target is set within the payload. A securityTest running a nmap por
 
 You can check out a more detailed API documentation in the Swagger Docs of the secureCodeBox Engine. The Swagger Docs come together with the secureCodeBox Engine. You can access it at `<<Engine_Address>>/swagger-ui.html`. If you dont have one running yet you can look at the staticly exported version of it here: [Static API Docs](../developer-guide/api-doc.md)
 
+#### Meta Fields and How to use them
+
+MetaFields can be used to tag security tests with custom data relevant for you. We have encountered some data values which we found paticulary usefull and standardized their format to be used in multiple places. The list and formats can be found [here](./metafields/README.md).
+
+MetaFields can currently only be set via the rest api. See the swagger docs for how to set them.
+
 ### In Depth Scan Examples
 
 The following links contain completes examples and explanations how to set up and start scans against demo application.
