diff --git a/content/en/docs/refguide/general/mx-command-line-tool/_index.md b/content/en/docs/refguide/general/mx-command-line-tool/_index.md index 002a10d4d40..486abf88f35 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/_index.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/_index.md @@ -74,6 +74,10 @@ These are the available [merging and diffing commands](/refguide/mx-command-line | [diff](/refguide/mx-command-line-tool/merge/#diff) | Shows the diff of the *.mpr* files. | | [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Create a JSON description of the model of a Mendix App | +### Security Overview Command + +The available `export-security-overview` exports the [Security Overview](/refguide/security-overview/). For more information, see [Security Overview Command](/refguide/mx-command-line-tool/security/#export-security-overview). + ## Undocumented Options The mx tool contains options that are not described in this document. These options are for internal Mendix usage and are not officially supported. This might change in the future, but these options are used at your own risk. diff --git a/content/en/docs/refguide/general/mx-command-line-tool/security.md b/content/en/docs/refguide/general/mx-command-line-tool/security.md new file mode 100644 index 00000000000..0ea5451c353 --- /dev/null +++ b/content/en/docs/refguide/general/mx-command-line-tool/security.md @@ -0,0 +1,42 @@ +--- +title: "Security Overview Command" +url: /refguide/mx-command-line-tool/security/ +weight: 50 +description: "Describes the commands related to the Security Overview" +--- + +## Introduction + +The command is related to the [Security Overview](/refguide/security-overview/). + +## mx export-security-overview Command {#export-security-overview} + +The `mx export-security-overview` command can be used to export the data in the Security Overview to either a *JSON* or *xlsx* file. + +### Usage + +Use the following command pattern: `mx export-security-overview [OPTIONS] [MPR-FILE]` + + `OPTIONS` are presented in the table below:: + +| Option | Value | Result | +|---------------------------|-------------------|----------| +| `-t, --export-format` | `json` or `xlsx` | The format to export to. | +| `-e, --exclude-appstore` | *-* | When set, excludes Marketplace modules. | +| `-o, --output-file` | file path | The path to the output file. | + +### Examples + +An example of the command can be the following: + +`mx export-security-overview -t json -e -o C:\MyApp\export.json C:\MyApp\MyApp.mpr` + +### Return Codes + +Return codes are presented in the table below: + +| Return Code | Description | +| ----------- | ---------------------------- | +| 0 | Success. | +| 200 | An internal error occurred. | +| 400 | The MPR could not be loaded. | \ No newline at end of file diff --git a/content/en/docs/refguide/modeling/security/security-overview.md b/content/en/docs/refguide/modeling/security/security-overview.md index 73f7d3ace9c..c3bf7a04306 100644 --- a/content/en/docs/refguide/modeling/security/security-overview.md +++ b/content/en/docs/refguide/modeling/security/security-overview.md @@ -99,6 +99,10 @@ To export the **Security Overview**, click the **Export to Excel** button. This 4. Anonymous role: Specifies whether this user roles is an anonymous user role. 5. Administrator role: Specifies whether this user role is the administrator user role. +## CLI export + +The security overview can be exported to a JSON or xlsx file with the `mx` command line tool. See the [export-security-overview](/refguide/mx-command-line-tool/security/#export-security-overview) command. + ## Read More * [User Roles](/refguide/user-roles/)