Add a new Hello payload configuration to an existing profile

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

Create Windows Hello Configuration policy payload

Request URL

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

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
tenant_idstringOptional

Tenant Id. Default: -1

enable_pfwbooleanOptional

Enable Pfw

allow_digitsintegerOptional

Allow Digits

allow_uppercase_letterintegerOptional

Allow Uppercase Letter

allow_lowercase_letterintegerOptional

Allow Lowercase Letter

allow_special_charsintegerOptional

Allow Special Chars

min_pin_lengthintegerOptional

Min Pin Length

max_pin_lengthintegerOptional

Max Pin Length

enable_pin_recoverybooleanOptional

Enable Pin Recovery

pin_historyintegerOptional

Pin History

pin_expiryintegerOptional

Pin Expiry

enable_biometricsbooleanOptional

Enable Biometrics

allow_security_keyintegerOptional

Allow Security Key

enable_device_unlockbooleanOptional

Enable Device Unlock

enable_device_lockbooleanOptional

Enable Device Lock

allow_companion_devicebooleanOptional

Allow Companion Device

allow_tpmbooleanOptional

Allow Tpm

enable_anti_spoofstringOptional

Enable Anti Spoof

device_unlock_configJSON ArrayOptional

Device Unlock Config

Show Sub-Attributes
JSON Object
Show Sub-Attributes
credential_provider_idintegerOptional

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

factor_typeintegerOptional

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

tfa_bluetoothJSON ObjectOptional

Tfa Bluetooth

Show Sub-Attributes
auth_scenariointegerMandatory

Auth Scenario for Bluetooth Default : 0

class_of_deviceintegerMandatory

Class of the blue tooth device Default : 3

rssi_minintegerOptional

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

rssi_max_deltaintegerOptional

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

tfa_wifiJSON ArrayOptional

Tfa Wifi

Show Sub-Attributes
JSON Object
Show Sub-Attributes
wifi_ssidstringMandatory

SSID of the Trusted WiFi

wifi_security_typeintegerMandatory

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

wifi_bssidstringOptional

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

wifi_root_castringOptional

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

wifi_sig_qualityintegerOptional

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/windowshellopolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"tenant_id":"-1","allow_security_key":"0","enable_biometrics":false,"enable_anti_spoof":false,"enable_pfw":false,"enable_device_unlock":false,"enable_device_lock":false}'

Sample Request Body

Add Hello payload to the profile (PIN Policy Disabled)

Copied!
  {
    "tenant_id": "-1",
    "allow_security_key": "0",
    "enable_biometrics": false,
    "enable_anti_spoof": false,
    "enable_pfw": false,
    "enable_device_unlock": false,
    "enable_device_lock": false
  }
                
Show full

Add Hello payload to the profile (PIN Policy Enabled)

Copied!
  {
    "tenant_id": "749fd9b3-b71e-4210-a8ff-ea830c4c5135",
    "max_pin_length": "127",
    "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

Add Hello payload to the profile (TFA Configured)

Copied!
  {
    "tenant_id": "-1",
    "allow_security_key": "0",
    "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"
      }
    ],
    "tfa_bluetooth": {
      "auth_scenario": 0,
      "class_of_device": 3
    },
    "enable_biometrics": false,
    "enable_anti_spoof": false,
    "enable_pfw": false,
    "enable_device_unlock": true,
    "tfa_wifi": [
      {
        "wifi_ssid": "Dummy WiFI",
        "wifi_security_type": "5"
      }
    ],
    "enable_device_lock": false
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier for the created 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

Hello payload successfully added (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

Hello payload successfully added (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

Hello payload with TFA successfully added

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