-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_blueprints.go
1631 lines (1387 loc) · 61.3 KB
/
api_blueprints.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Kandji API
<html><head></head><body><h1 id="welcome-to-the-kandji-api-documentation">Welcome to the Kandji API Documentation</h1> <p>You can find your API URL in Settings > Access. The API URL will follow the below formats.</p> <ul> <li><p>US - <code>https://SubDomain.api.kandji.io</code></p> </li> <li><p>EU - <code>https://SubDomain.api.eu.kandji.io</code></p> </li> </ul> <p>For information on how to obtain an API token, please refer to the following support article.</p> <p><a href="https://support.kandji.io/api">https://support.kandji.io/api</a></p> <h4 id="rate-limit">Rate Limit</h4> <p>The Kandji API currently has an API rate limit of 10,000 requests per hour per customer.</p> <h4 id="request-methods">Request Methods</h4> <p>HTTP request methods supported by the Kandji API.</p> <div class="click-to-expand-wrapper is-table-wrapper"><table> <thead> <tr> <th>Method</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>The <code>GET</code> method requests a representation of the specified resource.</td> </tr> <tr> <td>POST</td> <td>The <code>POST</code> method submits an entity to the specified resource.</td> </tr> <tr> <td>PATCH</td> <td>The <code>PATCH</code> method applies partial modifications to a resource.</td> </tr> <tr> <td>DELETE</td> <td>The <code>DELETE</code> method deletes the specified resource.</td> </tr> </tbody> </table> </div><h4 id="response-codes">Response codes</h4> <p>Not all response codes apply to every endpoint.</p> <div class="click-to-expand-wrapper is-table-wrapper"><table> <thead> <tr> <th>Code</th> <th>Response</th> </tr> </thead> <tbody> <tr> <td>200</td> <td>OK</td> </tr> <tr> <td>201</td> <td>Created</td> </tr> <tr> <td>204</td> <td>No content</td> </tr> <tr> <td></td> <td>Typical response when sending the DELETE method.</td> </tr> <tr> <td>400</td> <td>Bad Request</td> </tr> <tr> <td></td> <td>"Command already running" - The command may already be running in a <em>Pending</em> state waiting on the device.</td> </tr> <tr> <td></td> <td>"Command is not allowed for current device" - The command may not be compatible with the target device.</td> </tr> <tr> <td></td> <td>"JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)"</td> </tr> <tr> <td>401</td> <td>Unauthorized</td> </tr> <tr> <td></td> <td>This error can occur if the token is incorrect, was revoked, or the token has expired.</td> </tr> <tr> <td>403</td> <td>Forbidden</td> </tr> <tr> <td></td> <td>The request was understood but cannot be authorized.</td> </tr> <tr> <td>404</td> <td>Not found</td> </tr> <tr> <td></td> <td>Unable to locate the resource in the Kandji tenant.</td> </tr> <tr> <td>415</td> <td>Unsupported Media Type</td> </tr> <tr> <td></td> <td>The request contains a media type which the server or resource does not support.</td> </tr> <tr> <td>500</td> <td>Internal server error</td> </tr> <tr> <td>503</td> <td>Service unavailable</td> </tr> <tr> <td></td> <td>This error can occur if a file upload is still being processed via the custom apps API.</td> </tr> </tbody> </table> </div><h4 id="data-structure">Data structure</h4> <p>The API returns all structured responses in JSON schema format.</p> <h4 id="examples">Examples</h4> <p>Code examples using the API can be found in the Kandji support <a href="https://github.com/kandji-inc/support/tree/main/api-tools">GitHub</a>.</p> </body></html>
API version: 1.0.0
Contact: mitchelsblake@gmail.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package kandji
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
type BlueprintsAPI interface {
/*
AssignLibraryItem Assign Library Item
<p>This endpoint allows assigning a library item to a specific blueprint (classic and maps). The response will include a list of library item IDs assigned to the blueprint.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
<h3 id="request-body">Request Body</h3>
<ul>
<li><p><code>library_item_id</code> (string, required)</p>
</li>
<li><p><code>assignment_node_id</code> (string, required for maps)</p>
<ul>
<li>Note: To find the assignment_node_id, view the map in a browser. Then, on your keyboard, press and hold the Option ⌥ key. Each node ID remains fixed for the lifespan of the node on the map.</li>
</ul>
</li>
</ul>
<h3 id="error-responses">Error responses</h3>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Code</strong></th>
<th><strong>Body</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>400 - Bad Request</td>
<td>Bad Request</td>
</tr>
<tr>
<td></td>
<td>"Library Item already exists on Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Library Item already exists in Assignment Node"</td>
</tr>
<tr>
<td></td>
<td>"assignment_node_id cannot be provided for Classic Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Must provide assignment_node_id for Assignment Map Blueprint"</td>
</tr>
</tbody>
</table>
</div>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiAssignLibraryItemRequest
*/
AssignLibraryItem(ctx context.Context, blueprintId string) ApiAssignLibraryItemRequest
// AssignLibraryItemExecute executes the request
// @return map[string]interface{}
AssignLibraryItemExecute(r ApiAssignLibraryItemRequest) (map[string]interface{}, *http.Response, error)
/*
CreateBlueprint Create Blueprint
<p>This request creates a new empty Blueprint or a new Blueprint from a template. The keys <code>name</code> and <code>enrollment_code</code> <code>is_active</code> are required, and the blueprint name key must be unique from the existing blueprint names in the Kandji tenant.</p>
<p>optionally, <code>type: map</code> can be used when creating a new Assignment Map blueprint.</p>
<p>Note: If cloning an existing blueprint,`type` value and the type of sourced (`source.id`) blueprint must match and `source.type` value must be set to `blueprint`.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateBlueprintRequest
*/
CreateBlueprint(ctx context.Context) ApiCreateBlueprintRequest
// CreateBlueprintExecute executes the request
// @return BlueprintsCreateBlueprint201Response
CreateBlueprintExecute(r ApiCreateBlueprintRequest) (*BlueprintsCreateBlueprint201Response, *http.Response, error)
/*
DeleteBlueprint Delete Blueprint
<h1 id="warning"><strong>WARNING!</strong></h1>
<p>This is a HIGHLY destructive action.</p>
<p>Deleting a Blueprint will un-manage ALL devices assigned to the Blueprint.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiDeleteBlueprintRequest
*/
DeleteBlueprint(ctx context.Context, blueprintId string) ApiDeleteBlueprintRequest
// DeleteBlueprintExecute executes the request
DeleteBlueprintExecute(r ApiDeleteBlueprintRequest) (*http.Response, error)
/*
GetBlueprint Get Blueprint
<p>This request returns information about a specific blueprint based on blueprint ID.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiGetBlueprintRequest
*/
GetBlueprint(ctx context.Context, blueprintId string) ApiGetBlueprintRequest
// GetBlueprintExecute executes the request
// @return BlueprintsGetBlueprint200Response
GetBlueprintExecute(r ApiGetBlueprintRequest) (*BlueprintsGetBlueprint200Response, *http.Response, error)
/*
GetBlueprintTemplates Get Blueprint Templates
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBlueprintTemplatesRequest
*/
GetBlueprintTemplates(ctx context.Context) ApiGetBlueprintTemplatesRequest
// GetBlueprintTemplatesExecute executes the request
GetBlueprintTemplatesExecute(r ApiGetBlueprintTemplatesRequest) (*http.Response, error)
/*
GetManualEnrollmentProfile Get Manual Enrollment Profile
<p>This request returns the manual enrollment profile (.mobileconfig file) for a specified Blueprint.</p>
<p>This request will return the enrollment profile even if "Require Authentication" is configured for the Blueprint in Manual Enrollment.</p>
<p>The enrollment profile will be returned in raw form with response headers:</p>
<ul>
<li><p><code>Content-Type</code> = <code>application/x-apple-aspen-config</code></p>
</li>
<li><p><code>Content-Disposition</code> = <code>attachment;filename=kandji-enroll.mobileconfig</code></p>
</li>
</ul>
<p>An optional query parameter <code>sso=true</code> can be used to return a URL for SSO authentication instead. If this query parameter is used for a Blueprint that does not require authentication, then the enrollment profile will be returned.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiGetManualEnrollmentProfileRequest
*/
GetManualEnrollmentProfile(ctx context.Context, blueprintId string) ApiGetManualEnrollmentProfileRequest
// GetManualEnrollmentProfileExecute executes the request
// @return string
GetManualEnrollmentProfileExecute(r ApiGetManualEnrollmentProfileRequest) (string, *http.Response, error)
/*
ListBlueprints List Blueprints
This request returns a list of a blueprint records in the Kandji tenant. Optional query parameters can be specified to filter the results.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListBlueprintsRequest
*/
ListBlueprints(ctx context.Context) ApiListBlueprintsRequest
// ListBlueprintsExecute executes the request
// @return AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response
ListBlueprintsExecute(r ApiListBlueprintsRequest) (*AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response, *http.Response, error)
/*
ListLibraryItems List Library Items
<p>This API endpoint retrieves a list of library items associated with a specific blueprint. (classic and maps). Requires that the blueprint ID is passed as a path parameter in the URL.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
<h3 id="response-fields">Response fields</h3>
<ul>
<li><p><code>count</code> (int): The total count of library items.</p>
</li>
<li><p><code>next</code> (str): The URL for the next page of results, if available. If not available will value will be <code>null</code>.</p>
</li>
<li><p><code>previous</code> (str): The URL for the previous page of results, if available. If not available will value will be <code>null</code>.</p>
</li>
<li><p><code>results</code> (object): An array containing objects with the following fields:</p>
<ul>
<li><p><code>id</code> (str): The ID of the library item.</p>
</li>
<li><p><code>name</code> (str): The name of the library item.</p>
</li>
</ul>
</li>
</ul>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiListLibraryItemsRequest
*/
ListLibraryItems(ctx context.Context, blueprintId string) ApiListLibraryItemsRequest
// ListLibraryItemsExecute executes the request
// @return AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response
ListLibraryItemsExecute(r ApiListLibraryItemsRequest) (*AutomatedDeviceEnrollmentIntegrationsListAdeDevices200Response, *http.Response, error)
/*
RemoveLibraryItem Remove Library Item
<p>This endpoint allows removing a library item from a specific blueprint (classic and maps). The response will include a list of library item IDs assigned to the blueprint.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
<h3 id="request-body">Request Body</h3>
<ul>
<li><p><code>library_item_id</code> (string, required)</p>
</li>
<li><p><code>assignment_node_id</code> (string, required for maps)</p>
</li>
</ul>
<h3 id="error-responses">Error responses</h3>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Code</strong></th>
<th><strong>Body</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>400 - Bad Request</td>
<td>Bad Request</td>
</tr>
<tr>
<td></td>
<td>"assignment_node_id cannot be provided for Classic Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Must provide assignment_node_id for Assignment Map Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Library Item does not exist on Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Library Item does not exist in Assignment Node"</td>
</tr>
</tbody>
</table>
</div>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiRemoveLibraryItemRequest
*/
RemoveLibraryItem(ctx context.Context, blueprintId string) ApiRemoveLibraryItemRequest
// RemoveLibraryItemExecute executes the request
// @return map[string]interface{}
RemoveLibraryItemExecute(r ApiRemoveLibraryItemRequest) (map[string]interface{}, *http.Response, error)
/*
UpdateBlueprint Update Blueprint
<p>This requests allows updating of the name, icon, icon color, description, enrollment code, and active status on an existing blueprint.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiUpdateBlueprintRequest
*/
UpdateBlueprint(ctx context.Context, blueprintId string) ApiUpdateBlueprintRequest
// UpdateBlueprintExecute executes the request
// @return BlueprintsUpdateBlueprint200Response
UpdateBlueprintExecute(r ApiUpdateBlueprintRequest) (*BlueprintsUpdateBlueprint200Response, *http.Response, error)
}
// BlueprintsAPIService BlueprintsAPI service
type BlueprintsAPIService service
type ApiAssignLibraryItemRequest struct {
ctx context.Context
ApiService BlueprintsAPI
blueprintId string
body *string
}
func (r ApiAssignLibraryItemRequest) Body(body string) ApiAssignLibraryItemRequest {
r.body = &body
return r
}
func (r ApiAssignLibraryItemRequest) Execute() (map[string]interface{}, *http.Response, error) {
return r.ApiService.AssignLibraryItemExecute(r)
}
/*
AssignLibraryItem Assign Library Item
<p>This endpoint allows assigning a library item to a specific blueprint (classic and maps). The response will include a list of library item IDs assigned to the blueprint.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
<h3 id="request-body">Request Body</h3>
<ul>
<li><p><code>library_item_id</code> (string, required)</p>
</li>
<li><p><code>assignment_node_id</code> (string, required for maps)</p>
<ul>
<li>Note: To find the assignment_node_id, view the map in a browser. Then, on your keyboard, press and hold the Option ⌥ key. Each node ID remains fixed for the lifespan of the node on the map.</li>
</ul>
</li>
</ul>
<h3 id="error-responses">Error responses</h3>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Code</strong></th>
<th><strong>Body</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>400 - Bad Request</td>
<td>Bad Request</td>
</tr>
<tr>
<td></td>
<td>"Library Item already exists on Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Library Item already exists in Assignment Node"</td>
</tr>
<tr>
<td></td>
<td>"assignment_node_id cannot be provided for Classic Blueprint"</td>
</tr>
<tr>
<td></td>
<td>"Must provide assignment_node_id for Assignment Map Blueprint"</td>
</tr>
</tbody>
</table>
</div>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiAssignLibraryItemRequest
*/
func (a *BlueprintsAPIService) AssignLibraryItem(ctx context.Context, blueprintId string) ApiAssignLibraryItemRequest {
return ApiAssignLibraryItemRequest{
ApiService: a,
ctx: ctx,
blueprintId: blueprintId,
}
}
// Execute executes the request
// @return map[string]interface{}
func (a *BlueprintsAPIService) AssignLibraryItemExecute(r ApiAssignLibraryItemRequest) (map[string]interface{}, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue map[string]interface{}
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "BlueprintsAPIService.AssignLibraryItem")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/blueprints/{blueprint_id}/assign-library-item"
localVarPath = strings.Replace(localVarPath, "{"+"blueprint_id"+"}", url.PathEscape(parameterValueToString(r.blueprintId, "blueprintId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.body
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiCreateBlueprintRequest struct {
ctx context.Context
ApiService BlueprintsAPI
name *string
enrollmentCodeIsActive *string
enrollmentCodeCode *string
sourceType *string
sourceId *string
type_ *string
}
// (required) Set the name of the Blueprint. The name provided must be unique.
func (r ApiCreateBlueprintRequest) Name(name string) ApiCreateBlueprintRequest {
r.name = &name
return r
}
// (required) Enable or Disable the Blueprint for manual device enrollment from the enrollment portal
func (r ApiCreateBlueprintRequest) EnrollmentCodeIsActive(enrollmentCodeIsActive string) ApiCreateBlueprintRequest {
r.enrollmentCodeIsActive = &enrollmentCodeIsActive
return r
}
// Optionally, set the enrollment code of the Blueprint. This key is not required. If an enrollment code is not supplied in the payload body, it will be randomly generated. The enrollment code will be returned in the response and visible in the Web app.
func (r ApiCreateBlueprintRequest) EnrollmentCodeCode(enrollmentCodeCode string) ApiCreateBlueprintRequest {
r.enrollmentCodeCode = &enrollmentCodeCode
return r
}
// Set the source to create the blueprint from. Possible options: <code>template</code> and <code>blueprint</code>.
func (r ApiCreateBlueprintRequest) SourceType(sourceType string) ApiCreateBlueprintRequest {
r.sourceType = &sourceType
return r
}
// Set either the source template ID, or the source Blueprint ID to clone an existing template or blueprint.
func (r ApiCreateBlueprintRequest) SourceId(sourceId string) ApiCreateBlueprintRequest {
r.sourceId = &sourceId
return r
}
// Choose the type of blueprint to create. Options: <code>classic</code> or <code>map</code>
func (r ApiCreateBlueprintRequest) Type_(type_ string) ApiCreateBlueprintRequest {
r.type_ = &type_
return r
}
func (r ApiCreateBlueprintRequest) Execute() (*BlueprintsCreateBlueprint201Response, *http.Response, error) {
return r.ApiService.CreateBlueprintExecute(r)
}
/*
CreateBlueprint Create Blueprint
<p>This request creates a new empty Blueprint or a new Blueprint from a template. The keys <code>name</code> and <code>enrollment_code</code> <code>is_active</code> are required, and the blueprint name key must be unique from the existing blueprint names in the Kandji tenant.</p>
<p>optionally, <code>type: map</code> can be used when creating a new Assignment Map blueprint.</p>
<p>Note: If cloning an existing blueprint,`type` value and the type of sourced (`source.id`) blueprint must match and `source.type` value must be set to `blueprint`.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateBlueprintRequest
*/
func (a *BlueprintsAPIService) CreateBlueprint(ctx context.Context) ApiCreateBlueprintRequest {
return ApiCreateBlueprintRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
// @return BlueprintsCreateBlueprint201Response
func (a *BlueprintsAPIService) CreateBlueprintExecute(r ApiCreateBlueprintRequest) (*BlueprintsCreateBlueprint201Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *BlueprintsCreateBlueprint201Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "BlueprintsAPIService.CreateBlueprint")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/blueprints"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.name == nil {
return localVarReturnValue, nil, reportError("name is required and must be specified")
}
if r.enrollmentCodeIsActive == nil {
return localVarReturnValue, nil, reportError("enrollmentCodeIsActive is required and must be specified")
}
if r.enrollmentCodeCode == nil {
return localVarReturnValue, nil, reportError("enrollmentCodeCode is required and must be specified")
}
if r.sourceType == nil {
return localVarReturnValue, nil, reportError("sourceType is required and must be specified")
}
if r.sourceId == nil {
return localVarReturnValue, nil, reportError("sourceId is required and must be specified")
}
if r.type_ == nil {
return localVarReturnValue, nil, reportError("type_ is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/x-www-form-urlencoded"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
parameterAddToHeaderOrQuery(localVarFormParams, "name", r.name, "", "")
parameterAddToHeaderOrQuery(localVarFormParams, "enrollment_code.is_active", r.enrollmentCodeIsActive, "", "")
parameterAddToHeaderOrQuery(localVarFormParams, "enrollment_code.code", r.enrollmentCodeCode, "", "")
parameterAddToHeaderOrQuery(localVarFormParams, "source.type", r.sourceType, "", "")
parameterAddToHeaderOrQuery(localVarFormParams, "source.id", r.sourceId, "", "")
parameterAddToHeaderOrQuery(localVarFormParams, "type", r.type_, "", "")
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
if localVarHTTPResponse.StatusCode == 400 {
var v map[string]interface{}
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiDeleteBlueprintRequest struct {
ctx context.Context
ApiService BlueprintsAPI
blueprintId string
}
func (r ApiDeleteBlueprintRequest) Execute() (*http.Response, error) {
return r.ApiService.DeleteBlueprintExecute(r)
}
/*
DeleteBlueprint Delete Blueprint
<h1 id="warning"><strong>WARNING!</strong></h1>
<p>This is a HIGHLY destructive action.</p>
<p>Deleting a Blueprint will un-manage ALL devices assigned to the Blueprint.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiDeleteBlueprintRequest
*/
func (a *BlueprintsAPIService) DeleteBlueprint(ctx context.Context, blueprintId string) ApiDeleteBlueprintRequest {
return ApiDeleteBlueprintRequest{
ApiService: a,
ctx: ctx,
blueprintId: blueprintId,
}
}
// Execute executes the request
func (a *BlueprintsAPIService) DeleteBlueprintExecute(r ApiDeleteBlueprintRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "BlueprintsAPIService.DeleteBlueprint")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/blueprints/{blueprint_id}"
localVarPath = strings.Replace(localVarPath, "{"+"blueprint_id"+"}", url.PathEscape(parameterValueToString(r.blueprintId, "blueprintId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type ApiGetBlueprintRequest struct {
ctx context.Context
ApiService BlueprintsAPI
blueprintId string
}
func (r ApiGetBlueprintRequest) Execute() (*BlueprintsGetBlueprint200Response, *http.Response, error) {
return r.ApiService.GetBlueprintExecute(r)
}
/*
GetBlueprint Get Blueprint
<p>This request returns information about a specific blueprint based on blueprint ID.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiGetBlueprintRequest
*/
func (a *BlueprintsAPIService) GetBlueprint(ctx context.Context, blueprintId string) ApiGetBlueprintRequest {
return ApiGetBlueprintRequest{
ApiService: a,
ctx: ctx,
blueprintId: blueprintId,
}
}
// Execute executes the request
// @return BlueprintsGetBlueprint200Response
func (a *BlueprintsAPIService) GetBlueprintExecute(r ApiGetBlueprintRequest) (*BlueprintsGetBlueprint200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *BlueprintsGetBlueprint200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "BlueprintsAPIService.GetBlueprint")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/blueprints/{blueprint_id}"
localVarPath = strings.Replace(localVarPath, "{"+"blueprint_id"+"}", url.PathEscape(parameterValueToString(r.blueprintId, "blueprintId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiGetBlueprintTemplatesRequest struct {
ctx context.Context
ApiService BlueprintsAPI
limit *string
offset *string
}
// Number of results to return per page.
func (r ApiGetBlueprintTemplatesRequest) Limit(limit string) ApiGetBlueprintTemplatesRequest {
r.limit = &limit
return r
}
// The initial index from which to return the results.
func (r ApiGetBlueprintTemplatesRequest) Offset(offset string) ApiGetBlueprintTemplatesRequest {
r.offset = &offset
return r
}
func (r ApiGetBlueprintTemplatesRequest) Execute() (*http.Response, error) {
return r.ApiService.GetBlueprintTemplatesExecute(r)
}
/*
GetBlueprintTemplates Get Blueprint Templates
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBlueprintTemplatesRequest
*/
func (a *BlueprintsAPIService) GetBlueprintTemplates(ctx context.Context) ApiGetBlueprintTemplatesRequest {
return ApiGetBlueprintTemplatesRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
func (a *BlueprintsAPIService) GetBlueprintTemplatesExecute(r ApiGetBlueprintTemplatesRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "BlueprintsAPIService.GetBlueprintTemplates")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/blueprints/templates/"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.limit != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "form", "")
}
if r.offset != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "offset", r.offset, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type ApiGetManualEnrollmentProfileRequest struct {
ctx context.Context
ApiService BlueprintsAPI
blueprintId string
sso *string
}
// Use the <code>sso</code> query parameter, set to <code>true</code>, to return a URL instead of the manual enrollment profile. This parameter should only be used for blueprints in which &quot;Require Authentication&quot; is configured for Manual Enrollment. The returned URL must be used to authenticate via SSO to receive an enrollment profile.
func (r ApiGetManualEnrollmentProfileRequest) Sso(sso string) ApiGetManualEnrollmentProfileRequest {
r.sso = &sso
return r
}
func (r ApiGetManualEnrollmentProfileRequest) Execute() (string, *http.Response, error) {
return r.ApiService.GetManualEnrollmentProfileExecute(r)
}
/*
GetManualEnrollmentProfile Get Manual Enrollment Profile
<p>This request returns the manual enrollment profile (.mobileconfig file) for a specified Blueprint.</p>
<p>This request will return the enrollment profile even if "Require Authentication" is configured for the Blueprint in Manual Enrollment.</p>
<p>The enrollment profile will be returned in raw form with response headers:</p>
<ul>
<li><p><code>Content-Type</code> = <code>application/x-apple-aspen-config</code></p>
</li>
<li><p><code>Content-Disposition</code> = <code>attachment;filename=kandji-enroll.mobileconfig</code></p>
</li>
</ul>
<p>An optional query parameter <code>sso=true</code> can be used to return a URL for SSO authentication instead. If this query parameter is used for a Blueprint that does not require authentication, then the enrollment profile will be returned.</p>
<h3 id="request-parameters">Request Parameters</h3>
<p><code>blueprint_id</code> (path parameter): The unique identifier of the blueprint.</p>
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blueprintId
@return ApiGetManualEnrollmentProfileRequest
*/
func (a *BlueprintsAPIService) GetManualEnrollmentProfile(ctx context.Context, blueprintId string) ApiGetManualEnrollmentProfileRequest {
return ApiGetManualEnrollmentProfileRequest{
ApiService: a,
ctx: ctx,
blueprintId: blueprintId,
}
}
// Execute executes the request
// @return string
func (a *BlueprintsAPIService) GetManualEnrollmentProfileExecute(r ApiGetManualEnrollmentProfileRequest) (string, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue string
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "BlueprintsAPIService.GetManualEnrollmentProfile")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/blueprints/{blueprint_id}/ota-enrollment-profile"
localVarPath = strings.Replace(localVarPath, "{"+"blueprint_id"+"}", url.PathEscape(parameterValueToString(r.blueprintId, "blueprintId")), -1)
localVarHeaderParams := make(map[string]string)