All URIs are relative to https://<sub_domain>.api.kandji.io
| Method | HTTP request | Description |
|---|---|---|
| CreateAdeIntegration | Post /api/v1/integrations/apple/ade/ | Create ADE integration |
| DeleteAdeIntegration | Delete /api/v1/integrations/apple/ade/{ade_token_id} | Delete ADE integration |
| DownloadAdePublicKey | Get /api/v1/integrations/apple/ade/public_key/ | Download ADE public key |
| GetAdeDevice | Get /api/v1/integrations/apple/ade/devices/{device_id} | Get ADE device |
| GetAdeIntegration | Get /api/v1/integrations/apple/ade/{ade_token_id} | Get ADE integration |
| ListAdeDevices | Get /api/v1/integrations/apple/ade/devices | List ADE devices |
| ListAdeIntegrations | Get /api/v1/integrations/apple/ade | List ADE integrations |
| ListDevicesAssociatedToAdeToken | Get /api/v1/integrations/apple/ade/{ade_token_id}/devices | List devices associated to ADE token |
| RenewAdeIntegration | Post /api/v1/integrations/apple/ade/{ade_token_id}/renew | Renew ADE integration |
| UpdateAdeDevice | Patch /api/v1/integrations/apple/ade/devices/{device_id} | Update ADE device |
| UpdateAdeIntegration | Patch /api/v1/integrations/apple/ade/{ade_token_id} | Update ADE integration |
AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200Response CreateAdeIntegration(ctx).BlueprintId(blueprintId).Phone(phone).Email(email).File(file).Execute()
Create ADE integration
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
blueprintId := "blueprintId_example" // string |
phone := "phone_example" // string |
email := "email_example" // string |
file := os.NewFile(1234, "some_file") // *os.File | This is the MDM server token file(.p7m) download from ABM. Once downloaded from ABM, the file can be uploaded via API.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.CreateAdeIntegration(context.Background()).BlueprintId(blueprintId).Phone(phone).Email(email).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.CreateAdeIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateAdeIntegration`: AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200Response
fmt.Fprintf(os.Stdout, "Response from `AutomatedDeviceEnrollmentIntegrationsAPI.CreateAdeIntegration`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateAdeIntegrationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| blueprintId | string | ||
| phone | string | ||
| string | |||
| file | *os.File | This is the MDM server token file(.p7m) download from ABM. Once downloaded from ABM, the file can be uploaded via API. |
AutomatedDeviceEnrollmentIntegrationsCreateAdeIntegration200Response
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteAdeIntegration(ctx, adeTokenId).Execute()
Delete ADE integration
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
adeTokenId := "adeTokenId_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.DeleteAdeIntegration(context.Background(), adeTokenId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.DeleteAdeIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| adeTokenId | string |
Other parameters are passed through a pointer to a apiDeleteAdeIntegrationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: multipart/form-data
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string DownloadAdePublicKey(ctx).Execute()
Download ADE public key
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.DownloadAdePublicKey(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.DownloadAdePublicKey``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DownloadAdePublicKey`: string
fmt.Fprintf(os.Stdout, "Response from `AutomatedDeviceEnrollmentIntegrationsAPI.DownloadAdePublicKey`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiDownloadAdePublicKeyRequest struct via the builder pattern
string
- Content-Type: Not defined
- Accept: application/x-x509-ca-cert
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response GetAdeDevice(ctx, deviceId).Execute()
Get ADE device
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
deviceId := "deviceId_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.GetAdeDevice(context.Background(), deviceId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.GetAdeDevice``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAdeDevice`: AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response
fmt.Fprintf(os.Stdout, "Response from `AutomatedDeviceEnrollmentIntegrationsAPI.GetAdeDevice`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| deviceId | string |
Other parameters are passed through a pointer to a apiGetAdeDeviceRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAdeIntegration(ctx, adeTokenId).Execute()
Get ADE integration
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
adeTokenId := "adeTokenId_example" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.GetAdeIntegration(context.Background(), adeTokenId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.GetAdeIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| adeTokenId | string |
Other parameters are passed through a pointer to a apiGetAdeIntegrationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response ListAdeDevices(ctx).BlueprintId(blueprintId).UserId(userId).DepAccount(depAccount).DeviceFamily(deviceFamily).Model(model).Os(os).ProfileStatus(profileStatus).SerialNumber(serialNumber).Page(page).Execute()
List ADE devices
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
blueprintId := "fce0cc58-caa5-40d2-a0d7-a0b257127ec5" // string | Return results "containing" the specified blueprint id (optional)
userId := "8136" // string | "exact" match on kandji user ID number (optional)
depAccount := "depAccount_example" // string | The ADE token UUID (optional)
deviceFamily := "deviceFamily_example" // string | Mac, iPhone, iPad, AppleTV, iPod (optional)
model := "MacBook Air" // string | Return model results "containing" the specified model string. - "iPad (8th Generation)", "MacBook Air" (optional)
os := "os_example" // string | OSX, iOS, tvOS (optional)
profileStatus := "profileStatus_example" // string | The automated device enrollment profile assignment status - assigned, empty, pushed, removed (optional)
serialNumber := "serialNumber_example" // string | Search for a specific device by Serial Number. If partial serial number is provided in the query, all device containing the partial string will be returned. (optional)
page := "1" // string | Use the <code>page</code> parameter to page through results or to request a specific page. By default, if a page is not specified, page 1 is returned. Note: 300 device records are returned per page of results. Alternatively, the <code>next</code> and <code>previous</code> key attributes in the response can be used to request the next page of results or return to the previous page. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.ListAdeDevices(context.Background()).BlueprintId(blueprintId).UserId(userId).DepAccount(depAccount).DeviceFamily(deviceFamily).Model(model).Os(os).ProfileStatus(profileStatus).SerialNumber(serialNumber).Page(page).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.ListAdeDevices``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListAdeDevices`: AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response
fmt.Fprintf(os.Stdout, "Response from `AutomatedDeviceEnrollmentIntegrationsAPI.ListAdeDevices`: %v\n", resp)
}Other parameters are passed through a pointer to a apiListAdeDevicesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| blueprintId | string | Return results "containing" the specified blueprint id | |
| userId | string | "exact" match on kandji user ID number | |
| depAccount | string | The ADE token UUID | |
| deviceFamily | string | Mac, iPhone, iPad, AppleTV, iPod | |
| model | string | Return model results "containing" the specified model string. - "iPad (8th Generation)", "MacBook Air" | |
| os | string | OSX, iOS, tvOS | |
| profileStatus | string | The automated device enrollment profile assignment status - assigned, empty, pushed, removed | |
| serialNumber | string | Search for a specific device by Serial Number. If partial serial number is provided in the query, all device containing the partial string will be returned. | |
| page | string | Use the <code>page</code> parameter to page through results or to request a specific page. By default, if a page is not specified, page 1 is returned. Note: 300 device records are returned per page of results. Alternatively, the <code>next</code> and <code>previous</code> key attributes in the response can be used to request the next page of results or return to the previous page. |
AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListAdeIntegrations(ctx).Execute()
List ADE integrations
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.ListAdeIntegrations(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.ListAdeIntegrations``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiListAdeIntegrationsRequest struct via the builder pattern
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AutomatedDeviceEnrollmentIntegrationsListDevicesAssociatedToAdeToken200Response ListDevicesAssociatedToAdeToken(ctx, adeTokenId).Page(page).Execute()
List devices associated to ADE token
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
adeTokenId := "adeTokenId_example" // string |
page := "1" // string | Use the <code>page</code> parameter to page through results or to request a specific page. By default, if a page is not specified, page 1 is returned. Note: 300 device records are returned per page of results. Alternatively, the <code>next</code> and <code>previous</code> key attributes in the response can be used to request the next page of results or return to the previous page. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.ListDevicesAssociatedToAdeToken(context.Background(), adeTokenId).Page(page).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.ListDevicesAssociatedToAdeToken``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListDevicesAssociatedToAdeToken`: AutomatedDeviceEnrollmentIntegrationsListDevicesAssociatedToAdeToken200Response
fmt.Fprintf(os.Stdout, "Response from `AutomatedDeviceEnrollmentIntegrationsAPI.ListDevicesAssociatedToAdeToken`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| adeTokenId | string |
Other parameters are passed through a pointer to a apiListDevicesAssociatedToAdeTokenRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
page | string | Use the <code>page</code> parameter to page through results or to request a specific page. By default, if a page is not specified, page 1 is returned. Note: 300 device records are returned per page of results. Alternatively, the <code>next</code> and <code>previous</code> key attributes in the response can be used to request the next page of results or return to the previous page. |
AutomatedDeviceEnrollmentIntegrationsListDevicesAssociatedToAdeToken200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RenewAdeIntegration(ctx, adeTokenId).BlueprintId(blueprintId).Phone(phone).Email(email).File(file).Execute()
Renew ADE integration
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
adeTokenId := "adeTokenId_example" // string |
blueprintId := "blueprintId_example" // string |
phone := "phone_example" // string |
email := "email_example" // string |
file := os.NewFile(1234, "some_file") // *os.File | This is the MDM server token file(.p7m) download from ABM. Once downloaded from ABM, the file can be uploaded via API.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.RenewAdeIntegration(context.Background(), adeTokenId).BlueprintId(blueprintId).Phone(phone).Email(email).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.RenewAdeIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| adeTokenId | string |
Other parameters are passed through a pointer to a apiRenewAdeIntegrationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
blueprintId | string | | phone | string | | email | string | | file | *os.File | This is the MDM server token file(.p7m) download from ABM. Once downloaded from ABM, the file can be uploaded via API. |
(empty response body)
- Content-Type: multipart/form-data
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response UpdateAdeDevice(ctx, deviceId).Body(body).Execute()
Update ADE device
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
deviceId := "deviceId_example" // string |
body := "{"blueprint_id":"3013eb7c-d0c1-4689-852a-50776a92036b","asset_tag":"123456","user_id":"5344c996-8823-4b37-8d6e-8515fc7c3a0a"}" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.UpdateAdeDevice(context.Background(), deviceId).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.UpdateAdeDevice``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateAdeDevice`: AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response
fmt.Fprintf(os.Stdout, "Response from `AutomatedDeviceEnrollmentIntegrationsAPI.UpdateAdeDevice`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| deviceId | string |
Other parameters are passed through a pointer to a apiUpdateAdeDeviceRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
body | string | |
AutomatedDeviceEnrollmentIntegrationsGetAdeDevice200Response
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateAdeIntegration(ctx, adeTokenId).Body(body).Execute()
Update ADE integration
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/MScottBlake/kandji-go-sdk"
)
func main() {
adeTokenId := "adeTokenId_example" // string |
body := "{"blueprint_id":"bf21d9cf-17cf-48b3-890d-7bc27c241bb7","phone":"1234567890","email":"example@accuhive.io"}" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AutomatedDeviceEnrollmentIntegrationsAPI.UpdateAdeIntegration(context.Background(), adeTokenId).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AutomatedDeviceEnrollmentIntegrationsAPI.UpdateAdeIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| adeTokenId | string |
Other parameters are passed through a pointer to a apiUpdateAdeIntegrationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
body | string | |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]