Retrieve the full configuration details of a Wi-Fi payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get Android Wifi policy payload

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwifipolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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

Full configuration details of Wi-Fi payload item

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: 120 | 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.