Retrieve the full configuration details of a Hello payload item Deprecated

Get Windows Hello Policy payload details

This API endpoint is deprecated

Endpoints

get /api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id}

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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/windowshellopolicy/payloaditems/{payload_id}"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id}", headers=headers)

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

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


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

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

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy/payloaditems/{payload_id}' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

tenant_idstring

Tenant Id. Default: -1

enable_pfwboolean

Enable Pfw

allow_digitsinteger

Allow Digits

allow_uppercase_letterinteger

Allow Uppercase Letter

allow_lowercase_letterinteger

Allow Lowercase Letter

allow_special_charsinteger

Allow Special Chars

min_pin_lengthinteger

Min Pin Length

max_pin_lengthinteger

Max Pin Length

enable_pin_recoveryboolean

Enable Pin Recovery

pin_historyinteger

Pin History

pin_expiryinteger

Pin Expiry

enable_biometricsboolean

Enable Biometrics

allow_security_keyinteger

Allow Security Key

enable_device_unlockboolean

Enable Device Unlock

enable_device_lockboolean

Enable Device Lock

allow_companion_deviceboolean

Allow Companion Device

allow_tpmboolean

Allow Tpm

enable_anti_spoofstring

Enable Anti Spoof

device_unlock_configJSON Array

Device Unlock Config

Show Sub-Attributes

JSON Object

Show Sub-Attributes

credential_provider_idinteger

ID for Factors 0 - PIN Factor, 1 - FINGERPRINT, 2 - FACIAL RECOGNITION, 3 - Trusted Signal (Bluetooth / WiFi)

factor_typeinteger

Factory Type for Credential Provider 1 - First Factor, 2 - Second Factor

tfa_bluetoothJSON Object

Tfa Bluetooth

Show Sub-Attributes

auth_scenariointeger

Auth Scenario for Bluetooth Default : 0

class_of_deviceinteger

Class of the blue tooth device Default : 3

rssi_mininteger

Minimum acceptable RSSI value (in dBm) for the Bluetooth signal to qualify for authentication

rssi_max_deltainteger

Maximum allowed RSSI variation (in dBm) for the Bluetooth signal before the auth scenario is rejected

tfa_wifiJSON Array

Tfa Wifi

Show Sub-Attributes

JSON Object

Show Sub-Attributes

wifi_ssidstring

SSID of the Trusted WiFi

wifi_security_typeinteger

Type of the Trusted WiFi 0 - OPEN, 1 - WEP, 2 - WPA-Personal, 3 - WPA-Enterprise, 4 - WPA2-Personal, 5 - WPA2-Enterprise

wifi_bssidstring

BSSID (MAC address) of the trusted Wi-Fi access point used for two-factor authentication

wifi_root_castring

Root CA certificate (PEM/Base64-encoded) used to validate the Wi-Fi network for two-factor authentication

wifi_sig_qualityinteger

Minimum required Wi-Fi signal quality (0-100) for the auth scenario to succeed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Hello payload item (PIN Policy Enabled)

Copied!

  {
    "tenant_id": "749fd9b3-b71e-4210-a8ff-ea830c4c5135",
    "max_pin_length": "127",
    "payload_id": "9007199254741295",
    "allow_companion_device": false,
    "allow_uppercase_letter": "0",
    "enable_anti_spoof": false,
    "allow_special_chars": "0",
    "enable_device_unlock": false,
    "allow_lowercase_letter": "0",
    "allow_tpm": false,
    "pin_history": "0",
    "min_pin_length": "6",
    "pin_expiry": "0",
    "allow_security_key": "0",
    "enable_biometrics": false,
    "allow_digits": "0",
    "enable_pfw": true,
    "enable_device_lock": false,
    "enable_pin_recovery": false
  }

▼ Show full

Full configuration details of Hello payload item (PIN Policy Disabled)

Copied!

  {
    "tenant_id": "-1",
    "max_pin_length": "4",
    "payload_id": "9007199254741295",
    "allow_companion_device": false,
    "allow_uppercase_letter": "2",
    "enable_anti_spoof": false,
    "allow_special_chars": "2",
    "enable_device_unlock": false,
    "allow_lowercase_letter": "2",
    "allow_tpm": false,
    "pin_history": "0",
    "min_pin_length": "4",
    "pin_expiry": "0",
    "allow_security_key": "0",
    "enable_biometrics": false,
    "allow_digits": "1",
    "enable_pfw": false,
    "enable_device_lock": false,
    "enable_pin_recovery": false
  }

▼ Show full

Full configuration details of Hello payload item (TFA Configured)

Copied!

  {
    "tenant_id": "-1",
    "max_pin_length": "4",
    "payload_id": "9007199254741295",
    "allow_companion_device": false,
    "device_unlock_config": [
      {
        "factor_type": "1",
        "credential_provider_id": "1"
      },
      {
        "factor_type": "1",
        "credential_provider_id": "0"
      },
      {
        "factor_type": "2",
        "credential_provider_id": "2"
      },
      {
        "factor_type": "2",
        "credential_provider_id": "3"
      }
    ],
    "allow_uppercase_letter": "2",
    "enable_anti_spoof": false,
    "allow_special_chars": "2",
    "enable_device_unlock": true,
    "allow_lowercase_letter": "2",
    "allow_tpm": false,
    "pin_history": "0",
    "min_pin_length": "4",
    "pin_expiry": "0",
    "allow_security_key": "0",
    "tfa_bluetooth": {
      "auth_scenario": "0",
      "class_of_device": "3"
    },
    "enable_biometrics": false,
    "allow_digits": "1",
    "enable_pfw": false,
    "tfa_wifi": [
      {
        "wifi_ssid": "Dummy WiFI",
        "wifi_security_type": "5"
      }
    ],
    "enable_device_lock": false,
    "enable_pin_recovery": false
  }

▼ 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.