Skip to content

Commit 4be52db

Browse files
learn-build-service-prod[bot]learn-build-service-prod[bot]
authored
Merge pull request #28165 from microsoftgraph/main
Auto Publish – main to live - 2026-01-30 00:30 UTC
2 parents e056517 + 86e1d7f commit 4be52db

31 files changed

Lines changed: 560 additions & 57 deletions

‎.github/prompts/author-api-docs.prompt.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -480,13 +480,17 @@ For each copied file, make the following updates:
480480
3. **Update the `ms.date` field** in the YAML front matter to today's date
481481

482482
**For API method files:**
483-
1. **Remove SDK snippet links** from the Example Request section:
483+
1. **Delete the national cloud include statement** that appears immediately before the "## Permissions" header:
484+
- Remove the entire include statement (e.g., `[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]`)
485+
- This include should be deleted for v1.0 GA documentation
486+
487+
2. **Remove SDK snippet links** from the Example Request section:
484488
- Remove the `# [HTTP](#tab/http)` tab
485489
- Remove the tab boundary marker (`---`)
486490
- Remove all language-specific SDK snippet include links (e.g., `[!INCLUDE [sample-code](../includes/snippets/csharp/...)]`)
487491
- Keep only the HTTP example in the Request section
488492

489-
2. **Verify examples work with v1.0 endpoint:**
493+
3. **Verify examples work with v1.0 endpoint:**
490494
- Run each example using the v1.0 endpoint to ensure all properties are returned in v1.0
491495
- Remove any properties from examples that are not returned in v1.0
492496
- Ensure request URLs use `graph.microsoft.com/v1.0/` not `graph.microsoft.com/beta/`
@@ -604,6 +608,7 @@ Remove "(preview)" from TOC entries as applicable:
604608
**For API method files promoted to v1.0:**
605609
- [ ] File copied from beta\api to v1.0\api
606610
- [ ] Beta disclaimer removed
611+
- [ ] National cloud include statement deleted (immediately before ## Permissions header)
607612
- [ ] Version references updated from /beta to /v1.0 in all examples
608613
- [ ] ms.date updated in YAML front matter
609614
- [ ] SDK snippet links removed from Example Request section

‎api-reference/beta/resources/security-ediscoverypurgedataoperation.md‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ None.
2929
|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3030
|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3131
|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).|
32+
|reportFileMetadata|[microsoft.graph.security.reportFileMetadata](../resources/security-ediscoveryreportfilemetadata.md) collection|The purge job report file metadata. It contains the properties for report file metadata, including **downloadUrl**, **fileName**, and **size**.|
3233
|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3334
|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. The possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`, `unknownFutureValue`. Inherited from [caseOperation](../resources/security-caseoperation.md).|
3435

@@ -64,18 +65,15 @@ The following JSON representation shows the resource type.
6465
``` json
6566
{
6667
"@odata.type": "#microsoft.graph.security.ediscoveryPurgeDataOperation",
67-
"id": "String (identifier)",
68-
"createdDateTime": "String (timestamp)",
69-
"completedDateTime": "String (timestamp)",
7068
"action": "String",
71-
"createdBy": {
72-
"@odata.type": "microsoft.graph.identitySet"
73-
},
74-
"percentProgress": "Integer",
75-
"status": "String",
76-
"resultInfo": {
77-
"@odata.type": "microsoft.graph.resultInfo"
78-
}
69+
"completedDateTime": "String (timestamp)",
70+
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
71+
"createdDateTime": "String (timestamp)",
72+
"id": "String (identifier)",
73+
"percentProgress": "Int32",
74+
"reportFileMetadata": [{"@odata.type": "microsoft.graph.reportFileMetadata"}],
75+
"resultInfo": {"@odata.type": "microsoft.graph.resultInfo"},
76+
"status": "String"
7977
}
8078
```
8179

‎api-reference/beta/toc/security/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -748,6 +748,8 @@ items:
748748
href: ../../resources/security-ediscoveryaddtoreviewsetoperation.md
749749
- name: eDiscovery estimate operation
750750
href: ../../resources/security-ediscoveryestimateoperation.md
751+
- name: eDiscovery purge data operation
752+
href: ../../resources/security-ediscoverypurgedataoperation.md
751753
- name: Report file metadata
752754
href: ../../resources/security-ediscoveryreportfilemetadata.md
753755
- name: Email and collaboration protection

‎api-reference/beta/toc/toc.mapping.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2954,6 +2954,7 @@
29542954
"complexTypes": [
29552955
"microsoft.graph.security.ediscoveryAddToReviewSetOperation",
29562956
"microsoft.graph.security.ediscoveryEstimateOperation",
2957+
"microsoft.graph.security.ediscoveryPurgeDataOperation",
29572958
"microsoft.graph.security.reportFileMetadata"
29582959
]
29592960
},

‎api-reference/v1.0/api/externalauthenticationmethodconfiguration-delete.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: "Delete externalAuthenticationMethodConfiguration"
3+
description: "Delete an externalAuthenticationMethodConfiguration object."
4+
author: "gregkmsft"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: apiPageType
8+
ms.date: 01/19/2026
9+
---
10+
11+
# Delete externalAuthenticationMethodConfiguration
12+
13+
Namespace: microsoft.graph
14+
15+
Delete an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.
16+
17+
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
18+
19+
## Permissions
20+
21+
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).
22+
23+
<!-- { "blockType": "permissions", "name": "externalauthenticationmethodconfiguration_delete" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/externalauthenticationmethodconfiguration-delete-permissions.md)]
25+
26+
[!INCLUDE [rbac-authentication-methods-policy-apis-write](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-write.md)]
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
```http
35+
DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}
36+
```
37+
38+
## Request headers
39+
40+
|Name|Description|
41+
|:---|:---|
42+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
43+
44+
## Request body
45+
46+
Don't supply a request body for this method.
47+
48+
## Response
49+
50+
If successful, this method returns a `204 No Content` response code.
51+
52+
## Examples
53+
54+
### Request
55+
56+
The following example shows a request.
57+
<!-- {
58+
"blockType": "request",
59+
"name": "delete_externalauthenticationmethodconfiguration"
60+
}
61+
-->
62+
```http
63+
DELETE https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b3107ab7-68c7-4553-a167-48c1e9c24d52
64+
```
65+
66+
### Response
67+
68+
The following example shows the response.
69+
<!-- {
70+
"blockType": "response",
71+
"truncated": true
72+
}
73+
-->
74+
```http
75+
HTTP/1.1 204 No Content
76+
```
77+

‎api-reference/v1.0/api/externalauthenticationmethodconfiguration-get.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "Get externalAuthenticationMethodConfiguration"
3+
description: "Read the properties and relationships of an externalAuthenticationMethodConfiguration object."
4+
author: "gregkmsft"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: apiPageType
8+
ms.date: 01/19/2026
9+
---
10+
11+
# Get externalAuthenticationMethodConfiguration
12+
13+
Namespace: microsoft.graph
14+
15+
Read the properties and relationships of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.
16+
17+
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
18+
19+
## Permissions
20+
21+
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).
22+
23+
<!-- { "blockType": "permissions", "name": "externalauthenticationmethodconfiguration_get" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/externalauthenticationmethodconfiguration-get-permissions.md)]
25+
26+
[!INCLUDE [rbac-authentication-methods-policy-apis-read](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-read.md)]
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
```http
35+
GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}
36+
```
37+
38+
## Optional query parameters
39+
40+
This method does not support OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
41+
42+
## Request headers
43+
44+
|Name|Description|
45+
|:---|:---|
46+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
47+
48+
## Request body
49+
50+
Don't supply a request body for this method.
51+
52+
## Response
53+
54+
If successful, this method returns a `200 OK` response code and an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object in the response body.
55+
56+
## Examples
57+
58+
### Request
59+
60+
The following example shows a request.
61+
<!-- {
62+
"blockType": "request",
63+
"name": "get_externalauthenticationmethodconfiguration"
64+
}
65+
-->
66+
```http
67+
GET https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b3107ab7-68c7-4553-a167-48c1e9c24d52
68+
```
69+
70+
### Response
71+
72+
The following example shows the response.
73+
>**Note:** The response object shown here might be shortened for readability.
74+
<!-- {
75+
"blockType": "response",
76+
"truncated": true,
77+
"@odata.type": "microsoft.graph.externalAuthenticationMethodConfiguration"
78+
}
79+
-->
80+
```http
81+
HTTP/1.1 200 OK
82+
Content-Type: application/json
83+
84+
{
85+
"@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration",
86+
"id": "b3107ab7-68c7-4553-a167-48c1e9c24d52",
87+
"displayName": "Adatum",
88+
"appId": "fb262304-618c-4ffb-878a-114490bdf200",
89+
"openIdConnectSetting": {
90+
"clientId": "06a011bd-ec92-4404-80fb-db6d5ada8ee2",
91+
"discoveryUrl": "https//Adatum.com/.well-known/openid-configuration"
92+
},
93+
"state": "disabled",
94+
"excludeTargets": [],
95+
"includeTargets": []
96+
}
97+
```
98+

‎api-reference/v1.0/api/externalauthenticationmethodconfiguration-update.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: "Update externalAuthenticationMethodConfiguration"
3+
description: "Update the properties of an externalAuthenticationMethodConfiguration object."
4+
author: "gregkmsft"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: apiPageType
8+
ms.date: 01/19/2026
9+
---
10+
11+
# Update externalAuthenticationMethodConfiguration
12+
13+
Namespace: microsoft.graph
14+
15+
Update the properties of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.
16+
17+
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
18+
19+
## Permissions
20+
21+
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).
22+
23+
<!-- { "blockType": "permissions", "name": "externalauthenticationmethodconfiguration_update" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/externalauthenticationmethodconfiguration-update-permissions.md)]
25+
26+
[!INCLUDE [rbac-authentication-methods-policy-apis-write](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-write.md)]
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
```http
35+
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}
36+
```
37+
38+
## Request headers
39+
40+
|Name|Description|
41+
|:---|:---|
42+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
43+
|Content-Type|application/json. Required.|
44+
45+
## Request body
46+
47+
[!INCLUDE [table-intro](../../includes/update-property-table-intro.md)]
48+
49+
50+
|Property|Type|Description|
51+
|:---|:---|:---|
52+
|appId|String|**appId** for the app registration in Microsoft Entra ID representing the integration with the external provider.|
53+
|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups representing the users that should be excluded from the policy. |
54+
|includeTargets|[authenticationMethodTarget](../resources/authenticationMethodTarget.md) collection|Groups representing the users that are included in the policy and that can use the external authentication method. |
55+
|state|authenticationMethodState|The state of the method in the policy. The possible values are: `enabled`, `disabled`. |
56+
|openIdConnectSetting|[openIdConnectSetting](../resources/openidconnectsetting.md)|Object representing the required settings for the OIDC request to the external provider.|
57+
58+
59+
60+
## Response
61+
62+
If successful, this method returns a `204 No Content` response code.
63+
64+
## Examples
65+
66+
### Request
67+
68+
The following example shows a request.
69+
<!-- {
70+
"blockType": "request",
71+
"name": "update_externalauthenticationmethodconfiguration"
72+
}
73+
-->
74+
```http
75+
PATCH https://graph.microsoft.com/v1.0/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b183b746-e7db-4fa2-bafc-69ecf18850dd
76+
Content-Type: application/json
77+
78+
{
79+
"@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration",
80+
"includeTargets": [
81+
{
82+
"targetType": "group",
83+
"id": "b183b746-e7db-4fa2-bafc-69ecf18850dd",
84+
"isRegistrationRequired": false,
85+
}
86+
],
87+
"state": "enabled"
88+
}
89+
90+
```
91+
92+
### Response
93+
94+
The following example shows the response.
95+
<!-- {
96+
"blockType": "response",
97+
"truncated": true
98+
}
99+
-->
100+
```http
101+
HTTP/1.1 204 No Content
102+
```
103+

‎api-reference/v1.0/includes/permissions/externalauthenticationmethodconfiguration-delete-permissions.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Policy.ReadWrite.AuthenticationMethod|Not available.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Policy.ReadWrite.AuthenticationMethod|Not available.|
12+

‎api-reference/v1.0/includes/permissions/externalauthenticationmethodconfiguration-get-permissions.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Policy.Read.AuthenticationMethod|Policy.Read.All, Policy.ReadWrite.AuthenticationMethod|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Policy.Read.AuthenticationMethod|Policy.Read.All, Policy.ReadWrite.AuthenticationMethod|
12+

‎api-reference/v1.0/includes/permissions/externalauthenticationmethodconfiguration-update-permissions.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Policy.ReadWrite.AuthenticationMethod|Not available.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Policy.ReadWrite.AuthenticationMethod|Not available.|
12+

0 commit comments

Comments
 (0)