Web Service Endpoint

Rotate the FileVault Key

Reset the FileVault password periodically to mitigate the security risk of deployed devices.

URL

PUT https://yourmdmhost.example.com/mdm

HTTP Body

Response Codes

OK

Discussion

Command Availability

Device Channel

macOS

User Channel

-

Requires Supervision

-

Allowed in User Enrollment

-

Required Access Right

DeviceLockAndRemovePasscode

Example Request and Response (Personal Recovery Key)

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"><plist version="1.0"><dict> <key>Command</key> <dict> <key>FileVaultUnlock</key> <dict> <key>Password</key> <string>mypassword</string> </dict> <key>KeyType</key> <string>personal</string> <key>ReplyEncryptionCertificate</key> <data> MIICQTCCAaKgAwIBAgIBATAKBggqhkjOPQQDAjBNMRcwFQYDVQQDDA5HcmFoYW0gTWNM dWhhbjELMAkGA1UEBhMCVVMxJTAjBgkqhkiG9w0BCQEWFmdyYWhhbS5tY2x1aGFuQG1h Yy5jb20wHhcNMTcwNjEzMjIzOTU1WhcNMTgwNjEzMjIzOTU1WjBNMRcwFQYDVQQDDA5H cmFoYW0gTWNMdWhhbjELMAkGA1UEBhMCVVMxJTAjBgkqhkiG9w0BCQEWFmdyYWhhbS5t Y2x1aGFuQG1hYy5jb20wgZswEAYHKoZIzj0CAQYFK4EEACMDgYYABAD8hMbGJ9QBUjuB VU6y3iDwA1uXili0jkCog6JBAjzyTL5CVqb4Ql3LPKsVPFIQELsA/CibbkDkpdSu+wTa 9dJnWQHPUDItGdMQhVLaDsYsp+l2+J6q3gpmJteUy4TlPr5NloPn9HvgSxrohPWM9WOq pX0eACRUWJsnllmcEPswDg6dl6MwMC5wDgYDVR0PAQH/BAQDAgH+MBwGA1UdJQEB/wQS MBAGCCsGAQUFBwMDBgRVHSUAMAoGCCqGMS49BAMCA4GMADCBiAJCAUsNmZmNevkKLU7t Zj3F4mlrl/KHDl+U/nAFimTLuWZIYwttFVttpfMt+CiOULAzCzGjZKiIQC55G/Rk57Ka SRLAAkIBoesNcUhtwOnMTrvtW1gXmkYplNd5ZOrbYl0wYV+73drlTyYTEf7v4wJ4rZ6q iwjdriGsnT8+x+D+PJQdrtPJXBw= </data> <key>RequestType</key> <string>RotateFileVaultKey</string> </dict> <key>CommandUUID</key> <string>0001_RotateFileVaultKey</string></dict></plist>

Example Request and Response (Institutional Recovery Key)

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"><plist version="1.0"><dict> <key>Command</key> <dict> <key>FileVaultUnlock</key> <dict> <key>PrivateKeyExport</key> <data> MIITLAIBAzCCEvMGCSqGSIb3DQEHAaCCEuQEghLgMIIS3DCCB88GCSqGSIb3 DQEHBqCCB8Awgge8AgEAMIIHtQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYw DgQI0YqNDekGed0CAggAgIIHiBGkHKqrLHm0tVNbbEdX8o1F/GEKPOj+oR2d IM2jE8UU8V/9CMuiuAA977YamrAoXU1YFq9yFzr7JOqFv15tipuRbqPaEswW wi8ZyHnfSsne9Kg/+urbvOLBUwQLInxqE9s16tRuu0VmHCVt5DaDV+GUyxTZ ipsTW7DBpI+kBET1fykgApjcIflQI50NUq4T/WYguC3aXhwwnyYk+BfbO1hG u9agI/ImR08Riv2i+zAk26L3sxIqRNXUzeUcdPK0rtlUQC/LYAcUGftBhWVo epjO0my646J/oWvPREko3mLO1O00PBdgx06/hWXCXtxrGYD+jOYlJBfuf5Gv QC6hGKOIObWpdZ6meb5wdMX51hh96gZgbl4wAfaqdI58E9Me5ifev9QCddqE K4yqplh8F+SgcR75kz7UStwnGGvKzY6prmUFcgFUSsY72WO3ybSa0VlrFTlm XCfy8xMR/y4lBCGbaR+1Aso7/VfrtVBCgzRkss6ZzUq6i4oR9KN4VCmOA5lm moOjCQMalbqXpS3dxFEPCv+Z3QrRVixqyYz6rkwIDmX2hg8Q3GUslacO8ZYY jHv5xqH0Gne5tJ9GLeomJQH75d0WanAo62/lMUXAZOGhVWPOyNofxQCtNDm9 MX8qcwzNXwYHlf9CAN2+1McNGdaL+eRQOU+j60WhlOOl7Iwjq0CulfP9XMP8 +pgqidRGg813/eDfjiuMIyC9NaU6rwiW50tn2vh94JYbFMlsTohJjsPns9DK TN4B/3zfjFwR+KbPaOr/f68T7C2MXeIOEkCR+XIHpAEZbsT2f7qvIoyhA9H/ DFey5i/9VkYQs4cT3/NudK41hQfNdSGQF13CGdtkMhu7ACn7nuXpVG4G7h3J h6DxrR4taNMOai1B2pKPmA7hYJjBxjenAwfuWUrP18WQjSiaLs7Aj6rFrQba aaOzLR8x3SnSthmUnvemOj70pEp2NA4WJPJohAKaEihfvY/C7JRHK+3bK8+W dUEOW+z0piAh5SdIsV7K3+E8rdkv6skRFtuT9qIUm/qc7q3P4mKc6PxCZ7NL YBtED4NvhsZiJdfEKzwvNoW/MUR0qptOfe6nYmmzj/D5FNqTz+PUK5IBFOCh StptQpGfZzex3ygBeNsQmle0YOzjHwy4hmeu+POYVqZ5QBUO0hpN9eE9QLiY BH4z352IBsKVd4GG2WMU1VMKIdwPgVpBjJN2C6oPVc0amcId/LsYo3kVlVfE 2kJCRIJ5nCtQfuXomeOKOXDX+Z4CyAR/iDHMvtrka9RhCfz6Uba81KffiSSt 19X5KdRuIdJ6rF38ZKrDayawRlUsvDl0pDNkze7lX4m/jSqIWiIQ6XfOtbLQ NYvQaTtp9NGe3kQ/us/K2v1sYN4Yh0S6oFR2cgtUq+aYesKqUqmrrRg9rrfS JCVDrfNlHHy3KFMw6cz8pcQYpbDJT2D85YTcMfpblj6hjzCl3+RccXGk0bDc RyA5jRGF/OyoHx8+20hWZeyjtmaHPVgGUxOxD0bXo0B68kJDlJlidMNIMMtb ffMN8ZH/y3S+8II2mNbjnsKji1bX+2IWMVhtbP4JELvvUcCMPz9dlJD5MATx Vh99zjp+JzBfhBEIo7hV/nktcl3oA1mbpemGa2GotaeBxvPC2y3Iqz3FU6sC HH/39GG6Zkbv0MKFq9Mqftb6m6t/pyDbANBQ6HihhhHBp7D4F+pjX1c4Fzah Xla/jKfaaDqPLENG2mT1+tcgRY0L0vbVIqgBVraz3J5PJhkQ+I9u0ntcs8SC 9FaPH5nTrnx6TboZisQcqO0pgbx9x72khp8DmltijusGz+ZKuH261GOGSqLb XL4JiVX6rPigCpUIPrqvtGYKiZ5mvVnIyH4pSjk9+0tEtgTN4VLKH0m4nQZV ygpPANO0G3QPhS2Mmi49WlcWAToh1JztWrtOa0KQkTZHbi0VIO39IMRzU90S WPTTAwbvUa430Dc4WEprW6rT7TqsfdnlZjxDBdfErcFzojReQgdPkZSm4iA0 zxkjn9hWoUulPtTK9XJiW69DUdjFI71qfUSPivSZEsiG+iB82zhE4mqzNEKG 63Cca/4zEmybfY112eXi4xZPbJKRL8N2Ov0ng90h2WVjTIER+yE/f3mUx+Td MW0sHWLxFGgivA04Xh5NPBYDRk3Ahfj7XplvVDf+0Bev5ukVBcE2ogl14rLW yaGqvy3RAmzElGNIhspZb700CwsAarPZwSgx4yt3AaTQvZ5i7gEMXg9kEAB1 q1miyV7Lo6I+drS89OeZAoclP7pIS9JTMK5PphpiU9kGre6zhCxFRZ3XThx6 4Famg1YEoUHWLvHUgA09r/IcafRIQnPwdU+QEFc+WBPbSdGu48y1SV7wSwjd TtlZlMj2FGAuONIFOj1djN9Hwmkmexz06Gf9rdn5tjQ+mD2Ltqau2WD/IX2G YOfECuAMRCa6MgOIcnXKu8WvK1wpo45h7gQp2bh+nnCM4Rl8uQ0txGhBtVlS XvYLqX7bac08iyz+njKIuUzgiTcodQ13WqRtI1NbOk4WjOxZHM+n3bTJtybU j8kUxApNacCs1CuNMIILBQYJKoZIhvcNAQcBoIIK9gSCCvIwggruMIIFcwYL KoZIhvcNAQwKAQKgggTuMIIE6jAcBgoqhkiG9w0BDAEDMA4ECOmrsTgyTFjt AgIIAASCBMhmGJWGv+ZvcqbiGuId5Tk78aS35Y02EIpIE3e19RsIdPgTsvPQ efO16XoH/JSmU0xs7W+gNqBSTdRO211JI74xvjQZ6g7bcvaAUWtQYsyPuo+u msuGtu9ZvXnxMjPhri5K8WwC28Yf8BHuLGhmVKHVn6litGwWBYK9L3qAw0Mg m2jztwkBL46mD8RFMANvVrA0L0vqZVrqBwR0PWfVH3o7fcdq6WXUiRiHnZjD uDQ79XhkG4Iove3pBtwmucLV/GBgbc407K/XBqGQVbXPEZyEF8NsecDMVp/m KSl2YbWNvB5Zx4Bjlo9C+FUqaq3LHnvgIrcJlDRkCS1LqemNEk28wgMjP3DJ rPhx5zS+9X2qqFZMt/0f7BUu4c/GeHmJuFFvbYXZGgug739WskvfLqMy9NI8 7xEMRYwOCuPhFOAcMKZU+deBMrXsZM5Nt3HmOtG2b/sflBqxFNC9aNLQOWPI RneAcyU5JPOqGa0zzifP7DZ89OR0Q9Ti29EzMkZXJliAgWkGdP2P1SDdNX9Y rn0C0l2/mI2vZLfl7bBVWnT9sN7jopP+ScMD9ku9+/NHxTGnUJCIWVoCl3jd iaunXf/QWee7g+4wF317WavsvOQ6zuE/2MWwwRcWxQ6oP/hquC4r+NinYNtR Ru8kO5CeZaT1f2wS3Xn1gRbn9Cbh25vcjw7EeopKKHiJdITrcVuKir+/ScO9 A8u/tojPUYE5tD4iqOI9b3q7QwbJqs6eVf2Gs6BnRu1FSYFUxPmVZfVkVZN0 dTRDOvdDwwSabZyrEXDCziW6qL2eocRRW+ONs50A/sNxsGENSBoZUWKeZBNK 9pLXcliq8bwZuAwAo/g8vrNBEY5V5J7N/IB9F9dpfwx8mLHPiAvTk0yYL2n5 VANB1cHYdE91pdzoTlsG7LBUK80VSNOrLWWkuSrYmgNHcEM8JOmUN1kGj1A7 tgqI9ribpHOS1Fa0bg60H1EjH/8jn3tC/2Gw+yrhef0il8zYuNICP0jQVz+t /aSofnfG5SiW8Z3GliYSkPMW46im6TQKQoy2qGecfbXTGA/DljrmPUssfmfB mEhJyU4B3VAMP7YzQDshCRgeqXjdPF5MRMOlb7hY82oceS6uwucEdnxT85ZG 7xVGAiOFcZgBjKQrtZCN5nFJFdiGqkX0HwaciAdEiRGgtjRpZdrq3TGCAqhA 2P7KUAzKdYYjrEaKybtw4v2yreEpeeTJYzwvJlWV3vpYfHDKbYLKjh0hP+uz 467XJkz2DLiQwfciXHDQdaUdgr6qwm8j0dcozVvyavhOCL85qNP+FHB0sMm2 rA6OvRTNvwXjgGeAfj7UB3Z+Djl1mj/qCzAaaHxl2T6xoYeMYRo1KyXyoa/q 9ZfTUFPV3CVhj4ANGIgOxVbRZipz5ypTQBHBauHbz4RsL/8HpsrtdpzlFLkB 667u7p4got7hc0LMqgPkuMNnOMKVqq1J8np/ygVQxL1/pIyjTpPdjfAV6DnU 7q2XWtutDulB4gg4nsr4vipT+rwpilw9kNZGrax01wnvNYQ7BhtyGhVa8yxk DyWIiAp5Riloy0UsHyqOfrWMdA4vqH/AhytDq4o/8dAX5CfO7dYaeXM7ipPY meIMVKRdLz3SLq62dITKaYoxcjBLCgkqhkiG9w0BCRQxPh48AEYAaQBsAGUA VgBhAHUAbAB0ACAATQBhAHMAdABlAHIAIABQAGEAcwBzAHcAbwByAGQAIABL AGUAeQAAMCMGCSqGSIb3DQEJFTEWBBTU3AXtNxOccaeBZ3SraBSYyPDQkDCC BXMGCyqGSIb3DQEMCgECoIIE7jCCBOowHAYKKoZIhvcNAQwBAzAOBAj5IN9P jzQh1gICCAAEggTIEKGT4y7r4iPyhD+89t8PAI7N+jgkwwhFgHNwgtn3EED4 INqk431XR9vHVra1TK4BJn10oDnPROiVomdlTzgxjlzPVxK22ppeJqlxCaNJ HPht1krwyOo8IIbVE4gV55Y9uLGWPd40hUPteqjHDNmoIXflT2RGIXo4T81C qO7BZNkxjuvrowgMaUZRj873xbPE6J/TR6ygMHBJHeTL+AGIdSSadajymd7x QW558F5Ta6X1pOVSH3Lb04FXH8OBX47Dw1JaCIzIDrBqaEBn3zhktSwBDO5N ZocRETzq8PRFXEZV1cF1578uMZSgHttLpgfFiavRaamprFuLXtavvXMdRiBg 3eZ/OTFf3DUa5w4l6TDsDaWyGj0iAWeKVE7b8emywBzfHWBCZgDa8QW1XKnC pm5070prm4+5RwwHSsagudU+VS9qREuWT11XPAucCv90PNX6LCbEtgUtrR0k EdoXVm33ArImruNXNVqOf4AkIvFwS6L3LLlJGjBQ/3Bg03SfU61BA0n8bweq xiUTm7noIftS2IqOa+JMBr+kfqccHbDJZMemgYl6fCB2kXzrnJO3cp1hH4I5 jGwzVlkEpk/ZouyIlUInP1TVCJnaEtdEddy8JQB8CPhkC4+qbAERrpSrHBol blS0/63b8UVQyPpANMzm1GWDcDfDztAGIYdVHQtKkVup2zdTB/v4M4qY2+cu DG1BcLWVBY/U07okBjb0IbYPUPZLtTVZUENKGlrUeEbtvof08QZX297p8Jjj aaHkPY+q2HbjpFZ0yUM5wZJcUlUsGCy5ArQcKgxk9rAAYZgLb/Z/1qGIFBhs 5l13jlbFtkcKzayQcg334cASKY8LXcUSvEQD9rkqxCTYpGbUtlwPliZ6a68D P5PXu7CwVgI8XbO97EyiLhaXE6efUKYebXmD7a2lNxxtQBILTqgO/66yLsAv 9KAFwnXtdX4ecc2EJgpUOJ2Cb09Cmpo9ENFqzI78QEsWk8t6wzTHnJrtp6nI Bd2bda7LESEGP/N1MYD3TXbze+oId0k/JzvReV2+cq0nlECj7GSK9K9jHC8B cp0sMovKPNIV+qrcAjh9vErrUsKpkYfMFBjfEs4jfJ4TST5Tc4EaY3HQmZYm igdmuYhPAkYzhM/9dhe8C852nXUmjsGmOEA3zx6iVZpkRjQj6NKHu37ELIe1 rwYZjyPfvGiQb2woG5sSkHDmSsiBoScsrXSJHo6fqDe30kzwRTE6b2dy79K2 drsfMfTcgbvjAkSUIkJDd/uvaBsh4CIvmquIPnm/NLgW4I4Bxg4SjRJk95Yz jQm8UK9dc9PWTXxUaoWnbWofX339z9kAmhNA5Bpsn9cojItVVGFsyONsDbT4 pBdDvt/9Ya6za+N3zCx/7tBp5Er7SW+zgwJsKI5ZD71aX4EWYA4qThjv9zQY 5o2f/m118rXrHcjtIRag1B75Ip6S5of0em/1vX0+3ienjgQ+10UAyiJs+qcY M/bjhEPMGUYOepSiMeSZRptP6o3G+IpobeFFRg6QEqgJNJE61qhH6KQfg0CK AbdrJJtUY0gl5LMyjAycRa8vq/ncI/mV3Z52w7rbBt0cQ+cPO1naButIbEiz PQR9f0kv4Bnleer2sMbDd7Z1k0ytMXIwSwYJKoZIhvcNAQkUMT4ePABGAGkA bABlAFYAYQB1AGwAdAAgAE0AYQBzAHQAZQByACAAUABhAHMAcwB3AG8AcgBk ACAASwBlAHkAADAjBgkqhkiG9w0BCRUxFgQU1NwF7TcTnHGngWd0q2gUmMjw 0JAwMDAhMAkGBSsOAwIaBQAEFAwE3aiMGdNcSnmSMup8HVI1VfvTBAhjBoD8 EWoC/wIBAQ== </data> <key>PrivateKeyExportPassword</key> <string>mypassword</string> </dict> <key>KeyType</key> <string>institutional</string> <key>NewCertificate</key> <data> MIICQTCCAaKgAwIBAgIBATAKBggqhkjOPQQDAjBNMRcwFQYDVQQDDA5HcmFoYW0gTWNM dWhhbjELMAkGA1UEBhMCVVMxJTAjBgkqhkiG8w0BCQEWFmdyYWhhbS5tY2x1aGFuQG1h Yy5jb20wHhcNMTcwNjEzMjIzOTU1WhcNMTgwNjEzMjIzOTU1WjBNMRcwFQYDVQQDDA5H cmFoYW0gTWNMdWhhbjELMAkGA1UEBhMCVVMxJTAjBgkqhkiG9w0BCQEWFmdyYWhhbS5t Y2x1aGFuQG1hYy5jb20wgZswEAYHKoZIzj0CAQYFK4EEACMDgYYABAD8hMbGJ9QBUjuB VU6y3iDwA1uXili0jkCog6JAAjzyTL5CVqb4Ql3LPKsVPFIQELsA/CibbkDkpdSu+wTa 9dJnWQHPUDItGdMQhVLaDsYsp+l2+J6q4gpmJteUy4TlPr5NloPn9HvgSxrohPWM9WOq pX0eACRUWJsnllmcEPswDg6dl6MwMC4wDgYDVR0PAQH/BAQDAgH+MBvGA1UdJQEB/wQS MBAGCCsGAQUFBwMDBgRVHSUAMAoGCCqGSM49BAMCA4GMADCBiAJCAUsNmZmNevkKLU7t Zj3F4mlrl/KHDl+U/nAFimTLuWVIYwttFVwaofMt+CiOULAzCyGjZKiIQC55G/Rk57Ka SRLAAkIBoesNcUhtwOnMTrvtW1gXmkYplNd5ZOrbYl0wYV+73drlTyYTEf7v4wJ4rZ6q iwjdriGsnT8+x+D+PJQdrtPJXBw= </data> <key>RequestType</key> <string>RotateFileVaultKey</string> </dict> <key>CommandUUID</key> <string>0001_RotateFileVaultKey</string></dict></plist>

See Also

Security

Security Information

Get security-related information about the device.

List the Certificates

Get a list of installed certificates.

Get the Bypass Code for Activation Lock

Get the code you use to bypass activation lock.

Clear the Bypass Code for Activation Lock

Clear the activation lock bypass code from the device.