All URIs are relative to **
| Method | HTTP request | Description |
|---|---|---|
| getActivationLockBypassCode | GET /api/v1/devices/{device_id}/secrets/bypasscode | Get Activation Lock Bypass Code |
| getFilevaultRecoveryKey | GET /api/v1/devices/{device_id}/secrets/filevaultkey | Get FileVault Recovery Key |
| getRecoveryLockPassword | GET /api/v1/devices/{device_id}/secrets/recoverypassword | Get Recovery Lock Password |
| getUnlockPin | GET /api/v1/devices/{device_id}/secrets/unlockpin | Get Unlock Pin |
Get Activation Lock Bypass Code
This request allows you to retrieve the Activation Lock Bypass code.
user_based_albc is the user-based Activation Lock bypass code for when Activation Lock is enabled using an personal Apple ID and Find My.
device_based_albc is the device-based Activation Lock bypass code for when Activation Lock is enabled by the MDM server.
device_id (path parameter): The unique identifier of the device.
kandji getActivationLockBypassCode device_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | string | [default to null] |
DeviceSecretsGetActivationLockBypassCode200Response
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Get FileVault Recovery Key
This request allows you to retrieve the FileVault Recovery key for a macOS device.
device_id (path parameter): The unique identifier of the device.
kandji getFilevaultRecoveryKey device_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | string | [default to null] |
DeviceSecretsGetFilevaultRecoveryKey200Response
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Get Recovery Lock Password
This request returns the Recovery Lock password for a Mac with an Apple Silicon processor and the legacy EFI firmware password for a Mac with an Intel processor.
For more details on setting and managing Recovery passwords, see this Kandji support article.
device_id (path parameter): The unique identifier of the device.
kandji getRecoveryLockPassword device_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | string | [default to null] |
DeviceSecretsGetRecoveryLockPassword200Response
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Get Unlock Pin
This request allows you to retrieve the device unlock pin for a macOS device.
device_id (path parameter): The unique identifier of the device.
kandji getUnlockPin device_id=value| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | string | [default to null] |
DeviceSecretsGetUnlockPin200Response
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]