Skip to content

Commit 54ef2f2

Browse files
LauragraLauragra
authored
Merge pull request #24329 from microsoftgraph/nmargalit/mda-discovery
MDA Discovery API
2 parents 24ba99e + f98b842 commit 54ef2f2

File tree

31 files changed

+2287
-0
lines changed

31 files changed

+2287
-0
lines changed

‎api-reference/beta/api/security-cloudappdiscoveryreport-aggregatedappsdetails.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
title: "cloudAppDiscoveryReport: aggregatedAppsDetails"
3+
description: "Get the aggregated details of discovered apps by providing the time period."
4+
author: "nechamam"
5+
ms.localizationpriority: medium
6+
ms.subservice: "security"
7+
doc_type: apiPageType
8+
---
9+
10+
# cloudAppDiscoveryReport: aggregatedAppsDetails
11+
12+
Namespace: microsoft.graph.security
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get the [aggregated details](../resources/security-discoveredcloudappdetail.md) of discovered apps by providing the time period. The supported time periods are the last 7, 30, or 90 days.
17+
18+
## Permissions
19+
20+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- {
23+
"blockType": "permissions",
24+
"name": "security_cloudappdiscoveryreport_aggregatedappsdetails"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/security-cloudappdiscoveryreport-aggregatedappsdetails-permissions.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
``` http
36+
GET /security/dataDiscovery/cloudAppDiscovery/uploadedStreams/{streamId}/microsoft.graph.security.aggregatedAppsDetails(period=duration'{duration}')
37+
```
38+
39+
## Function parameters
40+
41+
The following table lists the parameters that are required when you call this function.
42+
43+
|Parameter|Type|Description|
44+
|:---|:---|:---|
45+
|period|Duration|Provide the time frame in which you want to query the data. Supported time frames are the last 7, 30, or 90 days.|
46+
47+
## Optional query parameters
48+
49+
This method supports the `$select`, `$filter`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
50+
51+
## Request headers
52+
53+
|Name|Description|
54+
|:---|:---|
55+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
56+
57+
## Request body
58+
59+
Don't supply a request body for this method.
60+
61+
## Response
62+
63+
If successful, this function returns a `200 OK` response code and a collection of [microsoft.graph.security.discoveredCloudAppDetail](../resources/security-discoveredcloudappdetail.md) objects in the response body.
64+
65+
## Examples
66+
67+
### Request
68+
69+
The following example shows a request.
70+
<!-- {
71+
"blockType": "request",
72+
"name": "cloudappdiscoveryreportthis.aggregatedappsdetails"
73+
}
74+
-->
75+
``` http
76+
GET https://graph.microsoft.com/beta/security/dataDiscovery/cloudAppDiscovery/uploadedStreams/93b60b3e-3a28-bf33-2d73-3cb0199c5f7a/microsoft.graph.security.aggregatedAppsDetails(period=duration'P90D')
77+
```
78+
79+
### Response
80+
81+
The following example shows the response.
82+
>**Note:** The response object shown here might be shortened for readability.
83+
<!-- {
84+
"blockType": "response",
85+
"truncated": true,
86+
"@odata.type": "Collection(microsoft.graph.security.discoveredCloudAppDetail)"
87+
}
88+
-->
89+
``` http
90+
HTTP/1.1 200 OK
91+
Content-Type: application/json
92+
93+
{
94+
"value": [
95+
{
96+
"@odata.type": "#microsoft.graph.security.discoveredCloudAppDetail",
97+
"id": "12345",
98+
"displayName": "Example App",
99+
"tags": [
100+
"Sanctioned"
101+
],
102+
"riskScore": 8,
103+
"uploadNetworkTrafficInBytes": 1024,
104+
"downloadNetworkTrafficInBytes": 2048,
105+
"transactionCount": 20,
106+
"ipAddressCount": 5,
107+
"userCount": 3,
108+
"lastSeenDateTime": "2024-06-13T00:00:00Z",
109+
"domains": [
110+
"example.com"
111+
],
112+
"category": "health"
113+
}
114+
]
115+
}
116+
```
117+

‎api-reference/beta/api/security-datadiscoveryreport-list-uploadedstreams.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
title: "List uploadedStreams"
3+
description: "Get visibility into all the manually uploaded streams from your firewalls and proxies."
4+
author: "nechamam"
5+
ms.localizationpriority: medium
6+
ms.subservice: "security"
7+
doc_type: apiPageType
8+
---
9+
10+
# List uploadedStreams
11+
12+
Namespace: microsoft.graph.security
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get visibility into all the manually uploaded streams from your firewalls and proxies.
17+
18+
## Permissions
19+
20+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- {
23+
"blockType": "permissions",
24+
"name": "security_datadiscoveryreport_list_uploadedstreams"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/security-datadiscoveryreport-list-uploadedstreams-permissions.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
``` http
36+
GET /security/dataDiscovery/cloudAppDiscovery/uploadedStreams
37+
```
38+
39+
## Optional query parameters
40+
41+
This method doesn't currently support [OData query parameters](/graph/query-parameters).
42+
43+
## Request headers
44+
45+
|Name|Description|
46+
|:---|:---|
47+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
48+
49+
## Request body
50+
51+
Don't supply a request body for this method.
52+
53+
## Response
54+
55+
If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.cloudAppDiscoveryReport](../resources/security-cloudappdiscoveryreport.md) objects in the response body.
56+
57+
## Examples
58+
59+
### Request
60+
61+
The following example shows a request.
62+
<!-- {
63+
"blockType": "request",
64+
"name": "list_uploadedstreams"
65+
}
66+
-->
67+
``` http
68+
GET https://graph.microsoft.com/beta/security/dataDiscovery/cloudAppDiscovery/uploadedStreams
69+
```
70+
71+
72+
### Response
73+
74+
The following example shows the response.
75+
>**Note:** The response object shown here might be shortened for readability.
76+
<!-- {
77+
"blockType": "response",
78+
"truncated": true,
79+
"@odata.type": "Collection(microsoft.graph.security.cloudAppDiscoveryReport)"
80+
}
81+
-->
82+
``` http
83+
HTTP/1.1 200 OK
84+
Content-Type: application/json
85+
86+
{
87+
"value": [
88+
{
89+
"@odata.type": "#microsoft.graph.security.cloudAppDiscoveryReport",
90+
"id": "e05b6a3f-629f-c591-6ce5-2bdc3d962faf",
91+
"displayName": "Checkpoint report",
92+
"createdDateTime": "2024-06-13T13:03:40.887Z",
93+
"lastDataReceivedDateTime": null,
94+
"lastModifiedDateTime": "2024-06-13T13:03:40.887Z",
95+
"receiverProtocol": "ftp",
96+
"supportedEntityTypes": [
97+
"ipAddress",
98+
"userName"
99+
],
100+
"supportedTrafficTypes": [
101+
"uploadedBytes",
102+
"downloadedBytes"
103+
],
104+
"anonymizeMachineData": false,
105+
"anonymizeUserData": true,
106+
"logDataProvider": "checkpoint",
107+
"description": "Checkpoint cloud discovery report",
108+
"logFileCount": 5,
109+
"isSnapshotReport": false
110+
}
111+
]
112+
}
113+
```

‎api-reference/beta/api/security-discoveredcloudappdetail-get.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: "Get discoveredCloudAppDetail"
3+
description: "Get an overview of the usage of discovered cloud apps."
4+
author: "nechamam"
5+
ms.localizationpriority: medium
6+
ms.subservice: "security"
7+
doc_type: apiPageType
8+
---
9+
10+
# Get discoveredCloudAppDetail
11+
12+
Namespace: microsoft.graph.security
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get an overview of the [usage of discovered cloud apps](../resources/security-discoveredcloudappdetail.md).
17+
18+
## Permissions
19+
20+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- {
23+
"blockType": "permissions",
24+
"name": "security_discoveredcloudappdetail_get"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/security-discoveredcloudappdetail-get-permissions.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
``` http
36+
GET /security/dataDiscovery/cloudAppDiscovery/uploadedStreams/{streamId}/microsoft.graph.security.aggregatedAppsDetails(period=duration'{duration}')/{appId}
37+
```
38+
39+
> [!NOTE]
40+
> `period` is a required parameter of type Duration that specifies the time frame for querying the data. Supported time frames include the last 7, 30, or 90 days.
41+
42+
## Optional query parameters
43+
44+
This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
45+
46+
## Request headers
47+
48+
|Name|Description|
49+
|:---|:---|
50+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
51+
52+
## Request body
53+
54+
Don't supply a request body for this method.
55+
56+
## Response
57+
58+
If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.discoveredCloudAppDetail](../resources/security-discoveredcloudappdetail.md) object in the response body.
59+
60+
## Examples
61+
62+
### Request
63+
64+
The following example shows a request.
65+
<!-- {
66+
"blockType": "request",
67+
"name": "get_discoveredcloudappdetail"
68+
}
69+
-->
70+
``` http
71+
GET https://graph.microsoft.com/beta/security/dataDiscovery/cloudAppDiscovery/uploadedStreams/93b60b3e-3a28-bf33-2d73-3cb0199c5f7a/microsoft.graph.security.aggregatedAppsDetails(period=duration'P90D')/12345
72+
```
73+
74+
75+
### Response
76+
77+
The following example shows the response.
78+
>**Note:** The response object shown here might be shortened for readability.
79+
<!-- {
80+
"blockType": "response",
81+
"truncated": true,
82+
"@odata.type": "microsoft.graph.security.discoveredCloudAppDetail"
83+
}
84+
-->
85+
``` http
86+
HTTP/1.1 200 OK
87+
Content-Type: application/json
88+
89+
{
90+
"@odata.type": "#microsoft.graph.security.discoveredCloudAppDetail",
91+
"id": "12345",
92+
"displayName": "Example App",
93+
"tags": [
94+
"Sanctioned"
95+
],
96+
"riskScore": 8,
97+
"uploadNetworkTrafficInBytes": 1024,
98+
"downloadNetworkTrafficInBytes": 2048,
99+
"transactionCount": 20,
100+
"ipAddressCount": 5,
101+
"userCount": 3,
102+
"lastSeenDateTime": "2024-06-13T00:00:00Z",
103+
"domains": [
104+
"example.com"
105+
],
106+
"category": "health"
107+
}
108+
```
109+

0 commit comments

Comments
 (0)