Skip to content

Commit 33d38f8

Browse files
DanipocketDanipocket
authored
Merge pull request #27220 from microsoftgraph/maheshwaria/onPremAuthPolicy
adding onPremAuthPolicy api docs
2 parents 2ba1deb + 636aad9 commit 33d38f8

23 files changed

+1058
-5
lines changed

‎api-reference/beta/api/onpremauthenticationpolicy-delete-appliesto.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "Remove onPremAuthenticationPolicy appliesTo"
3+
description: "Remove a directoryObject object that's in scope for onPremAuthenticationPolicy."
4+
author: "maheshwaria"
5+
ms.date: 11/11/2025
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-sign-in"
8+
doc_type: apiPageType
9+
---
10+
11+
# Remove onPremAuthenticationPolicy appliesTo
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Remove a [directoryObject](../resources/directoryobject.md) object that's in scope for [onPremAuthenticationPolicy](../resources/onPremAuthenticationPolicy.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+
<!-- {
24+
"blockType": "permissions",
25+
"name": "onpremauthenticationpolicy-delete-appliesto-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/onpremauthenticationpolicy-delete-appliesto-permissions.md)]
29+
30+
[!INCLUDE [onpremauthenticationpolicy-entra-roles-write](../includes/rbac-for-apis/onpremauthenticationpolicy-entra-roles-write.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
DELETE /policies/onPremAuthenticationPolicies/{onPremAuthenticationPolicyId}/appliesTo/{id}/$ref
40+
```
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 `204 No Content` response code.
55+
56+
## Examples
57+
58+
### Request
59+
60+
The following example shows a request.
61+
<!-- {
62+
"blockType": "request",
63+
"name": "delete_appliesto_from_onpremauthenticationpolicy"
64+
}
65+
-->
66+
``` http
67+
DELETE https://graph.microsoft.com/beta/policies/onPremAuthenticationPolicies/{onPremAuthenticationPolicyId}/appliesTo/{id}/$ref
68+
```
69+
70+
71+
### Response
72+
73+
The following example shows the response.
74+
<!-- {
75+
"blockType": "response",
76+
"truncated": true
77+
}
78+
-->
79+
``` http
80+
HTTP/1.1 204 No Content
81+
```
82+

‎api-reference/beta/api/onpremauthenticationpolicy-delete.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: "Delete onPremAuthenticationPolicy"
3+
description: "Delete onPremAuthenticationPolicy."
4+
ms.localizationpriority: medium
5+
author: "maheshwaria"
6+
ms.subservice: "entra-sign-in"
7+
doc_type: "apiPageType"
8+
ms.date: 08/15/2025
9+
---
10+
11+
# Delete onPremAuthenticationPolicy
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Delete an [onPremAuthenticationPolicy](../resources/onpremauthenticationpolicy.md) object.
18+
19+
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
20+
21+
## Permissions
22+
23+
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).
24+
25+
<!-- {
26+
"blockType": "permissions",
27+
"name": "onpremauthenticationpolicy-delete-permissions"
28+
}
29+
-->
30+
[!INCLUDE [permissions-table](../includes/permissions/onpremauthenticationpolicy-delete-permissions.md)]
31+
32+
[!INCLUDE [onpremauthenticationpolicy-entra-roles-write](../includes/rbac-for-apis/onpremauthenticationpolicy-entra-roles-write.md)]
33+
34+
35+
## HTTP request
36+
37+
<!-- { "blockType": "ignored" } -->
38+
39+
```http
40+
DELETE /policies/onPremAuthenticationPolicies/{id}
41+
```
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 `204 No Content` response code.
56+
57+
## Examples
58+
59+
### Request
60+
61+
The following example shows a request.
62+
63+
64+
<!-- {
65+
"blockType": "request",
66+
"name": "delete_onpremauthenticationpolicy"
67+
}-->
68+
69+
```http
70+
DELETE https://graph.microsoft.com/beta/policies/onPremAuthenticationPolicies/2e68a8f2-50ce-b21d-d25d-c34b59675ee2
71+
```
72+
73+
74+
### Response
75+
76+
The following example shows the response.
77+
78+
<!-- {
79+
"blockType": "response",
80+
"truncated": true
81+
} -->
82+
83+
```http
84+
HTTP/1.1 204 No Content
85+
```
86+
87+
<!-- uuid: 35c6eb79-08c2-43ce-b897-949d56d54c5e
88+
2025-08-15 14:57:30 UTC -->
89+
<!-- {
90+
"type": "#page.annotation",
91+
"description": "Delete onPremAuthenticationPolicy",
92+
"keywords": "",
93+
"section": "documentation",
94+
"tocPath": ""
95+
}-->

‎api-reference/beta/api/onpremauthenticationpolicy-get.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: "Get onPremAuthenticationPolicy"
3+
description: "Read the properties and relationships of onPremAuthenticationPolicy object."
4+
author: "maheshwaria"
5+
ms.date: 09/10/2025
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-sign-in"
8+
doc_type: apiPageType
9+
---
10+
11+
# Get onPremAuthenticationPolicy
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Read the properties and relationships of [onPremAuthenticationPolicy](../resources/onpremauthenticationpolicy.md) object.
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+
<!-- {
24+
"blockType": "permissions",
25+
"name": "onpremauthenticationpolicy-get-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/onpremauthenticationpolicy-get-permissions.md)]
29+
30+
[!INCLUDE [onpremauthenticationpolicy-entra-roles-read](../includes/rbac-for-apis/onpremauthenticationpolicy-entra-roles-read.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
GET /policies/onPremAuthenticationPolicies/{onPremAuthenticationPolicyId}
40+
```
41+
42+
## Optional query parameters
43+
44+
This method supports the `$select`, `$filter`, and `$expand` OData query parameters to 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 an [onPremAuthenticationPolicy](../resources/onpremauthenticationpolicy.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_onpremauthenticationpolicy"
68+
}
69+
-->
70+
``` http
71+
GET https://graph.microsoft.com/beta/policies/onPremAuthenticationPolicies/2e68a8f2-50ce-b21d-d25d-c34b59675ee2
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.onPremAuthenticationPolicy"
83+
}
84+
-->
85+
``` http
86+
HTTP/1.1 200 OK
87+
Content-Type: application/json
88+
89+
{
90+
"@odata.type": "#microsoft.graph.onPremAuthenticationPolicy",
91+
"id": "2e68a8f2-50ce-b21d-d25d-c34b59675ee2",
92+
"deletedDateTime": null,
93+
"description": "Policy definition to manage and control authentication settings.",
94+
"displayName": "Demo policy name",
95+
"definition": [
96+
"{\"Version\":0,\"LastUpdatedTimestamp\":\"2025-01-28T22:47:12.7764932Z\", \"Key1\": \"Value1\", \"Key2\": {\"SubKey1\": \"SubValue1\"}}"
97+
],
98+
"isOrganizationDefault": true
99+
}
100+
```
101+

‎api-reference/beta/api/onpremauthenticationpolicy-list-appliesto.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: "List onPremAuthenticationPolicy appliesTo"
3+
description: "List directory objects that are assigned onPremAuthenticationPolicy"
4+
author: "maheshwaria"
5+
ms.date: 09/10/2025
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-sign-in"
8+
doc_type: apiPageType
9+
---
10+
11+
# List onPremAuthenticationPolicy appliesTo
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
List directory objects that are assigned an [onPremAuthenticationPolicy](../resources/onpremauthenticationpolicy.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+
<!-- {
24+
"blockType": "permissions",
25+
"name": "onpremauthenticationpolicy-list-appliesto-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/onpremauthenticationpolicy-list-appliesto-permissions.md)]
29+
30+
[!INCLUDE [onpremauthenticationpolicy-entra-roles-read](../includes/rbac-for-apis/onpremauthenticationpolicy-entra-roles-read.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
GET /policies/onPremAuthenticationPolicies/{onPremAuthenticationPolicyId}/appliesTo
40+
```
41+
42+
## Optional query parameters
43+
44+
This method supports the `$select`, `$filter`, and `$expand` OData query parameters to 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 collection of [directoryObject](../resources/directoryobject.md) objects in the response body.
59+
60+
## Examples
61+
62+
### Request
63+
64+
The following example shows a request.
65+
<!-- {
66+
"blockType": "request",
67+
"name": "list_onPremAuthAppliesTo_directoryobject"
68+
}
69+
-->
70+
``` http
71+
GET https://graph.microsoft.com/beta/policies/onPremAuthenticationPolicies/a6c034b8-621b-dee3-6abb-52cbce801fe9/appliesTo
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.directoryObject"
83+
}
84+
-->
85+
``` http
86+
HTTP/1.1 200 OK
87+
Content-Type: application/json
88+
89+
{
90+
"value": [
91+
{
92+
"@odata.type": "#microsoft.graph.directoryObject",
93+
"id": "a6c034b8-621b-dee3-6abb-52cbce801fe9",
94+
"deletedDateTime": null
95+
}
96+
]
97+
}
98+
```
99+

0 commit comments

Comments
 (0)