Edit

Share via

Create onPremAuthenticationPolicy

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new onPremAuthenticationPolicy object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Permissions

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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permission Higher privileged permissions
Delegated (work or school account) Policy.ReadWrite.OnPremAuthenticationPolicy Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Global Administrator

HTTP request

POST /policies/onPremAuthenticationPolicies

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the onPremAuthenticationPolicy object.

You can specify the following properties when creating an onPremAuthenticationPolicy.

Property Type Description
deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object isn't deleted. Inherited from directoryObject. Optional.
description String Description for this policy. Inherited from policyBase. Required.
displayName String Display name for this policy. Inherited from policyBase. Required.
definition String collection A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Inherited from stsPolicy. Required.
isOrganizationDefault Boolean If set to true, this instance of the policy will be considered the default for the organization. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. Inherited from stsPolicy. Optional.

Response

If successful, this method returns a 201 Created response code and an onPremAuthenticationPolicy object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/policies/onPremAuthenticationPolicies
Content-Type: application/json

{
  "description": "Policy definition to manage and control authentication settings.",
  "displayName": "Policy name",
  "definition": [
    "{\"Version\":1,\"LastUpdatedTimestamp\":\"2025-02-29T22:47:12.7764932Z\", \"Key1\": \"Value1\", \"Key2\": {\"SubKey1\": \"SubValue1\"}}"
  ],
  "isOrganizationDefault": true
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.onPremAuthenticationPolicy",
  "deletedDateTime": null,
  "description": "Updates to policy definition to manage and control authentication settings.",
  "displayName": "Update policy name",
  "definition": [
    "{\"Version\":1,\"LastUpdatedTimestamp\":\"2025-02-29T22:47:12.7764932Z\", \"Key1\": \"Value1\", \"Key2\": {\"SubKey1\": \"SubValue1\"}}"
  ],
  "isOrganizationDefault": true
}
  • Last updated on