Skip to content

Commit 4832634

Browse files
committed
update docs
1 parent cc506f4 commit 4832634

3 files changed

Lines changed: 33 additions & 51 deletions

File tree

docs/authentication/limitations.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/authentication/sp_authentication/getting_started.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,26 @@ To set up a service principal for use with Monkey365, you’ll need to follow th
3232
- Go to API permissions > Add a permission.
3333
- Add the necessary **application permissions** for Monkey365:
3434
- **Microsoft Graph** (Select Microsoft Graph API under *Commonly used Microsoft APIs*)
35-
- User.Read.All,
36-
- Application.Read.All,
37-
- Policy.Read.All,
38-
- Organization.Read.All,
39-
- RoleManagement.Read.Directory,
40-
- GroupMember.Read.All,
41-
- Directory.Read.All,
42-
- PrivilegedEligibilitySchedule.Read.AzureADGroup,
43-
- PrivilegedAccess.Read.AzureADGroup,
44-
- RoleManagementPolicy.Read.AzureADGroup,
45-
- Group.Read.All,
46-
- SecurityEvents.Read.All,
35+
- AccessReview.Read.All
36+
- Application.Read.All
37+
- AuditLog.Read.All
38+
- DeviceManagementConfiguration.Read.All
39+
- DeviceManagementServiceConfig.Read.All
40+
- Directory.Read.All
41+
- Group.Read.All
42+
- GroupMember.Read.All
4743
- IdentityRiskEvent.Read.All
44+
- Organization.Read.All
45+
- OrgSettings-AppsAndServices.Read.All
46+
- OrgSettings-Forms.Read.All
47+
- Policy.Read.All
48+
- Policy.Read.AuthenticationMethod
49+
- PrivilegedEligibilitySchedule.Read.AzureADGroup
50+
- PrivilegedAccess.Read.AzureADGroup
51+
- RoleManagement.Read.Directory
52+
- RoleManagementPolicy.Read.AzureADGroup
53+
- SecurityEvents.Read.All
54+
- User.Read.All
4855
- UserAuthenticationMethod.Read.All
4956
???+ note
5057
For Microsoft Teams, the following permissions should be included:

docs/exporting/exporting-data.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,17 @@ Monkey365 has built-in support for exporting data to a large variety of formats,
1212

1313
## Data Location
1414

15-
Depending on what format you are exporting to, the ```-ExportTo``` parameter presents you with slightly different options. Once Monkey365 has finished running, all the exported data are stored under Monkey365/monkey-reports/$GUID/$FORMAT/$FILE. The following demonstrates some examples in which the data may be programmatically accessed using various common languages.
15+
Depending on what format you are exporting to, the ```-ExportTo``` parameter presents slightly different options. When ```-OutDir``` is specified, Monkey365 writes the exported data to the provided path. When ```-OutDir``` is not specified, Monkey365 creates the output under the current working directory.
16+
17+
By default, exported data is stored using the following structure:
18+
19+
```./monkey365-output/$GUID/$FORMAT/$FILE```
20+
21+
For example, if Monkey365 is executed from ```/home/user/cloud_reports```, the default output path will be:
22+
23+
```/home/user/cloud_reports/monkey365-output/$GUID/$FORMAT/$FILE```
24+
25+
The following demonstrates some examples in which the data may be programmatically accessed using various common languages.
1626

1727
### Import JSON data in Python
1828

@@ -21,7 +31,7 @@ The following code snippet illustrates how one may load the Monkey365 data in a
2131
``` json
2232
import json
2333

24-
file = 'C:/temp/monkey365/monkey-reports/00000000-0000-0000-0000-000000000000/json/monkey3650000000000000000000000000000000020240902155926.json'
34+
file = 'C:/temp/monkey365-output/00000000-0000-0000-0000-000000000000/json/monkey3650000000000000000000000000000000020240902155926.json'
2535

2636
with open(file) as f:
2737

@@ -35,14 +45,14 @@ with open(file) as f:
3545
The following code snippet illustrates how one may load the Monkey365 data in a PowerShell script (assuming that report data was previously exported to JSON format):
3646

3747
``` powershell
38-
PS C:\temp\monkey365> $json_data = (Get-Content -Raw .\monkey-reports\00000000-0000-0000-0000-000000000000\json\monkey3650000000000000000000000000000000020240902155926.json) | ConvertFrom-Json
48+
PS C:\temp> $json_data = (Get-Content -Raw .\monkey365-output\00000000-0000-0000-0000-000000000000\json\monkey3650000000000000000000000000000000020240902155926.json) | ConvertFrom-Json
3949
```
4050

4151
### Import CLIXML data in PowerShell
4252

4353
The following code snippet illustrates how one may load the Monkey365 data in a PowerShell script (assuming that report data was previously exported to CLIXML format):
4454

4555
``` powershell
46-
PS C:\temp\monkey365> $clixml_data = (Get-Content -Raw .\monkey-reports\00000000-0000-0000-0000-000000000000\clixml\monkey3650000000000000000000000000000000020240902155926.clixml)
56+
PS C:\temp> $clixml_data = (Get-Content -Raw .\monkey365-output\00000000-0000-0000-0000-000000000000\clixml\monkey3650000000000000000000000000000000020240902155926.clixml)
4757
```
4858

0 commit comments

Comments
 (0)