Skip to content

Commit b6a2cf4

Browse files
Merge pull request #9309 from WimJongeneel/ufc/cli-export-security-overview
Add docs for security overview export command
2 parents 7fb9928 + 60b5eff commit b6a2cf4

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

content/en/docs/refguide/general/mx-command-line-tool/_index.md

+4
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ These are the available [merging and diffing commands](/refguide/mx-command-line
7272
| [diff](/refguide/mx-command-line-tool/merge/#diff) | Shows the diff of the *.mpr* files. |
7373
| [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Create a JSON description of the model of a Mendix App |
7474

75+
### Security Overview Command
76+
77+
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).
78+
7579
## Undocumented Options
7680

7781
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.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "Security Overview Command"
3+
url: /refguide/mx-command-line-tool/security/
4+
weight: 50
5+
description: "Describes the commands related to the Security Overview"
6+
---
7+
8+
## Introduction
9+
10+
The command is related to the [Security Overview](/refguide/security-overview/).
11+
12+
## mx export-security-overview Command {#export-security-overview}
13+
14+
The `mx export-security-overview` command can be used to export the data in the Security Overview to either a *JSON* or *xlsx* file.
15+
16+
### Usage
17+
18+
Use the following command pattern: `mx export-security-overview [OPTIONS] [MPR-FILE]`
19+
20+
`OPTIONS` are presented in the table below::
21+
22+
| Option | Value | Result |
23+
|---------------------------|-------------------|----------|
24+
| `-t, --export-format` | `json` or `xlsx` | The format to export to. |
25+
| `-e, --exclude-appstore` | *-* | When set, excludes Marketplace modules. |
26+
| `-o, --output-file` | file path | The path to the output file. |
27+
28+
### Examples
29+
30+
An example of the command can be the following:
31+
32+
`mx export-security-overview -t json -e -o C:\MyApp\export.json C:\MyApp\MyApp.mpr`
33+
34+
### Return Codes
35+
36+
Return codes are presented in the table below:
37+
38+
| Return Code | Description |
39+
| ----------- | ---------------------------- |
40+
| 0 | Success. |
41+
| 200 | An internal error occurred. |
42+
| 400 | The MPR could not be loaded. |

content/en/docs/refguide/modeling/security/security-overview.md

+4
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ To export the **Security Overview**, click the **Export to Excel** button. This
9797
4. Anonymous role: Specifies whether this user roles is an anonymous user role.
9898
5. Administrator role: Specifies whether this user role is the administrator user role.
9999

100+
## CLI export
101+
102+
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.
103+
100104
## Read More
101105

102106
* [User Roles](/refguide/user-roles/)

0 commit comments

Comments
 (0)