Update deviceManagementConfigurationRedirectSettingDefinition

Article
02/09/2024

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a deviceManagementConfigurationRedirectSettingDefinition 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

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)	DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementConfiguration.ReadWrite.All

HTTP Request

PATCH /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}
PATCH /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId}
PATCH /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId}
PATCH /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId}
PATCH /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId}
PATCH /deviceManagement/configurationPolicyTemplates/{deviceManagementConfigurationPolicyTemplateId}/settingTemplates/{deviceManagementConfigurationSettingTemplateId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId}

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the deviceManagementConfigurationRedirectSettingDefinition object.

The following table shows the properties that are required when you create the deviceManagementConfigurationRedirectSettingDefinition.

Property	Type	Description
applicability	deviceManagementConfigurationSettingApplicability	Details which device setting is applicable on. Supports: $filters. Inherited from deviceManagementConfigurationSettingDefinition
accessTypes	deviceManagementConfigurationSettingAccessTypes	Read/write access mode of the setting Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: `none`, `add`, `copy`, `delete`, `get`, `replace`, `execute`.
keywords	String collection	Tokens which to search settings on Inherited from deviceManagementConfigurationSettingDefinition
infoUrls	String collection	List of links more info for the setting can be found at. Inherited from deviceManagementConfigurationSettingDefinition
occurrence	deviceManagementConfigurationSettingOccurrence	Indicates whether the setting is required or not Inherited from deviceManagementConfigurationSettingDefinition
baseUri	String	Base CSP Path Inherited from deviceManagementConfigurationSettingDefinition
offsetUri	String	Offset CSP Path from Base Inherited from deviceManagementConfigurationSettingDefinition
rootDefinitionId	String	Root setting definition id if the setting is a child setting. Inherited from deviceManagementConfigurationSettingDefinition
categoryId	String	Specify category in which the setting is under. Support $filters. Inherited from deviceManagementConfigurationSettingDefinition
settingUsage	deviceManagementConfigurationSettingUsage	Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.
uxBehavior	deviceManagementConfigurationControlType	Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.
visibility	deviceManagementConfigurationSettingVisibility	Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.
referredSettingInformationList	deviceManagementConfigurationReferredSettingInformation collection	List of referred setting information. Inherited from deviceManagementConfigurationSettingDefinition
id	String	Identifier for item Inherited from deviceManagementConfigurationSettingDefinition
description	String	Description of the setting. Inherited from deviceManagementConfigurationSettingDefinition
helpText	String	Help text of the setting. Give more details of the setting. Inherited from deviceManagementConfigurationSettingDefinition
name	String	Name of the item Inherited from deviceManagementConfigurationSettingDefinition
displayName	String	Name of the setting. For example: Allow Toast. Inherited from deviceManagementConfigurationSettingDefinition
version	String	Item Version Inherited from deviceManagementConfigurationSettingDefinition
deepLink	String	A deep link that points to the specific location in the Intune console where feature support must be managed from.
redirectMessage	String	A message that explains that clicking the link will redirect the user to a supported page to manage the settings.
redirectReason	String	Indicates the reason for redirecting the user to an alternative location in the console. For example: WiFi profiles are not supported in the settings catalog and must be created with a template policy.

Response

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

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}
Content-type: application/json
Content-length: 1396

{
  "@odata.type": "#microsoft.graph.deviceManagementConfigurationRedirectSettingDefinition",
  "applicability": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingApplicability",
    "description": "Description value",
    "platform": "android",
    "deviceMode": "kiosk",
    "technologies": "mdm"
  },
  "accessTypes": "add",
  "keywords": [
    "Keywords value"
  ],
  "infoUrls": [
    "Info Urls value"
  ],
  "occurrence": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingOccurrence",
    "minDeviceOccurrence": 3,
    "maxDeviceOccurrence": 3
  },
  "baseUri": "Base Uri value",
  "offsetUri": "Offset Uri value",
  "rootDefinitionId": "Root Definition Id value",
  "categoryId": "Category Id value",
  "settingUsage": "configuration",
  "uxBehavior": "dropdown",
  "visibility": "settingsCatalog",
  "referredSettingInformationList": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationReferredSettingInformation",
      "settingDefinitionId": "Setting Definition Id value"
    }
  ],
  "description": "Description value",
  "helpText": "Help Text value",
  "name": "Name value",
  "displayName": "Display Name value",
  "version": "Version value",
  "deepLink": "Deep Link value",
  "redirectMessage": "Redirect Message value",
  "redirectReason": "Redirect Reason value"
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.deviceManagementConfigurationRedirectSettingDefinition",
  "applicability": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingApplicability",
    "description": "Description value",
    "platform": "android",
    "deviceMode": "kiosk",
    "technologies": "mdm"
  },
  "accessTypes": "add",
  "keywords": [
    "Keywords value"
  ],
  "infoUrls": [
    "Info Urls value"
  ],
  "occurrence": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingOccurrence",
    "minDeviceOccurrence": 3,
    "maxDeviceOccurrence": 3
  },
  "baseUri": "Base Uri value",
  "offsetUri": "Offset Uri value",
  "rootDefinitionId": "Root Definition Id value",
  "categoryId": "Category Id value",
  "settingUsage": "configuration",
  "uxBehavior": "dropdown",
  "visibility": "settingsCatalog",
  "referredSettingInformationList": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationReferredSettingInformation",
      "settingDefinitionId": "Setting Definition Id value"
    }
  ],
  "id": "3e6c3eab-3eab-3e6c-ab3e-6c3eab3e6c3e",
  "description": "Description value",
  "helpText": "Help Text value",
  "name": "Name value",
  "displayName": "Display Name value",
  "version": "Version value",
  "deepLink": "Deep Link value",
  "redirectMessage": "Redirect Message value",
  "redirectReason": "Redirect Reason value"
}

Share via

Update deviceManagementConfigurationRedirectSettingDefinition

Permissions

HTTP Request

Request headers

Request body

Response

Example

Request

Response

Feedback

Additional resources