Create aospDeviceOwnerEnterpriseWiFiConfiguration
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.
Create a new aospDeviceOwnerEnterpriseWiFiConfiguration 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
POST /deviceManagement/deviceConfigurations
POST /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations
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 aospDeviceOwnerEnterpriseWiFiConfiguration object.
The following table shows the properties that are required when you create the aospDeviceOwnerEnterpriseWiFiConfiguration.
Property | Type | Description |
---|---|---|
id | String | Key of the entity. Inherited from deviceConfiguration |
lastModifiedDateTime | DateTimeOffset | DateTime the object was last modified. Inherited from deviceConfiguration |
roleScopeTagIds | String collection | List of Scope Tags for this Entity instance. Inherited from deviceConfiguration |
supportsScopeTags | Boolean | Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration |
deviceManagementApplicabilityRuleOsEdition | deviceManagementApplicabilityRuleOsEdition | The OS edition applicability for this Policy. Inherited from deviceConfiguration |
deviceManagementApplicabilityRuleOsVersion | deviceManagementApplicabilityRuleOsVersion | The OS version applicability rule for this Policy. Inherited from deviceConfiguration |
deviceManagementApplicabilityRuleDeviceMode | deviceManagementApplicabilityRuleDeviceMode | The device mode applicability rule for this Policy. Inherited from deviceConfiguration |
createdDateTime | DateTimeOffset | DateTime the object was created. Inherited from deviceConfiguration |
description | String | Admin provided description of the Device Configuration. Inherited from deviceConfiguration |
displayName | String | Admin provided name of the device configuration. Inherited from deviceConfiguration |
version | Int32 | Version of the device configuration. Inherited from deviceConfiguration |
networkName | String | Network Name Inherited from aospDeviceOwnerWiFiConfiguration |
ssid | String | This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from aospDeviceOwnerWiFiConfiguration |
connectAutomatically | Boolean | Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from aospDeviceOwnerWiFiConfiguration |
connectWhenNetworkNameIsHidden | Boolean | When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from aospDeviceOwnerWiFiConfiguration |
wiFiSecurityType | aospDeviceOwnerWiFiSecurityType | Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from aospDeviceOwnerWiFiConfiguration. Possible values are: open , wep , wpaPersonal , wpaEnterprise . |
preSharedKey | String | This is the pre-shared key for WPA Personal Wi-Fi network. Inherited from aospDeviceOwnerWiFiConfiguration |
preSharedKeyIsSet | Boolean | This is the pre-shared key for WPA Personal Wi-Fi network. Inherited from aospDeviceOwnerWiFiConfiguration |
proxySetting | wiFiProxySetting | Specify the proxy setting for Wi-Fi configuration. Possible values include none, manual, and automatic. Inherited from aospDeviceOwnerWiFiConfiguration. Possible values are: none , manual , automatic , unknownFutureValue . |
proxyManualAddress | String | Specify the proxy server IP address. Both IPv4 and IPv6 addresses are supported. For example: 192.168.1.1. Inherited from aospDeviceOwnerWiFiConfiguration |
proxyManualPort | Int32 | Specify the proxy server port. Inherited from aospDeviceOwnerWiFiConfiguration |
proxyAutomaticConfigurationUrl | String | Specify the proxy server configuration script URL. Inherited from aospDeviceOwnerWiFiConfiguration |
proxyExclusionList | String collection | List of hosts to exclude using the proxy on connections for. These hosts can use wildcards such as *.example.com. Inherited from aospDeviceOwnerWiFiConfiguration |
eapType | androidEapType | Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: eapTls , eapTtls , peap . |
trustedServerCertificateNames | String collection | Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network. |
authenticationMethod | wiFiAuthenticationMethod | Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: certificate , usernameAndPassword , derivedCredential . |
innerAuthenticationProtocolForEapTtls | nonEapAuthenticationMethodForEapTtlsType | Non-EAP Method for Authentication (Inner Identity) when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password. Possible values are: unencryptedPassword , challengeHandshakeAuthenticationProtocol , microsoftChap , microsoftChapVersionTwo . |
innerAuthenticationProtocolForPeap | nonEapAuthenticationMethodForPeap | Non-EAP Method for Authentication (Inner Identity) when EAP Type is PEAP and Authenticationmethod is Username and Password. This collection can contain a maximum of 500 elements. Possible values are: none , microsoftChapVersionTwo . |
outerIdentityPrivacyTemporaryValue | String | Enable identity privacy (Outer Identity) when EAP Type is configured to EAP-TTLS or PEAP. The String provided here is used to mask the username of individual users when they attempt to connect to Wi-Fi network. |
Response
If successful, this method returns a 201 Created
response code and a aospDeviceOwnerEnterpriseWiFiConfiguration object in the response body.
Example
Request
Here is an example of the request.
POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations
Content-type: application/json
Content-length: 1968
{
"@odata.type": "#microsoft.graph.aospDeviceOwnerEnterpriseWiFiConfiguration",
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"supportsScopeTags": true,
"deviceManagementApplicabilityRuleOsEdition": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
"osEditionTypes": [
"windows10EnterpriseN"
],
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleOsVersion": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
"minOSVersion": "Min OSVersion value",
"maxOSVersion": "Max OSVersion value",
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleDeviceMode": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
"deviceMode": "sModeConfiguration",
"name": "Name value",
"ruleType": "exclude"
},
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"networkName": "Network Name value",
"ssid": "Ssid value",
"connectAutomatically": true,
"connectWhenNetworkNameIsHidden": true,
"wiFiSecurityType": "wep",
"preSharedKey": "Pre Shared Key value",
"preSharedKeyIsSet": true,
"proxySetting": "manual",
"proxyManualAddress": "Proxy Manual Address value",
"proxyManualPort": 15,
"proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/",
"proxyExclusionList": [
"Proxy Exclusion List value"
],
"eapType": "eapTtls",
"trustedServerCertificateNames": [
"Trusted Server Certificate Names value"
],
"authenticationMethod": "usernameAndPassword",
"innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol",
"innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",
"outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value 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 201 Created
Content-Type: application/json
Content-Length: 2140
{
"@odata.type": "#microsoft.graph.aospDeviceOwnerEnterpriseWiFiConfiguration",
"id": "7ba48559-8559-7ba4-5985-a47b5985a47b",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"supportsScopeTags": true,
"deviceManagementApplicabilityRuleOsEdition": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
"osEditionTypes": [
"windows10EnterpriseN"
],
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleOsVersion": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
"minOSVersion": "Min OSVersion value",
"maxOSVersion": "Max OSVersion value",
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleDeviceMode": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
"deviceMode": "sModeConfiguration",
"name": "Name value",
"ruleType": "exclude"
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"networkName": "Network Name value",
"ssid": "Ssid value",
"connectAutomatically": true,
"connectWhenNetworkNameIsHidden": true,
"wiFiSecurityType": "wep",
"preSharedKey": "Pre Shared Key value",
"preSharedKeyIsSet": true,
"proxySetting": "manual",
"proxyManualAddress": "Proxy Manual Address value",
"proxyManualPort": 15,
"proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/",
"proxyExclusionList": [
"Proxy Exclusion List value"
],
"eapType": "eapTtls",
"trustedServerCertificateNames": [
"Trusted Server Certificate Names value"
],
"authenticationMethod": "usernameAndPassword",
"innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol",
"innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",
"outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for