Skip to content

Commit 98a6155

Browse files
LauragraLauragra
authored
Merge pull request #24303 from microsoftgraph/users/evandontje/securityScoreDocumentation
Partner Security Score API Documentation
2 parents fecf140 + 7be904a commit 98a6155

29 files changed

+1522
-6
lines changed

‎api-reference/beta/api/partner-security-partnersecurityscore-get.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: "Get partnerSecurityScore"
3+
description: "Read the properties and relationships of a partnerSecurityScore object."
4+
author: "evandontje-ms"
5+
ms.localizationpriority: medium
6+
ms.subservice: "partner-customer-administration"
7+
doc_type: apiPageType
8+
---
9+
10+
# Get partnerSecurityScore
11+
12+
Namespace: microsoft.graph.partner.security
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Read the properties and relationships of a [partnerSecurityScore](../resources/partner-security-partnersecurityscore.md) object.
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": "partner-security-partnersecurityscore-get-permissions"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/partner-security-partnersecurityscore-get-permissions.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
``` http
36+
GET /security/partner/securityScore
37+
```
38+
39+
## Optional query parameters
40+
41+
This method supports OData query parameters to customize the response. For example, the `$expand` parameter is useful to retrieve optional properties like **requirements** or **history**. For more information and examples, see [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 [microsoft.graph.partner.security.partnerSecurityScore](../resources/partner-security-partnersecurityscore.md) object in the response body.
56+
57+
## Examples
58+
59+
### Request
60+
61+
The following example shows a request.
62+
<!-- {
63+
"blockType": "request",
64+
"name": "get_partnersecurityscore"
65+
}
66+
-->
67+
``` http
68+
GET https://graph.microsoft.com/beta/security/partner/securityScore
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": "microsoft.graph.partner.security.partnerSecurityScore"
80+
}
81+
-->
82+
``` http
83+
HTTP/1.1 200 OK
84+
Content-Type: application/json
85+
86+
{
87+
"value": {
88+
"@odata.type": "#microsoft.graph.partner.security.partnerSecurityScore",
89+
"id": "9021efeb-af08-e3dd-9c11-ac69f92e43b8",
90+
"updatedDateTime": "2024-01-17T00:00:00Z",
91+
"lastRefreshDateTime":"2024-02-28T00:00:00Z",
92+
"currentScore": 14.29,
93+
"maxScore": 100.0
94+
}
95+
}
96+
```
97+

‎api-reference/beta/api/partner-security-partnersecurityscore-list-customerinsights.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: "List customerInsights"
3+
description: "Get a list of the customerInsight data and their properties."
4+
author: "evandontje-ms"
5+
ms.localizationpriority: medium
6+
ms.subservice: "partner-customer-administration"
7+
doc_type: apiPageType
8+
---
9+
10+
# List customerInsights
11+
12+
Namespace: microsoft.graph.partner.security
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get a list of the [customerInsight](../resources/partner-security-customerinsight.md) objects and their properties.
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": "partner-security-partnersecurityscore-list-customerinsights"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/partner-security-partnersecurityscore-list-customerinsights-permissions.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
``` http
36+
GET /security/partner/securityScore/customerInsights
37+
```
38+
39+
## Optional query parameters
40+
41+
This method supports OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
42+
43+
Server-side pagination is supported by following the `nextLink` provided in the API response when you use the `$skipToken` OData query parameter. Using client-side pagination with `$skip` and `$top` isn't supported.
44+
45+
## Request headers
46+
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
53+
Don't supply a request body for this method.
54+
55+
## Response
56+
57+
If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.partner.security.customerInsight](../resources/partner-security-customerinsight.md) objects in the response body.
58+
59+
## Examples
60+
61+
### Request
62+
63+
The following example shows a request.
64+
<!-- {
65+
"blockType": "request",
66+
"name": "list_customerinsight"
67+
}
68+
-->
69+
``` http
70+
GET https://graph.microsoft.com/beta/security/partner/securityScore/customerInsights
71+
```
72+
73+
74+
### Response
75+
76+
The following example shows the response.
77+
>**Note:** The response object shown here might be shortened for readability.
78+
<!-- {
79+
"blockType": "response",
80+
"truncated": true,
81+
"@odata.type": "Collection(microsoft.graph.partner.security.customerInsight)"
82+
}
83+
-->
84+
``` http
85+
HTTP/1.1 200 OK
86+
Content-Type: application/json
87+
88+
{
89+
"value": [
90+
{
91+
"@odata.type": "#microsoft.graph.partner.security.customerInsight",
92+
"tenantId": "d90cb160-123d-0608-3fd6-c53551dcc20c",
93+
"mfa": {
94+
"@odata.type": "microsoft.graph.partner.security.customerMfaInsight",
95+
"compliantAdminsCount": 1,
96+
"compliantNonAdminsCount": 2,
97+
"totalUsersCount": 5,
98+
"securityDefaultsStatus": "enabled",
99+
"mfaConditionalAccessPolicyStatus": "disabled",
100+
"legacyPerUserMfaStatus": "disabled"
101+
}
102+
}
103+
]
104+
}
105+
```
106+

‎api-reference/beta/api/partner-security-partnersecurityscore-list-history.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: "List securityScoreHistory"
3+
description: "Lists the history of security score changes for the partner."
4+
author: "evandontje-ms"
5+
ms.localizationpriority: medium
6+
ms.subservice: "partner-customer-administration"
7+
doc_type: apiPageType
8+
---
9+
10+
# List securityScoreHistory
11+
12+
Namespace: microsoft.graph.partner.security
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get a list of [securityScoreHistory](../resources/partner-security-securityscorehistory.md) entries.
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": "partner-security-partnersecurityscore-list-history"
25+
}
26+
-->
27+
[!INCLUDE [permissions-table](../includes/permissions/partner-security-partnersecurityscore-list-history-permissions.md)]
28+
29+
## HTTP request
30+
31+
<!-- {
32+
"blockType": "ignored"
33+
}
34+
-->
35+
``` http
36+
GET /security/partner/securityScore/history
37+
```
38+
39+
## Optional query parameters
40+
41+
This method supports some of the OData query parameters to help customize the response. For general information, see [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.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.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_securityscorehistory"
65+
}
66+
-->
67+
``` http
68+
GET https://graph.microsoft.com/beta/security/partner/securityScore/history
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.partner.security.securityScoreHistory)"
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.partner.security.securityScoreHistory",
90+
"id": "a368fa06-ba31-2d7e-3b0c-2ded0b0c093e",
91+
"createdDateTime": "2024-01-17T00:00:00Z",
92+
"score": 14.29,
93+
"compliantRequirementsCount": 4,
94+
"totalRequirementsCount": 5
95+
}
96+
]
97+
}
98+
```
99+

0 commit comments

Comments
 (0)