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

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Policy.ReadWrite.DeviceConfiguration
Delegated (personal Microsoft account)	Not supported
Application	Not supported

When calling on behalf of a user, the user needs the Cloud Device Administrator Azure AD role.

HTTP request

PUT /policies/deviceRegistrationPolicy

Request headers

Name	Description
Authorization	Bearer {token}. Required.
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 Azure AD Join or Azure AD registered within your organization. Possible values are: notRequired or required.
azureADRegistration	azureADRegistrationPolicy	Required. Specifies the authorization policy for controlling registration of new devices using Azure AD 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 registration of new devices using Azure AD Join within your organization. Required. 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

{
    "id": "deviceRegistrationPolicy",
    "displayName": "Device Registration Policy",
    "description": "Tenant-wide policy that manages intial provisioning controls using quota restrictions, additional authentication and authorization checks",
    "userDeviceQuota": 50,
    "multiFactorAuthConfiguration": "0",
    "azureADRegistration": {
        "appliesTo": "1",
        "isAdminConfigurable": false,
        "allowedUsers": [],
        "allowedGroups": []
    },
    "azureADJoin": {
        "appliesTo": "1",
        "isAdminConfigurable": true,
        "allowedUsers": [],
        "allowedGroups": []
    },
    "localAdminPassword": {
      "isEnabled": true
    }
}

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

DeviceRegistrationPolicy deviceRegistrationPolicy = new DeviceRegistrationPolicy();
deviceRegistrationPolicy.id = "deviceRegistrationPolicy";
deviceRegistrationPolicy.displayName = "Device Registration Policy";
deviceRegistrationPolicy.description = "Tenant-wide policy that manages intial provisioning controls using quota restrictions, additional authentication and authorization checks";
deviceRegistrationPolicy.userDeviceQuota = 50;
deviceRegistrationPolicy.multiFactorAuthConfiguration = MultiFactorAuthConfiguration.NOT_REQUIRED;
AzureADRegistrationPolicy azureADRegistration = new AzureADRegistrationPolicy();
azureADRegistration.appliesTo = PolicyScope.NONE;
azureADRegistration.isAdminConfigurable = false;
LinkedList<String> allowedUsersList = new LinkedList<String>();
azureADRegistration.allowedUsers = allowedUsersList;
LinkedList<String> allowedGroupsList = new LinkedList<String>();
azureADRegistration.allowedGroups = allowedGroupsList;
deviceRegistrationPolicy.azureADRegistration = azureADRegistration;
AzureAdJoinPolicy azureADJoin = new AzureAdJoinPolicy();
azureADJoin.appliesTo = PolicyScope.NONE;
azureADJoin.isAdminConfigurable = true;
LinkedList<String> allowedUsersList1 = new LinkedList<String>();
azureADJoin.allowedUsers = allowedUsersList1;
LinkedList<String> allowedGroupsList1 = new LinkedList<String>();
azureADJoin.allowedGroups = allowedGroupsList1;
deviceRegistrationPolicy.azureADJoin = azureADJoin;
LocalAdminPasswordSettings localAdminPassword = new LocalAdminPasswordSettings();
localAdminPassword.isEnabled = true;
deviceRegistrationPolicy.localAdminPassword = localAdminPassword;

graphClient.policies().deviceRegistrationPolicy()
	.buildRequest()
	.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.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const deviceRegistrationPolicy = {
    id: 'deviceRegistrationPolicy',
    displayName: 'Device Registration Policy',
    description: 'Tenant-wide policy that manages intial provisioning controls using quota restrictions, additional authentication and authorization checks',
    userDeviceQuota: 50,
    multiFactorAuthConfiguration: '0',
    azureADRegistration: {
        appliesTo: '1',
        isAdminConfigurable: false,
        allowedUsers: [],
        allowedGroups: []
    },
    azureADJoin: {
        appliesTo: '1',
        isAdminConfigurable: true,
        allowedUsers: [],
        allowedGroups: []
    },
    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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceRegistrationPolicy",
    "id": "deviceRegistrationPolicy",
    "displayName": "Device Registration Policy",
    "description": "Tenant-wide policy that manages intial provisioning controls using quota restrictions, additional authentication and authorization checks",
    "userDeviceQuota": 50,
    "multiFactorAuthConfiguration": "0",
    "azureADRegistration": {
        "appliesTo": "1",
        "isAdminConfigurable": false,
        "allowedUsers": [],
        "allowedGroups": []
    },
    "azureADJoin": {
        "appliesTo": "1",
        "isAdminConfigurable": true,
        "allowedUsers": [],
        "allowedGroups": []
    },
    "localAdminPassword": {
      "isEnabled": true
    }
}