@itentialopensource/adapter-digicert_pki 0.1.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/CALLS.md +1245 -0
  2. package/CHANGELOG.md +8 -1
  3. package/adapter.js +13519 -0
  4. package/entities/ACME/action.json +166 -0
  5. package/entities/ACME/mockdatafiles/createAcmeAuthentication-default.json +21 -0
  6. package/entities/ACME/mockdatafiles/getAcmeAuthentication-default.json +21 -0
  7. package/entities/ACME/mockdatafiles/listAcmeAuthentication-default.json +41 -0
  8. package/entities/ACME/mockdatafiles/updateAcmeAuthentication-default.json +21 -0
  9. package/entities/ACME/schema.json +125 -0
  10. package/entities/AuthenticationCACertificates/action.json +107 -0
  11. package/entities/AuthenticationCACertificates/schema.json +155 -0
  12. package/entities/AuthenticationCATemplates/action.json +187 -0
  13. package/entities/AuthenticationCATemplates/mockdatafiles/createAuthenticationCATemplate-default.json +33 -0
  14. package/entities/AuthenticationCATemplates/mockdatafiles/getAuthenticationCATemplate-default.json +33 -0
  15. package/entities/AuthenticationCATemplates/mockdatafiles/updateAuthenticationCATemplate-default.json +33 -0
  16. package/entities/AuthenticationCATemplates/schema.json +137 -0
  17. package/entities/AuthenticationCertificates/action.json +166 -0
  18. package/entities/AuthenticationCertificates/mockdatafiles/addAuthenticationCertificate-default.json +48 -0
  19. package/entities/AuthenticationCertificates/mockdatafiles/getAuthenticationCertificateDetails-default.json +49 -0
  20. package/entities/AuthenticationCertificates/mockdatafiles/listAuthenticationCertificates-default.json +93 -0
  21. package/entities/AuthenticationCertificates/mockdatafiles/updateAuthenticationCertificate-default.json +48 -0
  22. package/entities/AuthenticationCertificates/schema.json +202 -0
  23. package/entities/BatchCertificateEnrollment/action.json +268 -0
  24. package/entities/BatchCertificateEnrollment/mockdatafiles/batchCSREnroll-default.json +22 -0
  25. package/entities/BatchCertificateEnrollment/mockdatafiles/batchEnrollWithKeyGen-default.json +22 -0
  26. package/entities/BatchCertificateEnrollment/mockdatafiles/batchEnrollWithKeyGenMac-default.json +22 -0
  27. package/entities/BatchCertificateEnrollment/mockdatafiles/downloadCertificates-default.json +18 -0
  28. package/entities/BatchCertificateEnrollment/mockdatafiles/getBatchJobSettings-default.json +22 -0
  29. package/entities/BatchCertificateEnrollment/mockdatafiles/regenerateBatchJobPasscode-default.json +22 -0
  30. package/entities/BatchCertificateEnrollment/mockdatafiles/updateBatchJobSettings-default.json +22 -0
  31. package/entities/BatchCertificateEnrollment/schema.json +284 -0
  32. package/entities/CertificateProfiles/action.json +206 -0
  33. package/entities/CertificateProfiles/mockdatafiles/listCertificateProfiles-default.json +219 -0
  34. package/entities/CertificateProfiles/schema.json +116 -0
  35. package/entities/CertificateRequests/action.json +25 -0
  36. package/entities/CertificateRequests/mockdatafiles/getRequestStatus-default.json +5 -0
  37. package/entities/CertificateRequests/schema.json +30 -0
  38. package/entities/CertificateTemplates/action.json +186 -0
  39. package/entities/CertificateTemplates/schema.json +104 -0
  40. package/entities/Certificates/action.json +312 -0
  41. package/entities/Certificates/mockdatafiles/downloadApprovedCertificate-default.json +47 -0
  42. package/entities/Certificates/mockdatafiles/renewBySerial-default.json +23 -0
  43. package/entities/Certificates/mockdatafiles/renewCertificate-default.json +31 -0
  44. package/entities/Certificates/schema.json +462 -0
  45. package/entities/DeviceProfiles/action.json +126 -0
  46. package/entities/DeviceProfiles/mockdatafiles/createDeviceProfile-default.json +28 -0
  47. package/entities/DeviceProfiles/mockdatafiles/getDeviceProfile-default.json +28 -0
  48. package/entities/DeviceProfiles/mockdatafiles/listdeviceprofiles-default.json +53 -0
  49. package/entities/DeviceProfiles/mockdatafiles/updateDeviceProfile-default.json +28 -0
  50. package/entities/DeviceProfiles/schema.json +57 -0
  51. package/entities/Devices/action.json +166 -0
  52. package/entities/Devices/mockdatafiles/archiveDevice-default.json +33 -0
  53. package/entities/Devices/mockdatafiles/disableDevice-default.json +33 -0
  54. package/entities/Devices/mockdatafiles/enableDevice-default.json +33 -0
  55. package/entities/Devices/mockdatafiles/restoreDevice-default.json +33 -0
  56. package/entities/Devices/schema.json +103 -0
  57. package/entities/DevicesV2/action.json +186 -0
  58. package/entities/DevicesV2/mockdatafiles/archiveDeviceV2-default.json +33 -0
  59. package/entities/DevicesV2/mockdatafiles/disableDeviceV2-default.json +33 -0
  60. package/entities/DevicesV2/mockdatafiles/enableDeviceV2-default.json +33 -0
  61. package/entities/DevicesV2/mockdatafiles/restoreDeviceV2-default.json +33 -0
  62. package/entities/DevicesV2/schema.json +115 -0
  63. package/entities/Divisions/action.json +288 -0
  64. package/entities/Divisions/schema.json +164 -0
  65. package/entities/EnrollmentProfilePasscodes/action.json +186 -0
  66. package/entities/EnrollmentProfilePasscodes/schema.json +181 -0
  67. package/entities/EnrollmentProfiles/action.json +191 -0
  68. package/entities/EnrollmentProfiles/mockdatafiles/getEnrollmentProfile-default.json +153 -0
  69. package/entities/EnrollmentProfiles/mockdatafiles/getEnrollmentProfileSpecification-default.json +125 -0
  70. package/entities/EnrollmentProfiles/mockdatafiles/updateEnrollmentProfile-default.json +117 -0
  71. package/entities/EnrollmentProfiles/schema.json +148 -0
  72. package/entities/ExternalBatchCertificateEnrollment/action.json +150 -0
  73. package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/batchEnrollExternal-default.json +16 -0
  74. package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/downloadByCertificateValue-default.json +154 -0
  75. package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/downloadByCommonName-default.json +150 -0
  76. package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/downloadByJobIdAndCertificateValue-default.json +36 -0
  77. package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/downloadByJobIdAndCommonName-default.json +130 -0
  78. package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/downloadByJobIdAndUniqueId-default.json +42 -0
  79. package/entities/ExternalBatchCertificateEnrollment/schema.json +102 -0
  80. package/entities/Gateways/action.json +187 -0
  81. package/entities/Gateways/schema.json +126 -0
  82. package/entities/ICAs/action.json +46 -0
  83. package/entities/ICAs/schema.json +163 -0
  84. package/entities/OCSPGroups/action.json +167 -0
  85. package/entities/OCSPGroups/schema.json +466 -0
  86. package/package.json +1 -1
  87. package/pronghorn.json +22589 -32
  88. package/refs?service=git-upload-pack +0 -0
  89. package/report/adapterInfo.json +7 -7
  90. package/sampleProperties.json +3 -3
  91. package/test/integration/adapterTestIntegration.js +4544 -0
  92. package/test/unit/adapterTestUnit.js +4866 -0
package/CALLS.md CHANGED
@@ -352,5 +352,1250 @@ Specific adapter calls are built based on the API of the Digicert. The Adapter B
352
352
  <td style="padding:15px">{base_path}/{version}/api/v1/seat/{pathv1}?{query}</td>
353
353
  <td style="padding:15px">Yes</td>
354
354
  </tr>
355
+ <tr>
356
+ <td style="padding:15px">listCertificates(accountId, divisionId, status, serialNumber, commonName, certificateValue, deviceIdentifier, enrollmentMethod, createdFrom, createdTo, validToStart, validToEnd, issuerCommonName, issuerSerialNumber, keyType, enrollmentProfileId, revokedFrom, revokedTo, ocspGroup, includedInOcspGroup, deviceId, certificateType, createdInLastNDays, createdInCurrentMonth, createdInPreviousMonth, expiringInNextNDays, expiringInRemainingOfCurrentMonth, expiringInNextMonth, keyUsage, extendedKeyUsage, certificatePolicies, authenticationId, authenticationType, authenticationName, caConnectorType, renewed, sortBy, sortDirection, limit, offset, callback)</td>
357
+ <td style="padding:15px">Use this endpoint to get a list of end-entity certificates in DigiCert® IoT Trust Manager.
358
+
359
+ **Note:** To prevent performance issues, when you call this API endpoint, DigiCert® IoT Trust Manager never calculates the total number of records for pagination. This means:
360
+
361
+ - The `pagination` response parameter always returns false.
362
+ - The `total` response parameter always returns `0`.
363
+
364
+ To check if there is another page of records, use the `next` response parameter. If `next` is true, there is at least ...(description truncated)</td>
365
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate?{query}</td>
366
+ <td style="padding:15px">Yes</td>
367
+ </tr>
368
+ <tr>
369
+ <td style="padding:15px">getExampleCertificateRequestCertificateID(certificateId, callback)</td>
370
+ <td style="padding:15px">Use this endpoint to get an example of the JSON request body that was used to request the given certificate.
371
+
372
+ The enrollment profile that issued the certificate must use an enrollment method of API or PORTAL.
373
+ </td>
374
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/example-request?{query}</td>
375
+ <td style="padding:15px">Yes</td>
376
+ </tr>
377
+ <tr>
378
+ <td style="padding:15px">renewCertificate(certificateId, body, callback)</td>
379
+ <td style="padding:15px">Use this endpoint to renew the certificate with the given ID within the renewal window.
380
+
381
+ ## Server-side keypair generation
382
+
383
+ If you do not have a certificate signing request (CSR), DigiCert® IoT Trust Manager can generate the private key for you. To learn more, see [Request a certificate with server-side keypair generation](https://dev.digicert.com/en/digicert-one-apis/iot-device-manager-api/request-certificate-with-server-side-keypair-generation.html).
384
+
385
+ ## Authentication
386
+
387
+ In addition to header-b...(description truncated)</td>
388
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/renew?{query}</td>
389
+ <td style="padding:15px">Yes</td>
390
+ </tr>
391
+ <tr>
392
+ <td style="padding:15px">renewBySerial(certificateSerialNumber, body, callback)</td>
393
+ <td style="padding:15px">Use this endpoint to renew the certificate with the given serial number within the renewal window.
394
+
395
+ ## Server-side keypair generation
396
+
397
+ If you do not have a certificate signing request (CSR), DigiCert® IoT Trust Manager can generate the private key for you. To learn more, see [Request a certificate with server-side keypair generation](https://dev.digicert.com/en/digicert-one-apis/iot-device-manager-api/request-certificate-with-server-side-keypair-generation.html).
398
+
399
+ ## Authentication
400
+
401
+ In addition ...(description truncated)</td>
402
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/serial-number/{pathv1}/renew?{query}</td>
403
+ <td style="padding:15px">Yes</td>
404
+ </tr>
405
+ <tr>
406
+ <td style="padding:15px">revokeCertificate(certificateId, body, callback)</td>
407
+ <td style="padding:15px">Use this endpoint to revoke a certificate with the given certificate ID.</td>
408
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/revoke?{query}</td>
409
+ <td style="padding:15px">Yes</td>
410
+ </tr>
411
+ <tr>
412
+ <td style="padding:15px">updateNote(certificateId, body, callback)</td>
413
+ <td style="padding:15px">Use this endpoint to update the note for a certificate.</td>
414
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/note?{query}</td>
415
+ <td style="padding:15px">Yes</td>
416
+ </tr>
417
+ <tr>
418
+ <td style="padding:15px">revokeCertificateBySerialNumber(certificateSerialNumber, body, callback)</td>
419
+ <td style="padding:15px">Use this endpoint to revoke a certificate with the given serial number.</td>
420
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/serial-number/{pathv1}/revoke?{query}</td>
421
+ <td style="padding:15px">Yes</td>
422
+ </tr>
423
+ <tr>
424
+ <td style="padding:15px">downloadCertificate(certificateId, format, callback)</td>
425
+ <td style="padding:15px">Use this endpoint to download a certificate with the given certificate ID.
426
+ </td>
427
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/download/{pathv2}?{query}</td>
428
+ <td style="padding:15px">Yes</td>
429
+ </tr>
430
+ <tr>
431
+ <td style="padding:15px">downloadCertificateBySerialNumber(certificateSerialNumber, format, callback)</td>
432
+ <td style="padding:15px">Use this endpoint to download a certificate with the given serial number.</td>
433
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/serial-number/{pathv1}/download/{pathv2}?{query}</td>
434
+ <td style="padding:15px">Yes</td>
435
+ </tr>
436
+ <tr>
437
+ <td style="padding:15px">importCertificate(enrollmentProfileId, file, callback)</td>
438
+ <td style="padding:15px">Use this endpoint to import one or more certificates for an enrollment profile that uses the **Certificate Import** enrollment method.
439
+
440
+ Before you import certificates, you must set up source fields mapping in the enrollment profile. Then, when you import certificates, the files with your certificate data must use the same file type extension (.pem or .xml) as the file that you used to set up source fields mapping.
441
+
442
+ The request uses a content type of multipart/form-data. The body of the request i...(description truncated)</td>
443
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-import/{pathv1}?{query}</td>
444
+ <td style="padding:15px">Yes</td>
445
+ </tr>
446
+ <tr>
447
+ <td style="padding:15px">getImportDetails(jobId, callback)</td>
448
+ <td style="padding:15px">Use this endpoint to get information about a certificate import job.</td>
449
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-import/job/{pathv1}?{query}</td>
450
+ <td style="padding:15px">Yes</td>
451
+ </tr>
452
+ <tr>
453
+ <td style="padding:15px">getCertificateStatus(certificateSerialNumber, callback)</td>
454
+ <td style="padding:15px">Use this endpoint to get the status of a certificate using the certificate's serial number.</td>
455
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-status/{pathv1}?{query}</td>
456
+ <td style="padding:15px">Yes</td>
457
+ </tr>
458
+ <tr>
459
+ <td style="padding:15px">getCertificateStatusById(certificateId, callback)</td>
460
+ <td style="padding:15px">Use this endpoint to get the status of a certificate using the certificate's ID.</td>
461
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-status/certificate-id/{pathv1}?{query}</td>
462
+ <td style="padding:15px">Yes</td>
463
+ </tr>
464
+ <tr>
465
+ <td style="padding:15px">listCertificatesByCertificateValue(certificateValue, limit, offset, callback)</td>
466
+ <td style="padding:15px">Use this endpoint to get a list of certificates with the same certificate value you provide in the request URL.
467
+ </td>
468
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/certificate-value/{pathv1}?{query}</td>
469
+ <td style="padding:15px">Yes</td>
470
+ </tr>
471
+ <tr>
472
+ <td style="padding:15px">downloadApprovedCertificate(certificateId, body, callback)</td>
473
+ <td style="padding:15px">Use this endpoint to download the certificate for an approved enrollment or renewal request.
474
+
475
+ To authenticate to this endpoint, clients should use the same API key, passcode, or authentication certificate used to submit the enrollment or renewal request.
476
+
477
+ ## Response format
478
+ This endpoint returns your certificate data in the format you describe in the JSON request body. All request parameters are optional. Submitting an empty JSON object in your request returns a JSON object with the PEM-encoded...(description truncated)</td>
479
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/download-approved-certificate?{query}</td>
480
+ <td style="padding:15px">Yes</td>
481
+ </tr>
482
+ <tr>
483
+ <td style="padding:15px">listAuthenticationCACertificates(accountId, name, enrollmentProfileId, enrollmentProfileName, createdFrom, createdTo, validFromStart, validFromEnd, validToStart, validToEnd, status, sortBy, sortDirection, limit, offset, callback)</td>
484
+ <td style="padding:15px">Use this endpoint to get a list of authentication CA certificates.
485
+ </td>
486
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-ca?{query}</td>
487
+ <td style="padding:15px">Yes</td>
488
+ </tr>
489
+ <tr>
490
+ <td style="padding:15px">listAuthenticationCACertificatesByAccount(accountId, name, enrollmentProfileId, enrollmentProfileName, createdFrom, createdTo, validFromStart, validFromEnd, validToStart, validToEnd, status, sortBy, sortDirection, limit, offset, callback)</td>
491
+ <td style="padding:15px">Use this endpoint to get a list of authentication CA certificates for the given account.
492
+
493
+ This endpoint is deprecated. Use [List authentication CA certificates](#/Authentication%20CA%20certificates/listAuthenticationCACertificates).
494
+ </td>
495
+ <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca?{query}</td>
496
+ <td style="padding:15px">Yes</td>
497
+ </tr>
498
+ <tr>
499
+ <td style="padding:15px">uploadAuthenticationCACertificate(accountId, file, callback)</td>
500
+ <td style="padding:15px">Use this endpoint to upload an authentication CA certificate to your DigiCert® IoT Trust Manager account. The request uses a content type of multipart/form-data. The body of the request is the CA certificate formatted as a PEM file.
501
+ </td>
502
+ <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca?{query}</td>
503
+ <td style="padding:15px">Yes</td>
504
+ </tr>
505
+ <tr>
506
+ <td style="padding:15px">getAuthenticationCACertificate(accountId, authenticationCaId, callback)</td>
507
+ <td style="padding:15px">Use this endpoint to get information about the given authentication CA certificate.
508
+ </td>
509
+ <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca/{pathv2}?{query}</td>
510
+ <td style="padding:15px">Yes</td>
511
+ </tr>
512
+ <tr>
513
+ <td style="padding:15px">deleteAuthenticationCACertificate(accountId, authenticationCaId, callback)</td>
514
+ <td style="padding:15px">Use this endpoint to delete an authentication CA certificate from an account. You cannot use a deleted authentication CA certificate to create new authentication certificates in DigiCert® IoT Trust Manager.
515
+
516
+ Additionally, deleted authentication CA certificates do not appear in search results on the **List authentication CA certificates** endpoint with the default `status` filter. To search for deleted authentication CA certificates, use the query parameter `status=DELETED`.
517
+ </td>
518
+ <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca/{pathv2}/delete?{query}</td>
519
+ <td style="padding:15px">Yes</td>
520
+ </tr>
521
+ <tr>
522
+ <td style="padding:15px">createAuthenticationCATemplate(body, callback)</td>
523
+ <td style="padding:15px">Use this endpoint to create an authentication CA template for an enrollment profile. Authentication CA templates define requirements for certificates that can be used as authentication credentials in the enrollment profile.
524
+
525
+ ## Request format
526
+
527
+ * **Choose an authentication CA certificate**
528
+ When you create an authentication CA template, you choose an authentication CA certificate to validate which of its issued certificates can be used as authentication credentials. You can use an existing authe...(description truncated)</td>
529
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template?{query}</td>
530
+ <td style="padding:15px">Yes</td>
531
+ </tr>
532
+ <tr>
533
+ <td style="padding:15px">listAuthenticationCATemplate(name, accountId, divisionId, enrollmentProfileId, icaId, status, useForAllCertificates, createdAtFrom, createdAtTo, sortBy, sortDirection, limit, offset, callback)</td>
534
+ <td style="padding:15px">Use this endpoint to get a list of authentication CA templates, or to search for authentication CA templates that meet the given search criteria.
535
+ </td>
536
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template?{query}</td>
537
+ <td style="padding:15px">Yes</td>
538
+ </tr>
539
+ <tr>
540
+ <td style="padding:15px">updateAuthenticationCATemplate(authenticationCaTemplateId, body, callback)</td>
541
+ <td style="padding:15px">Use this endpoint to update an authentication CA template.
542
+ </td>
543
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}?{query}</td>
544
+ <td style="padding:15px">Yes</td>
545
+ </tr>
546
+ <tr>
547
+ <td style="padding:15px">getAuthenticationCATemplate(authenticationCaTemplateId, callback)</td>
548
+ <td style="padding:15px">Use this endpoint to get details about the given authentication CA template.
549
+ </td>
550
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}?{query}</td>
551
+ <td style="padding:15px">Yes</td>
552
+ </tr>
553
+ <tr>
554
+ <td style="padding:15px">disableAuthenticationCATemplate(authenticationCaTemplateId, callback)</td>
555
+ <td style="padding:15px">Use this endpoint to disable an authentication CA template.
556
+
557
+ When a template is disabled:
558
+ * If `can_be_used_for_any_certificate` is true, authentication credentials associated with the template will be rejected during enrollment.
559
+ * If `can_be_used_for_any_certificate` is false, you cannot create new authentication certificates based on the authentication CA template.
560
+ </td>
561
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/disable?{query}</td>
562
+ <td style="padding:15px">Yes</td>
563
+ </tr>
564
+ <tr>
565
+ <td style="padding:15px">deleteAuthenticationCATemplate(authenticationCaTemplateId, callback)</td>
566
+ <td style="padding:15px">Use this endpoint to delete an authentication CA template.
567
+
568
+ When a template is deleted:
569
+ * If `can_be_used_for_any_certificate` is true, authentication credentials associated with the template will be rejected during enrollment.
570
+ * If `can_be_used_for_any_certificate` is false, you cannot create new authentication certificates based on the authentication CA template.
571
+
572
+ Additionally, deleted templates do not appear in search results on the **List authentication CA templates** endpoint with the defau...(description truncated)</td>
573
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/delete?{query}</td>
574
+ <td style="padding:15px">Yes</td>
575
+ </tr>
576
+ <tr>
577
+ <td style="padding:15px">restoreAuthenticationCATemplate(authenticationCaTemplateId, callback)</td>
578
+ <td style="padding:15px">Use this endpoint to restore a deleted authentication CA template.
579
+ </td>
580
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/undelete?{query}</td>
581
+ <td style="padding:15px">Yes</td>
582
+ </tr>
583
+ <tr>
584
+ <td style="padding:15px">enableAuthenticationCATemplate(authenticationCaTemplateId, callback)</td>
585
+ <td style="padding:15px">Use this endpoint to enable a disabled authentication CA template.
586
+ </td>
587
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/enable?{query}</td>
588
+ <td style="padding:15px">Yes</td>
589
+ </tr>
590
+ <tr>
591
+ <td style="padding:15px">listAssignableAuthenticationCACertificates(enrollmentProfileId, name, limit, offset, callback)</td>
592
+ <td style="padding:15px">Use this endpoint to get a list of authentication CA certificates that can be used in authentication CA templates for the given enrollment profile.
593
+ </td>
594
+ <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/assignable-ca/{pathv1}?{query}</td>
595
+ <td style="padding:15px">Yes</td>
596
+ </tr>
597
+ <tr>
598
+ <td style="padding:15px">addAuthenticationCertificate(body, callback)</td>
599
+ <td style="padding:15px">Use this endpoint to add an authentication certificate to an enrollment profile.
600
+
601
+ **Note:** You only need to add authentication certificates to an enrollment profile when the authentication CA template limits the certificates you can use as authentication credentials. Otherwise, you can authenticate to the **Request certificate** and **Renew certificate** endpoints using any certificates issued from the authentication CA defined in the authentication CA template.
602
+
603
+ **Request format: `certificate_...(description truncated)</td>
604
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate?{query}</td>
605
+ <td style="padding:15px">Yes</td>
606
+ </tr>
607
+ <tr>
608
+ <td style="padding:15px">listAuthenticationCertificates(accountId, divisionId, name, authenticationCaCommonName, templateId, authenticationCaId, enrollmentProfileId, enrollmentProfileName, createdFrom, createdTo, usageLimitFrom, usageLimitTo, expiresFrom, expiresTo, status, sortBy, sortDirection, limit, offset, callback)</td>
609
+ <td style="padding:15px">Use this endpoint to get a list of authentication certificates.
610
+ </td>
611
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate?{query}</td>
612
+ <td style="padding:15px">Yes</td>
613
+ </tr>
614
+ <tr>
615
+ <td style="padding:15px">getAuthenticationCertificateDetails(authenticationCertificateId, callback)</td>
616
+ <td style="padding:15px">Use this endpoint to get information about an authentication certificate.</td>
617
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}?{query}</td>
618
+ <td style="padding:15px">Yes</td>
619
+ </tr>
620
+ <tr>
621
+ <td style="padding:15px">updateAuthenticationCertificate(authenticationCertificateId, body, callback)</td>
622
+ <td style="padding:15px">Use this endpoint to update the name, usage restrictions, and registered values for an authentication certificate.
623
+
624
+ **Warning!** This operation is destructive to the `name`, `start_date`, `end_date`, `usage_limit`, and `registered_values` properties. The values in your request overwrite the existing values for these properties. Omitting a property from your request clears any value already set for that property.
625
+ </td>
626
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}?{query}</td>
627
+ <td style="padding:15px">Yes</td>
628
+ </tr>
629
+ <tr>
630
+ <td style="padding:15px">disableAuthenticationCertificate(authenticationCertificateId, callback)</td>
631
+ <td style="padding:15px">Use this endpoint to disable the authentication certificate with the given ID. Disabled authentication certificates cannot be used as valid credentials during enrollment.
632
+ </td>
633
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/disable?{query}</td>
634
+ <td style="padding:15px">Yes</td>
635
+ </tr>
636
+ <tr>
637
+ <td style="padding:15px">enableAuthenticationCertificate(authenticationCertificateId, callback)</td>
638
+ <td style="padding:15px">Use this endpoint to enable the authentication certificate with the given ID.
639
+ </td>
640
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/enable?{query}</td>
641
+ <td style="padding:15px">Yes</td>
642
+ </tr>
643
+ <tr>
644
+ <td style="padding:15px">deleteAuthenticationCertificate(authenticationCertificateId, callback)</td>
645
+ <td style="padding:15px">Use this endpoint to delete the authentication certificate with the given ID. Deleted authentication certificates cannot be used as valid credentials during enrollment.
646
+ </td>
647
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/delete?{query}</td>
648
+ <td style="padding:15px">Yes</td>
649
+ </tr>
650
+ <tr>
651
+ <td style="padding:15px">restoreAuthenticationCertificate(authenticationCertificateId, callback)</td>
652
+ <td style="padding:15px">Use this endpoint to restore the deleted authentication certificate with the given ID.
653
+ </td>
654
+ <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/undelete?{query}</td>
655
+ <td style="padding:15px">Yes</td>
656
+ </tr>
657
+ <tr>
658
+ <td style="padding:15px">listCertificateProfiles(name, accountId, divisionId, templateName, status, createdFrom, createdTo, sortBy, sortDirection, limit, offset, callback)</td>
659
+ <td style="padding:15px">Use this endpoint to get a list of certificate profiles, or to search for profiles that meet the given criteria.
660
+ </td>
661
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile?{query}</td>
662
+ <td style="padding:15px">Yes</td>
663
+ </tr>
664
+ <tr>
665
+ <td style="padding:15px">createCertificateProfile(body, callback)</td>
666
+ <td style="padding:15px">Use this endpoint to create a certificate profile.
667
+ </td>
668
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile?{query}</td>
669
+ <td style="padding:15px">Yes</td>
670
+ </tr>
671
+ <tr>
672
+ <td style="padding:15px">getCertificateProfile(certificateProfileId, callback)</td>
673
+ <td style="padding:15px">Use this endpoint to get a certificate profile.
674
+ </td>
675
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}?{query}</td>
676
+ <td style="padding:15px">Yes</td>
677
+ </tr>
678
+ <tr>
679
+ <td style="padding:15px">updateCertificateProfile(certificateProfileId, body, callback)</td>
680
+ <td style="padding:15px">Use this endpoint to update a certificate profile.
681
+ </td>
682
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}?{query}</td>
683
+ <td style="padding:15px">Yes</td>
684
+ </tr>
685
+ <tr>
686
+ <td style="padding:15px">disableCertificateProfile(certificateProfileId, callback)</td>
687
+ <td style="padding:15px">Use this endpoint to disable a certificate profile. Disabled certificate profiles cannot be used to create new enrollment profiles, but existing enrollment profiles that use a disabled certificate profile will continue to work.
688
+ </td>
689
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/disable?{query}</td>
690
+ <td style="padding:15px">Yes</td>
691
+ </tr>
692
+ <tr>
693
+ <td style="padding:15px">enableCertificateProfile(certificateProfileId, callback)</td>
694
+ <td style="padding:15px">Use this endpoint to enable a disabled certificate profile.
695
+ </td>
696
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/enable?{query}</td>
697
+ <td style="padding:15px">Yes</td>
698
+ </tr>
699
+ <tr>
700
+ <td style="padding:15px">deleteCertificateProfile(certificateProfileId, callback)</td>
701
+ <td style="padding:15px">Use this endpoint to delete a certificate profile. Deleted certificate profiles cannot be used to create new enrollment profiles, but existing enrollment profiles that use a deleted certificate profile will continue to work.
702
+
703
+ Additionally, deleted certificate profiles do not appear in search results on the **List certificate profiles** endpoint with the default `status` filter. To search for deleted certificate profiles, use the query parameter `status=DELETED`.
704
+ </td>
705
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/delete?{query}</td>
706
+ <td style="padding:15px">Yes</td>
707
+ </tr>
708
+ <tr>
709
+ <td style="padding:15px">restoreCertificateProfile(certificateProfileId, callback)</td>
710
+ <td style="padding:15px">Use this endpoint to restore a deleted certificate profile.
711
+ </td>
712
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/undelete?{query}</td>
713
+ <td style="padding:15px">Yes</td>
714
+ </tr>
715
+ <tr>
716
+ <td style="padding:15px">assignCertificateProfileDivisions(certificateProfileId, body, callback)</td>
717
+ <td style="padding:15px">Use this endpoint to assign divisions to a certificate profile. Division IDs are sourced from the [List divisions](#/Divisions/listDivisions) API endpoint.
718
+ </td>
719
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/division/assign?{query}</td>
720
+ <td style="padding:15px">Yes</td>
721
+ </tr>
722
+ <tr>
723
+ <td style="padding:15px">unassignCertificateProfileDivisions(certificateProfileId, body, callback)</td>
724
+ <td style="padding:15px">Use this endpoint to unassign divisions from a certificate profile. Division IDs are sourced from the [List divisions](#/Divisions/listDivisions) API endpoint.
725
+ </td>
726
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/division/unassign?{query}</td>
727
+ <td style="padding:15px">Yes</td>
728
+ </tr>
729
+ <tr>
730
+ <td style="padding:15px">getRequestStatus(certificateRequestId, callback)</td>
731
+ <td style="padding:15px">Use this endpoint to get the status of the certificate request with the given ID.
732
+
733
+ To authenticate to this endpoint, clients should use the same API key, passcode, or authentication certificate used to submit the enrollment or renewal request.
734
+ </td>
735
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-request/{pathv1}/status?{query}</td>
736
+ <td style="padding:15px">Yes</td>
737
+ </tr>
738
+ <tr>
739
+ <td style="padding:15px">listCertificateTemplates(accountId, name, createdFrom, createdTo, status, type, limitByAccount, format, sortBy, sortDirection, limit, offset, callback)</td>
740
+ <td style="padding:15px">Use this endpoint to get a list of certificate templates, or to search for certificate templates that meet the given criteria.
741
+ </td>
742
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template?{query}</td>
743
+ <td style="padding:15px">Yes</td>
744
+ </tr>
745
+ <tr>
746
+ <td style="padding:15px">createCertificateTemplate(body, callback)</td>
747
+ <td style="padding:15px">Use this endpoint to create a new end-entity or intermediate CA certificate template.
748
+ </td>
749
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template?{query}</td>
750
+ <td style="padding:15px">Yes</td>
751
+ </tr>
752
+ <tr>
753
+ <td style="padding:15px">getCertificateTemplate(certificateTemplateId, callback)</td>
754
+ <td style="padding:15px">Use this endpoint to get information about a certificate template with the given ID.
755
+ </td>
756
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}?{query}</td>
757
+ <td style="padding:15px">Yes</td>
758
+ </tr>
759
+ <tr>
760
+ <td style="padding:15px">updateCertificateTemplate(certificateTemplateId, body, callback)</td>
761
+ <td style="padding:15px">Use this endpoint to update a certificate template.
762
+ </td>
763
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}?{query}</td>
764
+ <td style="padding:15px">Yes</td>
765
+ </tr>
766
+ <tr>
767
+ <td style="padding:15px">clonecertificatetemplate(certificateTemplateId, body, callback)</td>
768
+ <td style="padding:15px">Use this endpoint to clone an existing certificate template.
769
+ </td>
770
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/clone?{query}</td>
771
+ <td style="padding:15px">Yes</td>
772
+ </tr>
773
+ <tr>
774
+ <td style="padding:15px">disableCertificateTemplate(certificateTemplateId, callback)</td>
775
+ <td style="padding:15px">Use this endpoint to disable a certificate template. Disabled templates cannot be used to create new certificate profiles, but existing certificate profiles that use a disabled template will continue to work.
776
+ </td>
777
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/disable?{query}</td>
778
+ <td style="padding:15px">Yes</td>
779
+ </tr>
780
+ <tr>
781
+ <td style="padding:15px">enableCertificateTemplate(certificateTemplateId, callback)</td>
782
+ <td style="padding:15px">Use this endpoint to enable a certificate template.
783
+ </td>
784
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/enable?{query}</td>
785
+ <td style="padding:15px">Yes</td>
786
+ </tr>
787
+ <tr>
788
+ <td style="padding:15px">deleteCertificateTemplate(certificateTemplateId, callback)</td>
789
+ <td style="padding:15px">Use this endpoint to delete a certificate template. Deleted templates cannot be used to create new certificate profiles, but existing profiles that use a deleted template still work.
790
+
791
+ Additionally, deleted templates do not appear in search results on the **List certificate templates** endpoint with the default `status` filter. To search for deleted templates, use the query parameter `status=DELETED`.
792
+ </td>
793
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/delete?{query}</td>
794
+ <td style="padding:15px">Yes</td>
795
+ </tr>
796
+ <tr>
797
+ <td style="padding:15px">restoreCertificateTemplate(certificateTemplateId, callback)</td>
798
+ <td style="padding:15px">Use this endpoint to restore a deleted certificate template.
799
+ </td>
800
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/undelete?{query}</td>
801
+ <td style="padding:15px">Yes</td>
802
+ </tr>
803
+ <tr>
804
+ <td style="padding:15px">createDevice(body, callback)</td>
805
+ <td style="padding:15px">Use this endpoint to add a device to manage. The request body includes the device profile that the new device configuration must follow. It also includes any fields the device profile requires.</td>
806
+ <td style="padding:15px">{base_path}/{version}/api/v1/device?{query}</td>
807
+ <td style="padding:15px">Yes</td>
808
+ </tr>
809
+ <tr>
810
+ <td style="padding:15px">getDeviceList(deviceIdentifier, createdFrom, createdTo, divisionId, updatedFrom, updatedTo, deviceProfileId, pagination, limit, offset, callback)</td>
811
+ <td style="padding:15px">Use this endpoint to get a list of records with information about your devices.</td>
812
+ <td style="padding:15px">{base_path}/{version}/api/v1/device?{query}</td>
813
+ <td style="padding:15px">Yes</td>
814
+ </tr>
815
+ <tr>
816
+ <td style="padding:15px">getDeviceDetails(deviceIdentifier, divisionId, callback)</td>
817
+ <td style="padding:15px">Use this endpoint to get device details, including status and attributes.</td>
818
+ <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}?{query}</td>
819
+ <td style="padding:15px">Yes</td>
820
+ </tr>
821
+ <tr>
822
+ <td style="padding:15px">updateDevice(deviceIdentifier, divisionId, body, callback)</td>
823
+ <td style="padding:15px">Updates field values for an existing device. Optionally, updates the device name (or `device_identifier`). Device ID cannot be changed.
824
+
825
+ **Note:** This operation is destructive to the `fields` array. The field values in your request overwrite existing field values for the device. Omitting field values from the request causes existing values to be deleted.
826
+ </td>
827
+ <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}?{query}</td>
828
+ <td style="padding:15px">Yes</td>
829
+ </tr>
830
+ <tr>
831
+ <td style="padding:15px">archiveDevice(deviceIdentifier, divisionId, callback)</td>
832
+ <td style="padding:15px">Use this endpoint to remove a device from certificate management and reporting when the device is no longer in service. The device record is not deleted entirely and can be restored.</td>
833
+ <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}?{query}</td>
834
+ <td style="padding:15px">Yes</td>
835
+ </tr>
836
+ <tr>
837
+ <td style="padding:15px">enableDevice(deviceIdentifier, divisionId, callback)</td>
838
+ <td style="padding:15px">Use this endpoint to enable a disabled device.</td>
839
+ <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}/enable?{query}</td>
840
+ <td style="padding:15px">Yes</td>
841
+ </tr>
842
+ <tr>
843
+ <td style="padding:15px">disableDevice(deviceIdentifier, divisionId, callback)</td>
844
+ <td style="padding:15px">Use this endpoint to disable an enabled device.</td>
845
+ <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}/disable?{query}</td>
846
+ <td style="padding:15px">Yes</td>
847
+ </tr>
848
+ <tr>
849
+ <td style="padding:15px">restoreDevice(deviceIdentifier, divisionId, callback)</td>
850
+ <td style="padding:15px">Use this endpoint to restore an archived device.</td>
851
+ <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}/undelete?{query}</td>
852
+ <td style="padding:15px">Yes</td>
853
+ </tr>
854
+ <tr>
855
+ <td style="padding:15px">createDeviceV2(body, callback)</td>
856
+ <td style="padding:15px">Use this endpoint to add a device to manage. The request body includes the device profile that the new device configuration must follow. It also includes any fields the device profile requires.</td>
857
+ <td style="padding:15px">{base_path}/{version}/api/v2/device?{query}</td>
858
+ <td style="padding:15px">Yes</td>
859
+ </tr>
860
+ <tr>
861
+ <td style="padding:15px">getDeviceListV2(deviceIdentifier, createdFrom, createdTo, divisionId, updatedFrom, updatedTo, deviceProfileId, pagination, limit, offset, callback)</td>
862
+ <td style="padding:15px">Use this endpoint to get a list of records with information about your devices.</td>
863
+ <td style="padding:15px">{base_path}/{version}/api/v2/device?{query}</td>
864
+ <td style="padding:15px">Yes</td>
865
+ </tr>
866
+ <tr>
867
+ <td style="padding:15px">getDeviceDetailsV2(deviceId, callback)</td>
868
+ <td style="padding:15px">Use this endpoint to get device details, including status and attributes.
869
+
870
+ **Using TLS authentication**
871
+
872
+ This endpoint supports mutual TLS authentication. This means a client can access the endpoint by presenting a trusted certificate in the request instead of using an API key.
873
+
874
+ To use TLS authentication instead of an API key, you must prefix the server hostname in the base URL with `clientauth`. For example, instead of `https://one.digicert.com`, use `https://clientauth.one.digicert.com`.
875
+
876
+ Use ...(description truncated)</td>
877
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}?{query}</td>
878
+ <td style="padding:15px">Yes</td>
879
+ </tr>
880
+ <tr>
881
+ <td style="padding:15px">updateDeviceV2(deviceId, body, callback)</td>
882
+ <td style="padding:15px">Updates field values for an existing device. Optionally, updates the device name (or `device_identifier`). Device ID cannot be changed.
883
+
884
+ **Note:** This operation is destructive to the `fields` array. The field values in your request overwrite existing field values for the device. Omitting field values from the request causes existing values to be deleted.
885
+
886
+ **Using TLS authentication**
887
+
888
+ This endpoint supports mutual TLS authentication. This means a client can access the endpoint by presenting a t...(description truncated)</td>
889
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}?{query}</td>
890
+ <td style="padding:15px">Yes</td>
891
+ </tr>
892
+ <tr>
893
+ <td style="padding:15px">archiveDeviceV2(deviceId, callback)</td>
894
+ <td style="padding:15px">Use this endpoint to remove a device from certificate management and reporting when the device is no longer in service. The device record is not deleted entirely and can be restored.</td>
895
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}?{query}</td>
896
+ <td style="padding:15px">Yes</td>
897
+ </tr>
898
+ <tr>
899
+ <td style="padding:15px">enableDeviceV2(deviceId, callback)</td>
900
+ <td style="padding:15px">Use this endpoint to enable a disabled device.</td>
901
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/enable?{query}</td>
902
+ <td style="padding:15px">Yes</td>
903
+ </tr>
904
+ <tr>
905
+ <td style="padding:15px">disableDeviceV2(deviceId, callback)</td>
906
+ <td style="padding:15px">Use this endpoint to disable an enabled device.</td>
907
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/disable?{query}</td>
908
+ <td style="padding:15px">Yes</td>
909
+ </tr>
910
+ <tr>
911
+ <td style="padding:15px">restoreDeviceV2(deviceId, callback)</td>
912
+ <td style="padding:15px">Use this endpoint to restore an archived device.</td>
913
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/undelete?{query}</td>
914
+ <td style="padding:15px">Yes</td>
915
+ </tr>
916
+ <tr>
917
+ <td style="padding:15px">renewDeviceCertificateV2(deviceId, body, callback)</td>
918
+ <td style="padding:15px">Use this endpoint to renew an existing certificate for a device.
919
+
920
+ **Using TLS authentication**
921
+
922
+ You can only access this endpoint by using mutual TLS authentication. Mutual TLS authentication allows a client to access the endpoint by presenting a trusted certificate in the request instead of using an API key.
923
+
924
+ To use TLS authentication, you must prefix the server hostname in the base URL with `clientauth`. For example, instead of `https://one.digicert.com`, use `https://clientauth.one.digicert.c...(description truncated)</td>
925
+ <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/renew?{query}</td>
926
+ <td style="padding:15px">Yes</td>
927
+ </tr>
928
+ <tr>
929
+ <td style="padding:15px">listDivisions(name, accountId, status, sortBy, sortDirection, limit, offset, callback)</td>
930
+ <td style="padding:15px">Use this endpoint to get a list of divisions, or to search for divisions that meet the given search criteria.
931
+ </td>
932
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/?{query}</td>
933
+ <td style="padding:15px">Yes</td>
934
+ </tr>
935
+ <tr>
936
+ <td style="padding:15px">createDivision(body, callback)</td>
937
+ <td style="padding:15px">Use this endpoint to create a new division.
938
+ </td>
939
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/?{query}</td>
940
+ <td style="padding:15px">Yes</td>
941
+ </tr>
942
+ <tr>
943
+ <td style="padding:15px">getDivision(divisionId, callback)</td>
944
+ <td style="padding:15px">Use this endpoint to get information about the given division.
945
+ </td>
946
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}?{query}</td>
947
+ <td style="padding:15px">Yes</td>
948
+ </tr>
949
+ <tr>
950
+ <td style="padding:15px">updateDivision(divisionId, body, callback)</td>
951
+ <td style="padding:15px">Use this endpoint to update the name or description of an existing division.
952
+ </td>
953
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}?{query}</td>
954
+ <td style="padding:15px">Yes</td>
955
+ </tr>
956
+ <tr>
957
+ <td style="padding:15px">disableDivision(divisionId, callback)</td>
958
+ <td style="padding:15px">Use this endpoint to disable a division.
959
+ </td>
960
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/disable?{query}</td>
961
+ <td style="padding:15px">Yes</td>
962
+ </tr>
963
+ <tr>
964
+ <td style="padding:15px">enableDivision(divisionId, callback)</td>
965
+ <td style="padding:15px">Use this endpoint to enable a disabled a division.
966
+ </td>
967
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/enable?{query}</td>
968
+ <td style="padding:15px">Yes</td>
969
+ </tr>
970
+ <tr>
971
+ <td style="padding:15px">deleteDivision(divisionId, callback)</td>
972
+ <td style="padding:15px">Use this endpoint to delete a division. Deleted divisions do not appear in search results on the **List divisions** endpoint with the default `status` filter. To search for deleted divisions, use the query parameter `status=DELETED`.
973
+ </td>
974
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/delete?{query}</td>
975
+ <td style="padding:15px">Yes</td>
976
+ </tr>
977
+ <tr>
978
+ <td style="padding:15px">restoreDivision(divisionId, callback)</td>
979
+ <td style="padding:15px">Use this endpoint to restore a deleted division.
980
+ </td>
981
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/undelete?{query}</td>
982
+ <td style="padding:15px">Yes</td>
983
+ </tr>
984
+ <tr>
985
+ <td style="padding:15px">assignDivisionUsers(divisionId, body, callback)</td>
986
+ <td style="padding:15px">Use this endpoint to assign users to a division. User IDs are sourced from DigiCert® Account Manager.
987
+ </td>
988
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/users/assign?{query}</td>
989
+ <td style="padding:15px">Yes</td>
990
+ </tr>
991
+ <tr>
992
+ <td style="padding:15px">listDivisionUsers(divisionId, limit, offset, callback)</td>
993
+ <td style="padding:15px">Use this endpoint to get a list of users assigned to the given division.
994
+ </td>
995
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/users?{query}</td>
996
+ <td style="padding:15px">Yes</td>
997
+ </tr>
998
+ <tr>
999
+ <td style="padding:15px">removeDivisionUsers(divisionId, body, callback)</td>
1000
+ <td style="padding:15px">Use this endpoint to remove users from a division.
1001
+ </td>
1002
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/users/remove?{query}</td>
1003
+ <td style="padding:15px">Yes</td>
1004
+ </tr>
1005
+ <tr>
1006
+ <td style="padding:15px">assignICAstodivision(divisionId, body, callback)</td>
1007
+ <td style="padding:15px">Use this endpoint to assign ICAs to a division. ICA IDs are sourced from DigiCert® CA Manager.
1008
+ </td>
1009
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/ica/assign?{query}</td>
1010
+ <td style="padding:15px">Yes</td>
1011
+ </tr>
1012
+ <tr>
1013
+ <td style="padding:15px">removeICAsfromdivision(divisionId, body, callback)</td>
1014
+ <td style="padding:15px">Use this endpoint to remove ICAs from a division.
1015
+ </td>
1016
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/ica/remove?{query}</td>
1017
+ <td style="padding:15px">Yes</td>
1018
+ </tr>
1019
+ <tr>
1020
+ <td style="padding:15px">listdivisionICAassignments(divisionId, commonName, issuerCommonName, serialNumber, status, enrollmentProfileId, validFromFrom, validFromTo, validToFrom, validToTo, sortBy, sortDirection, limit, offset, callback)</td>
1021
+ <td style="padding:15px">Use this endpoint to get a list of ICAs assigned to the given division.
1022
+ </td>
1023
+ <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/ica?{query}</td>
1024
+ <td style="padding:15px">Yes</td>
1025
+ </tr>
1026
+ <tr>
1027
+ <td style="padding:15px">listEnrollmentProfiles(name, deviceProfileId, deviceProfileName, enrollmentMethods, ipAddresses, createdFrom, createdTo, certificateType, status, sortBy, sortDirection, limit, offset, callback)</td>
1028
+ <td style="padding:15px">Use this endpoint to get a list of records with information about the enrollment profiles in your DigiCert® IoT Trust Manager account.
1029
+ </td>
1030
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile?{query}</td>
1031
+ <td style="padding:15px">Yes</td>
1032
+ </tr>
1033
+ <tr>
1034
+ <td style="padding:15px">createEnrollmentProfile(body, callback)</td>
1035
+ <td style="padding:15px">Use this endpoint to create an enrollment profile.
1036
+
1037
+ To create an enrollment profile, your request must include the following key pieces of information.
1038
+
1039
+ - From **DigiCert® IoT Trust Manager**, you need:
1040
+ - The ID of the certificate profile the enrollment profile will use.
1041
+ - The ID of the device profile the enrollment profile will use.
1042
+ - From **DigiCert® CA Manager**, you need:
1043
+ - The ID of the ICA that will issue certificates requested using the enrollment profile.
1044
+ </td>
1045
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile?{query}</td>
1046
+ <td style="padding:15px">Yes</td>
1047
+ </tr>
1048
+ <tr>
1049
+ <td style="padding:15px">getExampleCertificateRequestEnrollmentProfileID(enrollmentProfileId, callback)</td>
1050
+ <td style="padding:15px">Use this endpoint to get an example of the JSON request body for requesting certificates using the given enrollment profile.
1051
+
1052
+ The enrollment profile must use an enrollment method of API or PORTAL.
1053
+ </td>
1054
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/example-request?{query}</td>
1055
+ <td style="padding:15px">Yes</td>
1056
+ </tr>
1057
+ <tr>
1058
+ <td style="padding:15px">getEnrollmentProfile(enrollmentProfileId, callback)</td>
1059
+ <td style="padding:15px">Use this endpoint to get details for an enrollment profile.</td>
1060
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}?{query}</td>
1061
+ <td style="padding:15px">Yes</td>
1062
+ </tr>
1063
+ <tr>
1064
+ <td style="padding:15px">updateEnrollmentProfile(enrollmentProfileId, body, callback)</td>
1065
+ <td style="padding:15px">Use this endpoint to update an enrollment profile.
1066
+ * **To update a single field**, include a value only for the field you want to update.
1067
+ * **To set an empty value for a field**, set the value of the field to `null`.
1068
+ </td>
1069
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}?{query}</td>
1070
+ <td style="padding:15px">Yes</td>
1071
+ </tr>
1072
+ <tr>
1073
+ <td style="padding:15px">listAssignableICAs(enrollmentProfileId, limit, offset, callback)</td>
1074
+ <td style="padding:15px">Use this endpoint to get a list of issuing ICAs you can assign to an enrollment profile.</td>
1075
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/assignable-ca?{query}</td>
1076
+ <td style="padding:15px">Yes</td>
1077
+ </tr>
1078
+ <tr>
1079
+ <td style="padding:15px">getIssuingICA(enrollmentProfileId, includeChain, callback)</td>
1080
+ <td style="padding:15px">Use this endpoint to get the issuing ICA for an enrollment profile.</td>
1081
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/issuer?{query}</td>
1082
+ <td style="padding:15px">Yes</td>
1083
+ </tr>
1084
+ <tr>
1085
+ <td style="padding:15px">getEnrollmentProfileSpecification(enrollmentProfileId, callback)</td>
1086
+ <td style="padding:15px">Use this endpoint to get information about the fields used during enrollment for a specific enrollment profile.
1087
+
1088
+ **Note:** This endpoint is only supported for enrollment profiles that use the API or PORTAL enrollment methods.
1089
+ </td>
1090
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/enrollment-specification?{query}</td>
1091
+ <td style="padding:15px">Yes</td>
1092
+ </tr>
1093
+ <tr>
1094
+ <td style="padding:15px">getEnrollmentProfileStatus(enrollmentProfileId, callback)</td>
1095
+ <td style="padding:15px">Use this endpoint to get the status (`ACTIVE`, `DISABLED`, `DELETED`) of the enrollment profile with the given ID.
1096
+
1097
+ ## Authenticate with enrollment profile credentials
1098
+
1099
+ This endpoint supports the option to authenticate with the enrollment passcode or authentication certificate for the given enrollment profile. This is especially useful for API clients that don't have access to an API token or client authentication certificate from DigiCert@ Account Manager. API clients can use the same credentia...(description truncated)</td>
1100
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/status?{query}</td>
1101
+ <td style="padding:15px">Yes</td>
1102
+ </tr>
1103
+ <tr>
1104
+ <td style="padding:15px">listEnrollmentPasscodes(accountId, divisionId, name, enrollmentProfileId, enrollmentProfileName, deviceProfileId, createdFrom, createdTo, usageLimitFrom, usageLimitTo, expiresFrom, expiresTo, status, username, sortBy, sortDirection, limit, offset, callback)</td>
1105
+ <td style="padding:15px">Use this endpoint to get a list of enrollment profile passcodes.
1106
+ </td>
1107
+ <td style="padding:15px">{base_path}/{version}/api/v1/passcode?{query}</td>
1108
+ <td style="padding:15px">Yes</td>
1109
+ </tr>
1110
+ <tr>
1111
+ <td style="padding:15px">createEnrollmentPasscode(enrollmentProfileId, body, callback)</td>
1112
+ <td style="padding:15px">Use this endpoint to create a unique passcode for authenticating orders associated with an enrollment profile in your account. To create an enrollment passcode, the enrollment profile must use the EST, SCEP, or CMPv2 enrollment method.
1113
+
1114
+ You can create multiple passcodes for a single enrollment profile, each with a different validity period or usage limit. Each passcode must have a unique name within the enrollment profile.
1115
+
1116
+ Enrollment profiles that use the EST or CMPv2 enrollment methods support...(description truncated)</td>
1117
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode?{query}</td>
1118
+ <td style="padding:15px">Yes</td>
1119
+ </tr>
1120
+ <tr>
1121
+ <td style="padding:15px">getEnrollmentPasscodeDetails(enrollmentProfileId, passcodeId, callback)</td>
1122
+ <td style="padding:15px">Use this endpoint to get information about an enrollment passcode with the given ID.</td>
1123
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}?{query}</td>
1124
+ <td style="padding:15px">Yes</td>
1125
+ </tr>
1126
+ <tr>
1127
+ <td style="padding:15px">updateEnrollmentPasscode(enrollmentProfileId, passcodeId, body, callback)</td>
1128
+ <td style="padding:15px">Use this endpoint to update an enrollment passcode.
1129
+
1130
+ **Note**: This operation is destructive. The values in your request overwrite existing values. Omitting a property from the request clears any value already set for that property.
1131
+ </td>
1132
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}?{query}</td>
1133
+ <td style="padding:15px">Yes</td>
1134
+ </tr>
1135
+ <tr>
1136
+ <td style="padding:15px">deleteEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1137
+ <td style="padding:15px">Use this endpoint to set the status of an enrollment profile passcode to `DELETED`. Deleting an enrollment passcode does not permanently remove the passcode record, and `DELETED` passcodes can be restored.
1138
+ </td>
1139
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}?{query}</td>
1140
+ <td style="padding:15px">Yes</td>
1141
+ </tr>
1142
+ <tr>
1143
+ <td style="padding:15px">restoreEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1144
+ <td style="padding:15px">Use this endpoint to restore a deleted enrollment passcode.</td>
1145
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/undelete?{query}</td>
1146
+ <td style="padding:15px">Yes</td>
1147
+ </tr>
1148
+ <tr>
1149
+ <td style="padding:15px">disableEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1150
+ <td style="padding:15px">Use this endpoint to disable an enrollment passcode.</td>
1151
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/disable?{query}</td>
1152
+ <td style="padding:15px">Yes</td>
1153
+ </tr>
1154
+ <tr>
1155
+ <td style="padding:15px">enableEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1156
+ <td style="padding:15px">Use this endpoint to enable an enrollment passcode.</td>
1157
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/enable?{query}</td>
1158
+ <td style="padding:15px">Yes</td>
1159
+ </tr>
1160
+ <tr>
1161
+ <td style="padding:15px">regenerateEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1162
+ <td style="padding:15px">Use this endpoint to regenerate an enrollment passcode.
1163
+
1164
+ **Note:** You can only regenerate passcodes originally generated by DigiCert® IoT Trust Manager (`generation_option` = `AUTO`). To change a user-provided passcode (`generation_option` = `PROVIDED`), use the **Update enrollment passcode** API request and submit a new `passcode` value.
1165
+ </td>
1166
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/regenerate?{query}</td>
1167
+ <td style="padding:15px">Yes</td>
1168
+ </tr>
1169
+ <tr>
1170
+ <td style="padding:15px">createAcmeAuthentication(body, callback)</td>
1171
+ <td style="padding:15px">Use this endpoint to add ACME credentials to your DigiCert® IoT Trust Manager account and assign them to an enrollment profile that supports the ACME enrollment method.
1172
+
1173
+ **Note:** You can use this endpoint to add ACME credentials without assigning them to an enrollment profile. However, you cannot use it to assign ACME credentials that you already added to your account. If you do not assign ACME credentials to an enrollment profile when you add them, you can assign them later by signing in to yo...(description truncated)</td>
1174
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication?{query}</td>
1175
+ <td style="padding:15px">Yes</td>
1176
+ </tr>
1177
+ <tr>
1178
+ <td style="padding:15px">listAcmeAuthentication(accountId, name, createdAtFrom, createdAtTo, type, certificateCommonName, issuerCommonName, status, enrollmentProfileId, sortBy, sortDirection, limit, offset, callback)</td>
1179
+ <td style="padding:15px">Use this endpoint to get a list of ACME authentication credentials. Use query parameters to filter results or search for a specific set of credentials.
1180
+ </td>
1181
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication?{query}</td>
1182
+ <td style="padding:15px">Yes</td>
1183
+ </tr>
1184
+ <tr>
1185
+ <td style="padding:15px">getAcmeAuthentication(acmeAuthenticationId, callback)</td>
1186
+ <td style="padding:15px">Use this endpoint to get information about the ACME authentication credentials with the given ID.
1187
+ </td>
1188
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}?{query}</td>
1189
+ <td style="padding:15px">Yes</td>
1190
+ </tr>
1191
+ <tr>
1192
+ <td style="padding:15px">updateAcmeAuthentication(acmeAuthenticationId, body, callback)</td>
1193
+ <td style="padding:15px">Use this endpoint to change the friendly name of the ACME authentication credentials with the given ID.
1194
+ </td>
1195
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}?{query}</td>
1196
+ <td style="padding:15px">Yes</td>
1197
+ </tr>
1198
+ <tr>
1199
+ <td style="padding:15px">disableAcmeAuthentication(acmeAuthenticationId, callback)</td>
1200
+ <td style="padding:15px">Use this endpoint to disable the ACME authentication credentials with the given ID. Disabled ACME authentication credentials cannot be used.
1201
+ </td>
1202
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/disable?{query}</td>
1203
+ <td style="padding:15px">Yes</td>
1204
+ </tr>
1205
+ <tr>
1206
+ <td style="padding:15px">enableAcmeAuthentication(acmeAuthenticationId, callback)</td>
1207
+ <td style="padding:15px">Use this endpoint to enable the ACME authentication credentials with the given ID.
1208
+ </td>
1209
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/enable?{query}</td>
1210
+ <td style="padding:15px">Yes</td>
1211
+ </tr>
1212
+ <tr>
1213
+ <td style="padding:15px">deleteAcmeAuthentication(acmeAuthenticationId, callback)</td>
1214
+ <td style="padding:15px">Use this endpoint to delete the ACME authentication credentials with the given ID. Deleted ACME authentication credentials cannot be used.
1215
+ </td>
1216
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/delete?{query}</td>
1217
+ <td style="padding:15px">Yes</td>
1218
+ </tr>
1219
+ <tr>
1220
+ <td style="padding:15px">restoreAcmeAuthentication(acmeAuthenticationId, callback)</td>
1221
+ <td style="padding:15px">Use this endpoint to restore the deleted ACME authentication credentials with the given ID.
1222
+ </td>
1223
+ <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/undelete?{query}</td>
1224
+ <td style="padding:15px">Yes</td>
1225
+ </tr>
1226
+ <tr>
1227
+ <td style="padding:15px">batchCSREnroll(enrollmentProfileId, name, certificateFormat, data, emails, description, externalEmails, passcodeGenerationOption, passcode, inputFormat, reportFormat, callback)</td>
1228
+ <td style="padding:15px">Use this endpoint to create a batch certificate enrollment job from one or more certificate signing requests (CSRs). Upload your CSRs using one of these formats:
1229
+ * Compressed ZIP of CSR files for each certificate request.
1230
+ * Compressed ZIP of CSV file with details about each certificate request.
1231
+ **Note:** For client-side keypair generation, CSV files must have a `csr` column with PEM-encoded CSR data for each certificate request. [Learn how to format a CSV file for batch certificate enrollmen...(description truncated)</td>
1232
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll?{query}</td>
1233
+ <td style="padding:15px">Yes</td>
1234
+ </tr>
1235
+ <tr>
1236
+ <td style="padding:15px">batchEnrollWithKeyGen(enrollmentProfileId, name, certificateFormat, privateKeyFormat, privateKeySyntax, reportFormat, data, emails, keyType, certificate, description, externalEmails, passcodeGenerationOption, passcode, callback)</td>
1237
+ <td style="padding:15px">Use this endpoint to create a batch enrollment job from a CSV file with details about each certificate request. When you submit your request, you upload the CSV in a compressed ZIP file. When the job is complete, DigiCert® IoT Trust Manager generates the keypairs and provides download access to an encrypted ZIP file containing the private keys and issued certificates.
1238
+
1239
+ DigiCert® IoT Trust Manager processes batch enrollment jobs asynchronously in the order they are received. When the job is compl...(description truncated)</td>
1240
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll-key-gen?{query}</td>
1241
+ <td style="padding:15px">Yes</td>
1242
+ </tr>
1243
+ <tr>
1244
+ <td style="padding:15px">batchEnrollWithKeyGenMac(enrollmentProfileId, name, certificateFormat, privateKeyFormat, privateKeySyntax, reportFormat, macAddressFrom, macAddressNumber, macAddressStep, emails, keyType, certificate, description, externalEmails, passcodeGenerationOption, passcode, callback)</td>
1245
+ <td style="padding:15px">Use this endpoint to create a batch certificate enrollment job for up to 100,000 MAC addresses. When the job is complete, DigiCert® IoT Trust Manager generates keypairs for each MAC address and provides download access to an encrypted ZIP file containing the private keys and issued certificates.
1246
+
1247
+ DigiCert® IoT Trust Manager processes batch enrollment jobs asynchronously in the order they are received. When the job is complete:
1248
+ 1. [Download the batch enrollment job report](#/Batch%20certificate%2...(description truncated)</td>
1249
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll-key-gen-mac?{query}</td>
1250
+ <td style="padding:15px">Yes</td>
1251
+ </tr>
1252
+ <tr>
1253
+ <td style="padding:15px">listBatchJobs(accountId, divisionId, statuses, name, fileName, enrollmentProfileId, createdAtFrom, createdAtTo, requestedById, approvedById, dataAvailable, sortBy, sortDirection, limit, offset, callback)</td>
1254
+ <td style="padding:15px">Use this endpoint to list batch enrollment jobs in your account.
1255
+ </td>
1256
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll?{query}</td>
1257
+ <td style="padding:15px">Yes</td>
1258
+ </tr>
1259
+ <tr>
1260
+ <td style="padding:15px">getBatchJobSettings(jobId, callback)</td>
1261
+ <td style="padding:15px">Use this endpoint to get settings for the given batch enrollment job.</td>
1262
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}?{query}</td>
1263
+ <td style="padding:15px">Yes</td>
1264
+ </tr>
1265
+ <tr>
1266
+ <td style="padding:15px">updateBatchJobSettings(jobId, body, callback)</td>
1267
+ <td style="padding:15px">Use this endpoint to update settings for the given batch enrollment job.
1268
+ </td>
1269
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}?{query}</td>
1270
+ <td style="padding:15px">Yes</td>
1271
+ </tr>
1272
+ <tr>
1273
+ <td style="padding:15px">regenerateBatchJobPasscode(jobId, callback)</td>
1274
+ <td style="padding:15px">Use this endpoint to regenerate the passcode external users must provide to download a batch job. In the response, the `passcode` field returns the new passcode value.
1275
+
1276
+ **Note:** To use this endpoint, the given batch enrollment job must have a `passcode_generation_option` of `AUTO`.
1277
+ </td>
1278
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/regenerate-passcode?{query}</td>
1279
+ <td style="padding:15px">Yes</td>
1280
+ </tr>
1281
+ <tr>
1282
+ <td style="padding:15px">approveJob(jobId, callback)</td>
1283
+ <td style="padding:15px">Use this endpoint to approve a batch certificate enrollment job. You must approve a job before you can download the issued certificates and private keys. Only jobs with a status of `PENDING_APPROVAL` can be approved or rejected.
1284
+ </td>
1285
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/approve?{query}</td>
1286
+ <td style="padding:15px">Yes</td>
1287
+ </tr>
1288
+ <tr>
1289
+ <td style="padding:15px">rejectJob(jobId, body, callback)</td>
1290
+ <td style="padding:15px">Use this endpoint to reject the results of a batch certificate enrollment job. Rejected jobs remain in DigiCert® , but the issued certificates and keys can never be downloaded. Only jobs with a status of `PENDING_APPROVAL` can be approved or rejected.
1291
+ </td>
1292
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/reject?{query}</td>
1293
+ <td style="padding:15px">Yes</td>
1294
+ </tr>
1295
+ <tr>
1296
+ <td style="padding:15px">downloadReport(jobId, callback)</td>
1297
+ <td style="padding:15px">Use this endpoint to download a report with information about a completed batch enrollment job. To download a report, the job must have a status of `PENDING_APPROVAL`, `FAILED`, `APPROVED`, or `REJECTED`.
1298
+ </td>
1299
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-report?{query}</td>
1300
+ <td style="padding:15px">Yes</td>
1301
+ </tr>
1302
+ <tr>
1303
+ <td style="padding:15px">downloadCertificates(jobId, callback)</td>
1304
+ <td style="padding:15px">Use this endpoint to download the certificates issued from a completed batch enrollment job. Only jobs with a status of `APPROVED` can be downloaded.
1305
+
1306
+ ## Response format
1307
+
1308
+ The Content-Type of the API response depends on two factors:
1309
+ * Keypair generation method (client-side or server-side)
1310
+
1311
+ * Certificate format (JSON, PEM, or DER)
1312
+
1313
+ ### Client-side keypair generation
1314
+
1315
+ * **PEM/DER**: If the `certificate_format` is `PEM` or `DER`, the Content-Type header in the API response is `application/zip`. The ...(description truncated)</td>
1316
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-certificates?{query}</td>
1317
+ <td style="padding:15px">Yes</td>
1318
+ </tr>
1319
+ <tr>
1320
+ <td style="padding:15px">deleteDownloadUrls(jobId, callback)</td>
1321
+ <td style="padding:15px">Use this endpoint to delete the download URLs for the given batch enrollment job. Deleting these URLs invalidates all external download links for the batch job.
1322
+ </td>
1323
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/delete-download-urls?{query}</td>
1324
+ <td style="padding:15px">Yes</td>
1325
+ </tr>
1326
+ <tr>
1327
+ <td style="padding:15px">resendDownloadUrls(jobId, callback)</td>
1328
+ <td style="padding:15px">Use this endpoint to resend the download URLs for the given batch enrollment job. This operation creates new download links and emails them to all external emails (`external_emails`) on the batch job. Prior external download links for the batch job are invalidated.
1329
+ </td>
1330
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/resend-download-urls?{query}</td>
1331
+ <td style="padding:15px">Yes</td>
1332
+ </tr>
1333
+ <tr>
1334
+ <td style="padding:15px">batchEnrollExternal(enrollmentProfileId, name, data, emails, keyType, signatureAlgorithm, description, callback)</td>
1335
+ <td style="padding:15px">Use this endpoint to submit a batch enrollment job that requests certificates from an enrollment profile in another DigiCert® IoT Trust Manager account.
1336
+
1337
+ To create an external batch enrollment job, upload a compressed CSV file with details about each certificate request. To learn how to format the CSV file, see [CSV format for batch certificate enrollment](https://dev.digicert.com/en/digicert-one-apis/iot-device-manager-api/csv-format-for-batch-certificate-enrollment.html).
1338
+
1339
+ **Requirements and l...(description truncated)</td>
1340
+ <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/external-batch-enroll?{query}</td>
1341
+ <td style="padding:15px">Yes</td>
1342
+ </tr>
1343
+ <tr>
1344
+ <td style="padding:15px">downloadMapping(jobId, callback)</td>
1345
+ <td style="padding:15px">Use this endpoint to download a CSV file with IDs for each certificate in the given external batch enrollment job. The CSV file shows the ID of the issued certificate for each unique value or line number in the file used to create the batch job.
1346
+
1347
+ **Note:** You can only download certificate ID mapping for batch jobs created for enrollment profiles with an enrollment method of `EXTERNAL_BATCH`.
1348
+ </td>
1349
+ <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-mapping?{query}</td>
1350
+ <td style="padding:15px">Yes</td>
1351
+ </tr>
1352
+ <tr>
1353
+ <td style="padding:15px">downloadByJobIdAndUniqueId(jobId, uniqueIdentifier, format, callback)</td>
1354
+ <td style="padding:15px">Use this endpoint to download the certificate and private key for a certificate with the given job ID and unique identifier. To use this operation, the certificate must have been issued using the `EXTERNAL_BATCH` enrollment method.
1355
+ </td>
1356
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/unique-identifier/{pathv2}/format/{pathv3}?{query}</td>
1357
+ <td style="padding:15px">Yes</td>
1358
+ </tr>
1359
+ <tr>
1360
+ <td style="padding:15px">downloadByCommonName(commonName, format, callback)</td>
1361
+ <td style="padding:15px">Use this endpoint to download the certificate and private key for a certificate with the given common name. To use this operation, the certificate must have been issued using the `EXTERNAL_BATCH` enrollment method.
1362
+
1363
+ This endpoint returns multiple certificates if the common name is not unique. Responses with multiple certificates are sorted in descending order by the creation date and time of the certificate.
1364
+ </td>
1365
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/common-name/{pathv1}/format/{pathv2}?{query}</td>
1366
+ <td style="padding:15px">Yes</td>
1367
+ </tr>
1368
+ <tr>
1369
+ <td style="padding:15px">downloadByJobIdAndCommonName(jobId, commonName, format, callback)</td>
1370
+ <td style="padding:15px">Use this endpoint to download the certificate and private key for a certificate with the given job ID and common name. To use this operation, the certificate must have been issued using the `EXTERNAL_BATCH` enrollment method.
1371
+
1372
+ This endpoint returns multiple certificates if the common name is not unique. Responses with multiple certificates are sorted in descending order by the creation date and time of the certificate.
1373
+ </td>
1374
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/common-name/{pathv2}/format/{pathv3}?{query}</td>
1375
+ <td style="padding:15px">Yes</td>
1376
+ </tr>
1377
+ <tr>
1378
+ <td style="padding:15px">downloadByCertificateValue(certificateValue, format, callback)</td>
1379
+ <td style="padding:15px">Use this endpoint to download the certificate and private key for a certificate with the given certificate value. To use this operation, the certificate must have been issued using the `EXTERNAL_BATCH` enrollment method.
1380
+
1381
+ This endpoint returns multiple certificates if the certificate value is not unique. Responses with multiple certificates are sorted in descending order by the creation date and time of the certificate.
1382
+ </td>
1383
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/certificate-value/{pathv1}/format/{pathv2}?{query}</td>
1384
+ <td style="padding:15px">Yes</td>
1385
+ </tr>
1386
+ <tr>
1387
+ <td style="padding:15px">downloadByJobIdAndCertificateValue(jobId, certificateValue, format, callback)</td>
1388
+ <td style="padding:15px">Use this endpoint to download the certificate and private key for a certificate with the given job ID and certificate value. To use this operation, the certificate must have been issued using the `EXTERNAL_BATCH` enrollment method.
1389
+
1390
+ This endpoint returns multiple certificates if the certificate value is not unique. Responses with multiple certificates are sorted in descending order by the creation date and time of the certificate.
1391
+ </td>
1392
+ <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/certificate-value/{pathv2}/format/{pathv3}?{query}</td>
1393
+ <td style="padding:15px">Yes</td>
1394
+ </tr>
1395
+ <tr>
1396
+ <td style="padding:15px">createDeviceProfile(body, callback)</td>
1397
+ <td style="padding:15px">Use this endpoint to create a device profile.
1398
+
1399
+ To create a device profile, your request must include the ID of the division the device profile will be assigned to. You can get the ID for a division from the division details page in DigiCert® .
1400
+ </td>
1401
+ <td style="padding:15px">{base_path}/{version}/api/v1/device-profile?{query}</td>
1402
+ <td style="padding:15px">Yes</td>
1403
+ </tr>
1404
+ <tr>
1405
+ <td style="padding:15px">listdeviceprofiles(name, status, accountId, divisionId, limit, offset, callback)</td>
1406
+ <td style="padding:15px">Use this endpoint to get a list of device profiles, or to search for profiles that meet the given criteria.
1407
+ </td>
1408
+ <td style="padding:15px">{base_path}/{version}/api/v1/device-profile?{query}</td>
1409
+ <td style="padding:15px">Yes</td>
1410
+ </tr>
1411
+ <tr>
1412
+ <td style="padding:15px">getDeviceProfile(deviceProfileId, callback)</td>
1413
+ <td style="padding:15px">Use this endpoint to get information about a device profile.
1414
+ </td>
1415
+ <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}?{query}</td>
1416
+ <td style="padding:15px">Yes</td>
1417
+ </tr>
1418
+ <tr>
1419
+ <td style="padding:15px">updateDeviceProfile(deviceProfileId, body, callback)</td>
1420
+ <td style="padding:15px">Use this endpoint to update the device profile with the given ID.
1421
+ </td>
1422
+ <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}?{query}</td>
1423
+ <td style="padding:15px">Yes</td>
1424
+ </tr>
1425
+ <tr>
1426
+ <td style="padding:15px">deleteDeviceProfile(deviceProfileId, callback)</td>
1427
+ <td style="padding:15px">Use this endpoint to delete the device profile with the given ID. Deleted device profiles cannot be used in new enrollment profiles, but enrollment profiles that already use deleted device profiles will continue to issue certificates.
1428
+ </td>
1429
+ <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}/delete?{query}</td>
1430
+ <td style="padding:15px">Yes</td>
1431
+ </tr>
1432
+ <tr>
1433
+ <td style="padding:15px">restoreDeviceProfile(deviceProfileId, callback)</td>
1434
+ <td style="padding:15px">Use this endpoint to restore a deleted device profile.
1435
+ </td>
1436
+ <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}/undelete?{query}</td>
1437
+ <td style="padding:15px">Yes</td>
1438
+ </tr>
1439
+ <tr>
1440
+ <td style="padding:15px">getICA(icaId, callback)</td>
1441
+ <td style="padding:15px">Use this endpoint to get information about an intermediate CA (ICA) used in DigiCert® IoT Trust Manager.
1442
+ </td>
1443
+ <td style="padding:15px">{base_path}/{version}/api/v1/managed-ca/{pathv1}?{query}</td>
1444
+ <td style="padding:15px">Yes</td>
1445
+ </tr>
1446
+ <tr>
1447
+ <td style="padding:15px">listICAs(accountId, divisionId, commonName, serialNumber, includePemCaBody, includePemCaChain, validFromFrom, validFromTo, validToFrom, validToTo, sortBy, sortDirection, limit, offset, callback)</td>
1448
+ <td style="padding:15px">Use this endpoint to get a list of intermediate CAs (ICAs) used in DigiCert® IoT Trust Manager. Use query parameters to filter results or search for a specific ICA.
1449
+ </td>
1450
+ <td style="padding:15px">{base_path}/{version}/api/v1/managed-ca?{query}</td>
1451
+ <td style="padding:15px">Yes</td>
1452
+ </tr>
1453
+ <tr>
1454
+ <td style="padding:15px">getGatewayDetails(gatewayId, callback)</td>
1455
+ <td style="padding:15px">Use this endpoint to get information about the gateway with the given ID.</td>
1456
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}?{query}</td>
1457
+ <td style="padding:15px">Yes</td>
1458
+ </tr>
1459
+ <tr>
1460
+ <td style="padding:15px">updateGateway(gatewayId, body, callback)</td>
1461
+ <td style="padding:15px">Use this endpoint to update the gateway with the given ID.
1462
+
1463
+ Some updates change the gateway's configuration file. For these updates, you need to download the modified configuration file, apply it to the gateway host, and restart the gateway.
1464
+
1465
+ - To check if an update changed the configuration file, submit a request to the [Get gateway details](#/Gateways/getGatewayDetails) endpoint. In the response, check the `config_updated_at` and `recent_config_was_downloaded` values.
1466
+
1467
+ - To download the YAML c...(description truncated)</td>
1468
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}?{query}</td>
1469
+ <td style="padding:15px">Yes</td>
1470
+ </tr>
1471
+ <tr>
1472
+ <td style="padding:15px">listGateways(accountId, name, ipAddress, status, createdAtFrom, createdAtTo, configStatus, macAddress, sortBy, sortDirection, limit, offset, callback)</td>
1473
+ <td style="padding:15px">Use this endpoint to get a list of records with information about your gateways.
1474
+
1475
+ By default, this endpoint only returns active and disabled gateways. To search for deleted gateways, append the query string `status=deleted` to the request URL.
1476
+ </td>
1477
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway?{query}</td>
1478
+ <td style="padding:15px">Yes</td>
1479
+ </tr>
1480
+ <tr>
1481
+ <td style="padding:15px">createGateway(body, callback)</td>
1482
+ <td style="padding:15px">Use this endpoint to create a gateway. A gateway is an application installed on a host server that can connect to DigiCert® IoT Trust Manager. Devices without internet connectivity can send requests to the gateway, and the gateway routes those requests to DigiCert® IoT Trust Manager.
1483
+
1484
+ After creating a gateway, DigiCert® IoT Trust Manager generates a YAML configuration file with comments describing how to finish setting up the gateway on your host server. To download the YAML configuration file f...(description truncated)</td>
1485
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway?{query}</td>
1486
+ <td style="padding:15px">Yes</td>
1487
+ </tr>
1488
+ <tr>
1489
+ <td style="padding:15px">enableGateway(gatewayId, callback)</td>
1490
+ <td style="padding:15px">Use this endpoint to enable a gateway.
1491
+ </td>
1492
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/enable?{query}</td>
1493
+ <td style="padding:15px">Yes</td>
1494
+ </tr>
1495
+ <tr>
1496
+ <td style="padding:15px">disableGateway(gatewayId, callback)</td>
1497
+ <td style="padding:15px">Use this endpoint to disable a gateway.
1498
+ </td>
1499
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/disable?{query}</td>
1500
+ <td style="padding:15px">Yes</td>
1501
+ </tr>
1502
+ <tr>
1503
+ <td style="padding:15px">deleteGateway(gatewayId, callback)</td>
1504
+ <td style="padding:15px">Use this endpoint to delete a gateway.
1505
+ </td>
1506
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/delete?{query}</td>
1507
+ <td style="padding:15px">Yes</td>
1508
+ </tr>
1509
+ <tr>
1510
+ <td style="padding:15px">restoreGateway(gatewayId, callback)</td>
1511
+ <td style="padding:15px">Use this endpoint to restore a deleted gateway.
1512
+ </td>
1513
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/undelete?{query}</td>
1514
+ <td style="padding:15px">Yes</td>
1515
+ </tr>
1516
+ <tr>
1517
+ <td style="padding:15px">downloadGatewayConfig(gatewayId, callback)</td>
1518
+ <td style="padding:15px">Use this endpoint to download the YAML configuration for a gateway as plain text. To download a configuration file, the gateway must have a `config_status` value of `complete`.
1519
+ </td>
1520
+ <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/config?{query}</td>
1521
+ <td style="padding:15px">Yes</td>
1522
+ </tr>
1523
+ <tr>
1524
+ <td style="padding:15px">listOCSPGroups(accountId, divisionId, name, status, certificateCommonName, certificateSerialNumber, issuerCommonName, issuerSerialNumber, deviceIdentifier, certificateProfileId, enrollmentProfileId, createdAtFrom, createdAtTo, sortBy, sortDirection, limit, offset, callback)</td>
1525
+ <td style="padding:15px">Use this endpoint to list OCSP groups in DigiCert® IoT Trust Manager.
1526
+
1527
+ By default, returns all OCSP groups for each account the authenticated client belongs to. Results are sorted in descending order by `created_at` date. To search for a specific OCSP group or change the pagination settings, use query string parameters.
1528
+ </td>
1529
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group?{query}</td>
1530
+ <td style="padding:15px">Yes</td>
1531
+ </tr>
1532
+ <tr>
1533
+ <td style="padding:15px">createOCSPGroup(body, callback)</td>
1534
+ <td style="padding:15px">Use this endpoint to create an OCSP group for certificates in DigiCert® IoT Trust Manager.
1535
+
1536
+ With OCSP groups, you can get the status of every certificate in the group by making a single OCSP request for any certificate in the group.
1537
+
1538
+ When creating an OCSP group, keep the following in mind:
1539
+
1540
+ - All certificates in an OCSP group must be issued through both the same division and root or intermediate CA.
1541
+
1542
+ - A certificate can only be assigned to one OCSP group.
1543
+
1544
+ - The issuing CA for certificates in th...(description truncated)</td>
1545
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group?{query}</td>
1546
+ <td style="padding:15px">Yes</td>
1547
+ </tr>
1548
+ <tr>
1549
+ <td style="padding:15px">getOCSPGroupDetails(ocspGroupId, callback)</td>
1550
+ <td style="padding:15px">Use this endpoint to get details about the given OCSP group.
1551
+ </td>
1552
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}?{query}</td>
1553
+ <td style="padding:15px">Yes</td>
1554
+ </tr>
1555
+ <tr>
1556
+ <td style="padding:15px">updateOCSPGroup(ocspGroupId, body, callback)</td>
1557
+ <td style="padding:15px">Use this endpoint to update the name of an OCSP group.
1558
+ </td>
1559
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}?{query}</td>
1560
+ <td style="padding:15px">Yes</td>
1561
+ </tr>
1562
+ <tr>
1563
+ <td style="padding:15px">deleteOCSPGroup(ocspGroupId, callback)</td>
1564
+ <td style="padding:15px">Use this endpoint to delete an OCSP group.
1565
+
1566
+ **Warning!** This is a destructive operation. Deleting an OCSP group removes all certificates from the OCSP group. Deleted OCSP groups cannot be restored.
1567
+ </td>
1568
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}?{query}</td>
1569
+ <td style="padding:15px">Yes</td>
1570
+ </tr>
1571
+ <tr>
1572
+ <td style="padding:15px">addCertsOCSPGroup(ocspGroupId, body, callback)</td>
1573
+ <td style="padding:15px">Use this endpoint to add certificates to an OCSP group.
1574
+
1575
+ When adding certificates to an OCSP group, keep the following in mind:
1576
+
1577
+ - All certificates must be issued through the OCSP group's division (`division_id`) and issuing CA (`ica_id`).
1578
+
1579
+ - Certificates already in an OCSP group cannot be added to another OCSP group.
1580
+ </td>
1581
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}/add-certificates?{query}</td>
1582
+ <td style="padding:15px">Yes</td>
1583
+ </tr>
1584
+ <tr>
1585
+ <td style="padding:15px">removeCertsOCSPGroup(ocspGroupId, body, callback)</td>
1586
+ <td style="padding:15px">Use this endpoint to remove certificates from an OCSP group.
1587
+ </td>
1588
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}/remove-certificates?{query}</td>
1589
+ <td style="padding:15px">Yes</td>
1590
+ </tr>
1591
+ <tr>
1592
+ <td style="padding:15px">listOCSPGroupCerts(ocspGroupId, accountId, divisionId, status, serialNumber, commonName, certificateValue, deviceIdentifier, enrollmentMethod, createdFrom, createdTo, validToStart, validToEnd, issuerCommonName, issuerSerialNumber, keyType, enrollmentProfileId, revokedFrom, revokedTo, deviceId, certificateType, createdInLastNDays, createdInCurrentMonth, createdInPreviousMonth, expiringInNextNDays, expiringInRemainingOfCurrentMonth, expiringInNextMonth, keyUsage, extendedKeyUsage, certificatePolicies, authenticationId, authenticationType, authenticationName, caConnectorType, sortBy, sortDirection, limit, offset, pagination, callback)</td>
1593
+ <td style="padding:15px">Use this endpoint to list certificates in the given OCSP group.
1594
+
1595
+ By default, returns all certificates that belong to the given OCSP group. Results are sorted in descending order by `created` date. To search for a specific certificate or change the pagination settings, use query string parameters.
1596
+ </td>
1597
+ <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}/certificates?{query}</td>
1598
+ <td style="padding:15px">Yes</td>
1599
+ </tr>
355
1600
  </table>
356
1601
  <br>