Skip to content

Latest commit

 

History

History
212 lines (144 loc) · 6.83 KB

DeviceSecretsAPI.md

File metadata and controls

212 lines (144 loc) · 6.83 KB
Raw

DeviceSecretsAPI

All URIs are relative to https://<sub_domain>.api.kandji.io

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

getActivationLockBypassCode

    open class func getActivationLockBypassCode(deviceId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

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.

Request Parameters

device_id (path parameter): The unique identifier of the device.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let deviceId = "deviceId_example" // String | 

// Get Activation Lock Bypass Code
DeviceSecretsAPI.getActivationLockBypassCode(deviceId: deviceId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
deviceId String

Return type

AnyCodable

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFilevaultRecoveryKey

    open class func getFilevaultRecoveryKey(deviceId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Get FileVault Recovery Key

This request allows you to retrieve the FileVault Recovery key for a macOS device.

Request Parameters

device_id (path parameter): The unique identifier of the device.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let deviceId = "deviceId_example" // String | 

// Get FileVault Recovery Key
DeviceSecretsAPI.getFilevaultRecoveryKey(deviceId: deviceId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
deviceId String

Return type

AnyCodable

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRecoveryLockPassword

    open class func getRecoveryLockPassword(deviceId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

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.

Request Parameters

device_id (path parameter): The unique identifier of the device.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let deviceId = "deviceId_example" // String | 

// Get Recovery Lock Password
DeviceSecretsAPI.getRecoveryLockPassword(deviceId: deviceId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
deviceId String

Return type

AnyCodable

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUnlockPin

    open class func getUnlockPin(deviceId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Get Unlock Pin

This request allows you to retrieve the device unlock pin for a macOS device.

Request Parameters

device_id (path parameter): The unique identifier of the device.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let deviceId = "deviceId_example" // String | 

// Get Unlock Pin
DeviceSecretsAPI.getUnlockPin(deviceId: deviceId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
deviceId String

Return type

AnyCodable

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]