Update deviceRegistrationPolicy

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.

Update the properties of a deviceRegistrationPolicy object. Represents deviceRegistrationPolicy quota restrictions, additional authentication, and authorization policies to register device identities to your organization.

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 permissions	Higher privileged permissions
Delegated (work or school account)	Policy.ReadWrite.DeviceConfiguration	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Policy.ReadWrite.DeviceConfiguration	Not available.

When calling on behalf of a user, the user needs the Cloud Device Administrator Microsoft Entra role.

HTTP request

PUT /policies/deviceRegistrationPolicy

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 a deviceRegistrationPolicy object with all the updatable properties. The following table specifies the properties that can be updated.

Property	Type	Description
userDeviceQuota	Int32	Required. Specifies the maximum number of devices that a user can have within your organization before blocking new device registrations. Required.
multiFactorAuthConfiguration	multiFactorAuthConfiguration	Required. Specifies the authentication policy for a user to complete registration using Microsoft Entra join or Microsoft Entra registered within your organization. Possible values are: notRequired or required.
azureADRegistration	azureADRegistrationPolicy	Required. Specifies the authorization policy for controlling registration of new devices using Microsoft Entra registration within your organization. Required. For more information, see What is a device identity?. If Intune is enabled this property cannot be modified.
azureADJoin	azureADJoinPolicy	Required. Specifies the authorization policy for controlling the registration of new devices using Microsoft Entra join within your organization. For more information, see What is a device identity?.
localAdminPassword	localAdminPasswordSettings	Required. Specifies the setting for Local Admin Password Solution (LAPS) within your organization.

Response

If successful, this method returns a 200 OK response code and an updated deviceRegistrationPolicy object in the response body.

Examples

Request

HTTP

PUT https://graph.microsoft.com/beta/policies/deviceRegistrationPolicy
Content-Type: application/json

{
  "userDeviceQuota": 2,
  "multiFactorAuthConfiguration": "notRequired",
  "azureADRegistration": {
    "isAdminConfigurable": false,
    "allowedToRegister": {
      "@odata.type": "#microsoft.graph.enumeratedDeviceRegistrationMembership",
      "users": ["3c8ef067-8b96-44de-b2ae-557dfa0f97a0"],
      "groups": []
    },
  },
  "azureADJoin": {
    "isAdminConfigurable": true,
    "allowedToJoin": {
      "@odata.type": "#microsoft.graph.allDeviceRegistrationMembership"
    },
    "localAdmins": {
      "enableGlobalAdmins": false,
      "registeringUsers": {
        "@odata.type": "#microsoft.graph.noDeviceRegistrationMembership"
      }
    },
  },
  "localAdminPassword": {
    "isEnabled": true
  }
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const deviceRegistrationPolicy = {
  userDeviceQuota: 2,
  multiFactorAuthConfiguration: 'notRequired',
  azureADRegistration: {
    isAdminConfigurable: false,
    allowedToRegister: {
      '@odata.type': '#microsoft.graph.enumeratedDeviceRegistrationMembership',
      users: ['3c8ef067-8b96-44de-b2ae-557dfa0f97a0'],
      groups: []
    },
  },
  azureADJoin: {
    isAdminConfigurable: true,
    allowedToJoin: {
      '@odata.type': '#microsoft.graph.allDeviceRegistrationMembership'
    },
    localAdmins: {
      enableGlobalAdmins: false,
      registeringUsers: {
        '@odata.type': '#microsoft.graph.noDeviceRegistrationMembership'
      }
    },
  },
  localAdminPassword: {
    isEnabled: true
  }
};

await client.api('/policies/deviceRegistrationPolicy')
	.version('beta')
	.put(deviceRegistrationPolicy);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "deviceRegistrationPolicy",
  "displayName": "Device Registration Policy",
  "description": "Tenant-wide policy that manages intial provisioning controls using quota restrictions, additional authentication and authorization checks",
  "userDeviceQuota": 2,
  "multiFactorAuthConfiguration": "notRequired",
  "azureADRegistration": {
    "isAdminConfigurable": false,
    "allowedToRegister": {
      "@odata.type": "#microsoft.graph.enumeratedDeviceRegistrationMembership",
      "users": ["3c8ef067-8b96-44de-b2ae-557dfa0f97a0"],
      "groups": []
    },
  },
  "azureADJoin": {
    "isAdminConfigurable": true,
    "allowedToJoin": {
      "@odata.type": "#microsoft.graph.allDeviceRegistrationMembership"
    },
    "localAdmins": {
      "enableGlobalAdmins": false,
      "registeringUsers": {
        "@odata.type": "#microsoft.graph.noDeviceRegistrationMembership"
      }
    },
  },
  "localAdminPassword": {
    "isEnabled": true
  }
}