androidEnterpriseWiFiConfiguration resource type

Article
01/12/2023

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.

By providing the configurations in this profile you can instruct the Android device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user.

Inherits from androidWiFiConfiguration

Methods

Method	Return Type	Description
List androidEnterpriseWiFiConfigurations	androidEnterpriseWiFiConfiguration collection	List properties and relationships of the androidEnterpriseWiFiConfiguration objects.
Get androidEnterpriseWiFiConfiguration	androidEnterpriseWiFiConfiguration	Read properties and relationships of the androidEnterpriseWiFiConfiguration object.
Create androidEnterpriseWiFiConfiguration	androidEnterpriseWiFiConfiguration	Create a new androidEnterpriseWiFiConfiguration object.
Delete androidEnterpriseWiFiConfiguration	None	Deletes a androidEnterpriseWiFiConfiguration.
Update androidEnterpriseWiFiConfiguration	androidEnterpriseWiFiConfiguration	Update the properties of a androidEnterpriseWiFiConfiguration object.

Properties

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 androidWiFiConfiguration
ssid	String	This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from androidWiFiConfiguration
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 androidWiFiConfiguration
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 androidWiFiConfiguration
wiFiSecurityType	androidWiFiSecurityType	Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from androidWiFiConfiguration. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.
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. 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.
usernameFormatString	String	Username format string used to build the username to connect to wifi
passwordFormatString	String	Password format string used to build the password to connect to wifi
preSharedKey	String	PreSharedKey used to build the password to connect to wifi

Relationships

Relationship	Type	Description
groupAssignments	deviceConfigurationGroupAssignment collection	The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
assignments	deviceConfigurationAssignment collection	The list of assignments for the device configuration profile. Inherited from deviceConfiguration
deviceStatuses	deviceConfigurationDeviceStatus collection	Device configuration installation status by device. Inherited from deviceConfiguration
userStatuses	deviceConfigurationUserStatus collection	Device configuration installation status by user. Inherited from deviceConfiguration
deviceStatusOverview	deviceConfigurationDeviceOverview	Device Configuration devices status overview Inherited from deviceConfiguration
userStatusOverview	deviceConfigurationUserOverview	Device Configuration users status overview Inherited from deviceConfiguration
deviceSettingStateSummaries	settingStateDeviceSummary collection	Device Configuration Setting State Device Summary Inherited from deviceConfiguration
rootCertificateForServerValidation	androidTrustedRootCertificate	Trusted Root Certificate for Server Validation when EAP Type is configured to EAP-TLS, EAP-TTLS or PEAP. This is the certificate presented by the Wi-Fi endpoint when the device attempts to connect to Wi-Fi endpoint. The device (or user) must accept this certificate to continue the connection attempt.
identityCertificateForClientAuthentication	androidCertificateProfileBase	Identity Certificate for client authentication when EAP Type is configured to EAP-TLS, EAP-TTLS (with Certificate Authentication), or PEAP (with Certificate Authentication). This is the certificate presented by client to the Wi-Fi endpoint. The authentication server sitting behind the Wi-Fi endpoint must accept this certificate to successfully establish a Wi-Fi connection.

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.androidEnterpriseWiFiConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "String"
    ],
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "String",
    "maxOSVersion": "String",
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "String",
    "name": "String",
    "ruleType": "String"
  },
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "version": 1024,
  "networkName": "String",
  "ssid": "String",
  "connectAutomatically": true,
  "connectWhenNetworkNameIsHidden": true,
  "wiFiSecurityType": "String",
  "eapType": "String",
  "trustedServerCertificateNames": [
    "String"
  ],
  "authenticationMethod": "String",
  "innerAuthenticationProtocolForEapTtls": "String",
  "innerAuthenticationProtocolForPeap": "String",
  "outerIdentityPrivacyTemporaryValue": "String",
  "usernameFormatString": "String",
  "passwordFormatString": "String",
  "preSharedKey": "String"
}