Modify the configuration of a Wi-Fi payload item within a profile

Modify Android Wifi configurations payload

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

sub_configstringOptional

Wi-Fi security configuration type. WIFI_NON_ENTERPRISE or WIFI_ENTERPRISE. Default: WIFI_NON_ENTERPRISE

service_set_identifierstringMandatory

Wi-Fi network SSID (required)

auto_joinbooleanOptional

Whether the device automatically joins this network. Default: true

hidden_networkbooleanMandatory

Whether the network SSID is hidden (required). Default: false

security_typeintegerMandatory

Wi-Fi security type. 0 = None, 1 = WEP, 2 = WPA/WPA2 PSK, 3 = 802.1x EAP, 4 = WPA3 (required). Default: 0

wifi_non_enterpriseJSON ObjectOptional

Non-enterprise Wi-Fi security settings (password, etc.)

Show Sub-Attributes

passwordstringOptional

Wi-Fi network password (write-only)

password_idlongOptional

ID of saved password credential

wifi_enterpriseJSON ObjectOptional

Enterprise Wi-Fi security settings (EAP, certificates, etc.)

Show Sub-Attributes

outer_identitystringOptional

Outer identity (anonymous identity) for EAP authentication

user_namestringOptional

EAP authentication username

use_pacbooleanOptional

Whether PAC (Protected Access Credential) is used for EAP-FAST. Default: false

provision_pac_anonymousbooleanOptional

Whether PAC is provisioned anonymously. Default: false

use_per_connection_pwdbooleanOptional

Whether per-connection password prompting is used. Default: false

identity_certificate_idlongOptional

Identity certificate ID for EAP-TLS authentication

peapbooleanMandatory

Whether PEAP (Protected EAP) is enabled (required)

certificate_idlongOptional

Trusted server certificate ID

ttlsbooleanMandatory

Whether EAP-TTLS is enabled (required)

inner_identityintegerOptional

Inner authentication method for PEAP/TTLS

passwordstringOptional

EAP authentication password (write-only)

provision_pacbooleanOptional

Whether PAC provisioning is enabled. Default: false

leapbooleanMandatory

Whether LEAP is enabled (required)

tlsbooleanMandatory

Whether EAP-TLS is enabled (required)

eap_fastbooleanMandatory

Whether EAP-FAST is enabled (required)

eap_simbooleanMandatory

Whether EAP-SIM is enabled (required)

password_idlongOptional

ID of saved password credential

eap_akabooleanOptional

Whether EAP-AKA is enabled. Default: false

domain_namestringOptional

Server certificate domain name for validation

proxy_typeintegerOptional

Proxy configuration type. 0 = None, 1 = Manual, 2 = Automatic (PAC). Default: 0

proxy_serverstringOptional

Proxy server hostname or IP address

proxy_server_portintegerOptional

Proxy server port number. Default: 0

proxy_user_namestringOptional

Username for proxy authentication

proxy_passwordstringOptional

Password for proxy authentication (sensitive — write-only)

proxy_password_idlongOptional

ID of the saved credential for the proxy password

proxy_pac_urlstringOptional

URL of the proxy auto-configuration (PAC) file

bypass_proxy_urlstringOptional

URLs that bypass the proxy server

mac_address_randomization_modeintegerOptional

MAC address randomization mode. 0 = Use device default, 1 = Use randomized MAC, 2 = Use device MAC. Default: 1

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"wifi_non_enterprise":{},"sub_config":"WIFI_NON_ENTERPRISE","wifi_enterprise":{},"proxy_server":"value","auto_join":true,"hidden_network":false,"proxy_server_port":0,"service_set_identifier":"value","security_type":0,"proxy_type":0}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"wifi_non_enterprise\":{},\"sub_config\":\"WIFI_NON_ENTERPRISE\",\"wifi_enterprise\":{},\"proxy_server\":\"value\",\"auto_join\":true,\"hidden_network\":false,\"proxy_server_port\":0,\"service_set_identifier\":\"value\",\"security_type\":0,\"proxy_type\":0}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"wifi_non_enterprise\":{},\"sub_config\":\"WIFI_NON_ENTERPRISE\",\"wifi_enterprise\":{},\"proxy_server\":\"value\",\"auto_join\":true,\"hidden_network\":false,\"proxy_server_port\":0,\"service_set_identifier\":\"value\",\"security_type\":0,\"proxy_type\":0}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("sub_config","value");
    data.put("service_set_identifier","value");
    data.put("auto_join",true);
    data.put("hidden_network",true);
    data.put("security_type","1");
    data_wifi_non_enterprise=Map();
    data_wifi_non_enterprise.put("password","value");
    data_wifi_non_enterprise.put("password_id","1");
    data.put("wifi_non_enterprise",data_wifi_non_enterprise);
    data_wifi_enterprise=Map();
    data_wifi_enterprise.put("outer_identity","value");
    data_wifi_enterprise.put("user_name","value");
    data_wifi_enterprise.put("use_pac",true);
    data_wifi_enterprise.put("provision_pac_anonymous",true);
    data_wifi_enterprise.put("use_per_connection_pwd",true);
    data_wifi_enterprise.put("identity_certificate_id","1");
    data_wifi_enterprise.put("peap",true);
    data_wifi_enterprise.put("certificate_id","1");
    data_wifi_enterprise.put("ttls",true);
    data_wifi_enterprise.put("inner_identity","1");
    data_wifi_enterprise.put("password","value");
    data_wifi_enterprise.put("provision_pac",true);
    data_wifi_enterprise.put("leap",true);
    data_wifi_enterprise.put("tls",true);
    data_wifi_enterprise.put("eap_fast",true);
    data_wifi_enterprise.put("eap_sim",true);
    data_wifi_enterprise.put("password_id","1");
    data_wifi_enterprise.put("eap_aka",true);
    data_wifi_enterprise.put("domain_name","value");
    data.put("wifi_enterprise",data_wifi_enterprise);
    data.put("proxy_type","1");
    data.put("proxy_server","value");
    data.put("proxy_server_port","1");
    data.put("proxy_user_name","value");
    data.put("proxy_password","value");
    data.put("proxy_password_id","1");
    data.put("proxy_pac_url","value");
    data.put("bypass_proxy_url","value");
    data.put("mac_address_randomization_mode","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"wifi_non_enterprise":{},"sub_config":"WIFI_NON_ENTERPRISE","wifi_enterprise":{},"proxy_server":"value","auto_join":true,"hidden_network":false,"proxy_server_port":0,"service_set_identifier":"value","security_type":0,"proxy_type":0}'

Sample Request Body

Modify Wi-Fi payload item

Copied!

  {
    "wifi_non_enterprise": {},
    "sub_config": "WIFI_NON_ENTERPRISE",
    "wifi_enterprise": {},
    "proxy_server": "value",
    "auto_join": true,
    "hidden_network": false,
    "proxy_server_port": 0,
    "service_set_identifier": "value",
    "security_type": 0,
    "proxy_type": 0
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

sub_configstring

Wi-Fi security configuration type. WIFI_NON_ENTERPRISE or WIFI_ENTERPRISE. Default: WIFI_NON_ENTERPRISE

service_set_identifierstring

Wi-Fi network SSID (required)

auto_joinboolean

Whether the device automatically joins this network. Default: true

hidden_networkboolean

Whether the network SSID is hidden (required). Default: false

security_typeinteger

Wi-Fi security type. 0 = None, 1 = WEP, 2 = WPA/WPA2 PSK, 3 = 802.1x EAP, 4 = WPA3 (required). Default: 0

wifi_non_enterpriseJSON Object

Non-enterprise Wi-Fi security settings (password, etc.)

Show Sub-Attributes

passwordstring

Wi-Fi network password (write-only)

password_idlong

ID of saved password credential

wifi_enterpriseJSON Object

Enterprise Wi-Fi security settings (EAP, certificates, etc.)

Show Sub-Attributes

outer_identitystring

Outer identity (anonymous identity) for EAP authentication

user_namestring

EAP authentication username

use_pacboolean

Whether PAC (Protected Access Credential) is used for EAP-FAST. Default: false

provision_pac_anonymousboolean

Whether PAC is provisioned anonymously. Default: false

use_per_connection_pwdboolean

Whether per-connection password prompting is used. Default: false

identity_certificate_idlong

Identity certificate ID for EAP-TLS authentication

peapboolean

Whether PEAP (Protected EAP) is enabled (required)

certificate_idlong

Trusted server certificate ID

ttlsboolean

Whether EAP-TTLS is enabled (required)

inner_identityinteger

Inner authentication method for PEAP/TTLS

passwordstring

EAP authentication password (write-only)

provision_pacboolean

Whether PAC provisioning is enabled. Default: false

leapboolean

Whether LEAP is enabled (required)

tlsboolean

Whether EAP-TLS is enabled (required)

eap_fastboolean

Whether EAP-FAST is enabled (required)

eap_simboolean

Whether EAP-SIM is enabled (required)

password_idlong

ID of saved password credential

eap_akaboolean

Whether EAP-AKA is enabled. Default: false

domain_namestring

Server certificate domain name for validation

proxy_typeinteger

Proxy configuration type. 0 = None, 1 = Manual, 2 = Automatic (PAC). Default: 0

proxy_serverstring

Proxy server hostname or IP address

proxy_server_portinteger

Proxy server port number. Default: 0

proxy_user_namestring

Username for proxy authentication

proxy_passwordstring

Password for proxy authentication (sensitive — write-only)

proxy_password_idlong

ID of the saved credential for the proxy password

proxy_pac_urlstring

URL of the proxy auto-configuration (PAC) file

bypass_proxy_urlstring

URLs that bypass the proxy server

mac_address_randomization_modeinteger

MAC address randomization mode. 0 = Use device default, 1 = Use randomized MAC, 2 = Use device MAC. Default: 1

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Wi-Fi payload item successfully modified

Copied!

  {
    "payload_id": 9007199254741000,
    "wifi_non_enterprise": {},
    "sub_config": "WIFI_NON_ENTERPRISE",
    "wifi_enterprise": {},
    "proxy_server": "value",
    "auto_join": true,
    "hidden_network": false,
    "proxy_server_port": 0,
    "service_set_identifier": "value",
    "security_type": 0,
    "proxy_type": 0
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.