@itentialopensource/adapter-digicert_pki 1.0.0 → 1.1.1

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 (43) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/CALLS.md +162 -453
  4. package/CHANGELOG.md +16 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/README.md +31 -22
  8. package/adapter.js +159 -330
  9. package/adapterBase.js +538 -873
  10. package/changelogs/changelog.md +16 -0
  11. package/metadata.json +49 -0
  12. package/package.json +22 -25
  13. package/pronghorn.json +474 -142
  14. package/propertiesSchema.json +455 -42
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +3224 -0
  17. package/report/adapter-openapi.yaml +2185 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691508686598.json +120 -0
  20. package/report/updateReport1692203137726.json +120 -0
  21. package/report/updateReport1694467869659.json +120 -0
  22. package/report/updateReport1698422457936.json +120 -0
  23. package/sampleProperties.json +64 -3
  24. package/test/integration/adapterTestBasicGet.js +1 -1
  25. package/test/integration/adapterTestConnectivity.js +91 -42
  26. package/test/integration/adapterTestIntegration.js +275 -147
  27. package/test/unit/adapterBaseTestUnit.js +388 -313
  28. package/test/unit/adapterTestUnit.js +519 -322
  29. package/utils/adapterInfo.js +1 -1
  30. package/utils/addAuth.js +1 -1
  31. package/utils/artifactize.js +1 -1
  32. package/utils/checkMigrate.js +1 -1
  33. package/utils/entitiesToDB.js +1 -0
  34. package/utils/findPath.js +1 -1
  35. package/utils/methodDocumentor.js +71 -23
  36. package/utils/modify.js +13 -15
  37. package/utils/packModificationScript.js +1 -1
  38. package/utils/taskMover.js +309 -0
  39. package/utils/tbScript.js +3 -10
  40. package/utils/tbUtils.js +2 -3
  41. package/utils/testRunner.js +1 -1
  42. package/utils/troubleshootingAdapter.js +1 -3
  43. package/workflows/README.md +0 -3
package/CALLS.md CHANGED
@@ -216,7 +216,7 @@ Specific adapter calls are built based on the API of the Digicert. The Adapter B
216
216
  </tr>
217
217
  <tr>
218
218
  <td style="padding:15px">recoverKeyUsingGET(serialNumber, callback)</td>
219
- <td style="padding:15px">This API is used to get private key information for key-escrowed certificate with given serial number</td>
219
+ <td style="padding:15px">This API is used to get private key information for key-escrowed certificate with given serial numb</td>
220
220
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/key?{query}</td>
221
221
  <td style="padding:15px">Yes</td>
222
222
  </tr>
@@ -330,7 +330,7 @@ Specific adapter calls are built based on the API of the Digicert. The Adapter B
330
330
  </tr>
331
331
  <tr>
332
332
  <td style="padding:15px">createSeatUsingPOST(createSeatRequest, callback)</td>
333
- <td style="padding:15px">This API is used to create a seat. This seat can be used for a user, device, server or organization seat pool.</td>
333
+ <td style="padding:15px">This API is used to create a seat. This seat can be used for a user, device, server or organizatio</td>
334
334
  <td style="padding:15px">{base_path}/{version}/api/v1/seat?{query}</td>
335
335
  <td style="padding:15px">Yes</td>
336
336
  </tr>
@@ -348,1252 +348,961 @@ Specific adapter calls are built based on the API of the Digicert. The Adapter B
348
348
  </tr>
349
349
  <tr>
350
350
  <td style="padding:15px">deleteSeatUsingDELETE(seatId, callback)</td>
351
- <td style="padding:15px">This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to the specified seat.</td>
351
+ <td style="padding:15px">This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to t</td>
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
355
  <tr>
356
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>
357
+ <td style="padding:15px">listCertificates</td>
365
358
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate?{query}</td>
366
359
  <td style="padding:15px">Yes</td>
367
360
  </tr>
368
361
  <tr>
369
362
  <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>
363
+ <td style="padding:15px">getExampleCertificateRequestCertificateID</td>
374
364
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/example-request?{query}</td>
375
365
  <td style="padding:15px">Yes</td>
376
366
  </tr>
377
367
  <tr>
378
368
  <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>
369
+ <td style="padding:15px">renewCertificate</td>
388
370
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/renew?{query}</td>
389
371
  <td style="padding:15px">Yes</td>
390
372
  </tr>
391
373
  <tr>
392
374
  <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>
375
+ <td style="padding:15px">renewBySerial</td>
402
376
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/serial-number/{pathv1}/renew?{query}</td>
403
377
  <td style="padding:15px">Yes</td>
404
378
  </tr>
405
379
  <tr>
406
380
  <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>
381
+ <td style="padding:15px">revokeCertificate</td>
408
382
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/revoke?{query}</td>
409
383
  <td style="padding:15px">Yes</td>
410
384
  </tr>
411
385
  <tr>
412
386
  <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>
387
+ <td style="padding:15px">updateNote</td>
414
388
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/note?{query}</td>
415
389
  <td style="padding:15px">Yes</td>
416
390
  </tr>
417
391
  <tr>
418
392
  <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>
393
+ <td style="padding:15px">revokeCertificateBySerialNumber</td>
420
394
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/serial-number/{pathv1}/revoke?{query}</td>
421
395
  <td style="padding:15px">Yes</td>
422
396
  </tr>
423
397
  <tr>
424
398
  <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>
399
+ <td style="padding:15px">downloadCertificate</td>
427
400
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/download/{pathv2}?{query}</td>
428
401
  <td style="padding:15px">Yes</td>
429
402
  </tr>
430
403
  <tr>
431
404
  <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>
405
+ <td style="padding:15px">downloadCertificateBySerialNumber</td>
433
406
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/serial-number/{pathv1}/download/{pathv2}?{query}</td>
434
407
  <td style="padding:15px">Yes</td>
435
408
  </tr>
436
409
  <tr>
437
410
  <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>
411
+ <td style="padding:15px">importCertificate</td>
443
412
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-import/{pathv1}?{query}</td>
444
413
  <td style="padding:15px">Yes</td>
445
414
  </tr>
446
415
  <tr>
447
416
  <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>
417
+ <td style="padding:15px">getImportDetails</td>
449
418
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-import/job/{pathv1}?{query}</td>
450
419
  <td style="padding:15px">Yes</td>
451
420
  </tr>
452
421
  <tr>
453
422
  <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>
423
+ <td style="padding:15px">getCertificateStatus</td>
455
424
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-status/{pathv1}?{query}</td>
456
425
  <td style="padding:15px">Yes</td>
457
426
  </tr>
458
427
  <tr>
459
428
  <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>
429
+ <td style="padding:15px">getCertificateStatusById</td>
461
430
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-status/certificate-id/{pathv1}?{query}</td>
462
431
  <td style="padding:15px">Yes</td>
463
432
  </tr>
464
433
  <tr>
465
434
  <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>
435
+ <td style="padding:15px">listCertificatesByCertificateValue</td>
468
436
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/certificate-value/{pathv1}?{query}</td>
469
437
  <td style="padding:15px">Yes</td>
470
438
  </tr>
471
439
  <tr>
472
440
  <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>
441
+ <td style="padding:15px">downloadApprovedCertificate</td>
479
442
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/download-approved-certificate?{query}</td>
480
443
  <td style="padding:15px">Yes</td>
481
444
  </tr>
482
445
  <tr>
483
446
  <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>
447
+ <td style="padding:15px">listAuthenticationCACertificates</td>
486
448
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-ca?{query}</td>
487
449
  <td style="padding:15px">Yes</td>
488
450
  </tr>
489
451
  <tr>
490
452
  <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>
453
+ <td style="padding:15px">listAuthenticationCACertificatesByAccount</td>
495
454
  <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca?{query}</td>
496
455
  <td style="padding:15px">Yes</td>
497
456
  </tr>
498
457
  <tr>
499
458
  <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>
459
+ <td style="padding:15px">uploadAuthenticationCACertificate</td>
502
460
  <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca?{query}</td>
503
461
  <td style="padding:15px">Yes</td>
504
462
  </tr>
505
463
  <tr>
506
464
  <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>
465
+ <td style="padding:15px">getAuthenticationCACertificate</td>
509
466
  <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca/{pathv2}?{query}</td>
510
467
  <td style="padding:15px">Yes</td>
511
468
  </tr>
512
469
  <tr>
513
470
  <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>
471
+ <td style="padding:15px">deleteAuthenticationCACertificate</td>
518
472
  <td style="padding:15px">{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca/{pathv2}/delete?{query}</td>
519
473
  <td style="padding:15px">Yes</td>
520
474
  </tr>
521
475
  <tr>
522
476
  <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>
477
+ <td style="padding:15px">createAuthenticationCATemplate</td>
529
478
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template?{query}</td>
530
479
  <td style="padding:15px">Yes</td>
531
480
  </tr>
532
481
  <tr>
533
482
  <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>
483
+ <td style="padding:15px">listAuthenticationCATemplate</td>
536
484
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template?{query}</td>
537
485
  <td style="padding:15px">Yes</td>
538
486
  </tr>
539
487
  <tr>
540
488
  <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>
489
+ <td style="padding:15px">updateAuthenticationCATemplate</td>
543
490
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}?{query}</td>
544
491
  <td style="padding:15px">Yes</td>
545
492
  </tr>
546
493
  <tr>
547
494
  <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>
495
+ <td style="padding:15px">getAuthenticationCATemplate</td>
550
496
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}?{query}</td>
551
497
  <td style="padding:15px">Yes</td>
552
498
  </tr>
553
499
  <tr>
554
500
  <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>
501
+ <td style="padding:15px">disableAuthenticationCATemplate</td>
561
502
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/disable?{query}</td>
562
503
  <td style="padding:15px">Yes</td>
563
504
  </tr>
564
505
  <tr>
565
506
  <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>
507
+ <td style="padding:15px">deleteAuthenticationCATemplate</td>
573
508
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/delete?{query}</td>
574
509
  <td style="padding:15px">Yes</td>
575
510
  </tr>
576
511
  <tr>
577
512
  <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>
513
+ <td style="padding:15px">restoreAuthenticationCATemplate</td>
580
514
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/undelete?{query}</td>
581
515
  <td style="padding:15px">Yes</td>
582
516
  </tr>
583
517
  <tr>
584
518
  <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>
519
+ <td style="padding:15px">enableAuthenticationCATemplate</td>
587
520
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/enable?{query}</td>
588
521
  <td style="padding:15px">Yes</td>
589
522
  </tr>
590
523
  <tr>
591
524
  <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>
525
+ <td style="padding:15px">listAssignableAuthenticationCACertificates</td>
594
526
  <td style="padding:15px">{base_path}/{version}/api/v1/cert-auth-template/assignable-ca/{pathv1}?{query}</td>
595
527
  <td style="padding:15px">Yes</td>
596
528
  </tr>
597
529
  <tr>
598
530
  <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>
531
+ <td style="padding:15px">addAuthenticationCertificate</td>
604
532
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate?{query}</td>
605
533
  <td style="padding:15px">Yes</td>
606
534
  </tr>
607
535
  <tr>
608
536
  <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>
537
+ <td style="padding:15px">listAuthenticationCertificates</td>
611
538
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate?{query}</td>
612
539
  <td style="padding:15px">Yes</td>
613
540
  </tr>
614
541
  <tr>
615
542
  <td style="padding:15px">getAuthenticationCertificateDetails(authenticationCertificateId, callback)</td>
616
- <td style="padding:15px">Use this endpoint to get information about an authentication certificate.</td>
543
+ <td style="padding:15px">getAuthenticationCertificateDetails</td>
617
544
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}?{query}</td>
618
545
  <td style="padding:15px">Yes</td>
619
546
  </tr>
620
547
  <tr>
621
548
  <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>
549
+ <td style="padding:15px">updateAuthenticationCertificate</td>
626
550
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}?{query}</td>
627
551
  <td style="padding:15px">Yes</td>
628
552
  </tr>
629
553
  <tr>
630
554
  <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>
555
+ <td style="padding:15px">disableAuthenticationCertificate</td>
633
556
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/disable?{query}</td>
634
557
  <td style="padding:15px">Yes</td>
635
558
  </tr>
636
559
  <tr>
637
560
  <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>
561
+ <td style="padding:15px">enableAuthenticationCertificate</td>
640
562
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/enable?{query}</td>
641
563
  <td style="padding:15px">Yes</td>
642
564
  </tr>
643
565
  <tr>
644
566
  <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>
567
+ <td style="padding:15px">deleteAuthenticationCertificate</td>
647
568
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/delete?{query}</td>
648
569
  <td style="padding:15px">Yes</td>
649
570
  </tr>
650
571
  <tr>
651
572
  <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>
573
+ <td style="padding:15px">restoreAuthenticationCertificate</td>
654
574
  <td style="padding:15px">{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/undelete?{query}</td>
655
575
  <td style="padding:15px">Yes</td>
656
576
  </tr>
657
577
  <tr>
658
578
  <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>
579
+ <td style="padding:15px">listCertificateProfiles</td>
661
580
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile?{query}</td>
662
581
  <td style="padding:15px">Yes</td>
663
582
  </tr>
664
583
  <tr>
665
584
  <td style="padding:15px">createCertificateProfile(body, callback)</td>
666
- <td style="padding:15px">Use this endpoint to create a certificate profile.
667
- </td>
585
+ <td style="padding:15px">createCertificateProfile</td>
668
586
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile?{query}</td>
669
587
  <td style="padding:15px">Yes</td>
670
588
  </tr>
671
589
  <tr>
672
590
  <td style="padding:15px">getCertificateProfile(certificateProfileId, callback)</td>
673
- <td style="padding:15px">Use this endpoint to get a certificate profile.
674
- </td>
591
+ <td style="padding:15px">getCertificateProfile</td>
675
592
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}?{query}</td>
676
593
  <td style="padding:15px">Yes</td>
677
594
  </tr>
678
595
  <tr>
679
596
  <td style="padding:15px">updateCertificateProfile(certificateProfileId, body, callback)</td>
680
- <td style="padding:15px">Use this endpoint to update a certificate profile.
681
- </td>
597
+ <td style="padding:15px">updateCertificateProfile</td>
682
598
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}?{query}</td>
683
599
  <td style="padding:15px">Yes</td>
684
600
  </tr>
685
601
  <tr>
686
602
  <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>
603
+ <td style="padding:15px">disableCertificateProfile</td>
689
604
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/disable?{query}</td>
690
605
  <td style="padding:15px">Yes</td>
691
606
  </tr>
692
607
  <tr>
693
608
  <td style="padding:15px">enableCertificateProfile(certificateProfileId, callback)</td>
694
- <td style="padding:15px">Use this endpoint to enable a disabled certificate profile.
695
- </td>
609
+ <td style="padding:15px">enableCertificateProfile</td>
696
610
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/enable?{query}</td>
697
611
  <td style="padding:15px">Yes</td>
698
612
  </tr>
699
613
  <tr>
700
614
  <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>
615
+ <td style="padding:15px">deleteCertificateProfile</td>
705
616
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/delete?{query}</td>
706
617
  <td style="padding:15px">Yes</td>
707
618
  </tr>
708
619
  <tr>
709
620
  <td style="padding:15px">restoreCertificateProfile(certificateProfileId, callback)</td>
710
- <td style="padding:15px">Use this endpoint to restore a deleted certificate profile.
711
- </td>
621
+ <td style="padding:15px">restoreCertificateProfile</td>
712
622
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/undelete?{query}</td>
713
623
  <td style="padding:15px">Yes</td>
714
624
  </tr>
715
625
  <tr>
716
626
  <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>
627
+ <td style="padding:15px">assignCertificateProfileDivisions</td>
719
628
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/division/assign?{query}</td>
720
629
  <td style="padding:15px">Yes</td>
721
630
  </tr>
722
631
  <tr>
723
632
  <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>
633
+ <td style="padding:15px">unassignCertificateProfileDivisions</td>
726
634
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-profile/{pathv1}/division/unassign?{query}</td>
727
635
  <td style="padding:15px">Yes</td>
728
636
  </tr>
729
637
  <tr>
730
638
  <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>
639
+ <td style="padding:15px">getRequestStatus</td>
735
640
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-request/{pathv1}/status?{query}</td>
736
641
  <td style="padding:15px">Yes</td>
737
642
  </tr>
738
643
  <tr>
739
644
  <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>
645
+ <td style="padding:15px">listCertificateTemplates</td>
742
646
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template?{query}</td>
743
647
  <td style="padding:15px">Yes</td>
744
648
  </tr>
745
649
  <tr>
746
650
  <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>
651
+ <td style="padding:15px">createCertificateTemplate</td>
749
652
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template?{query}</td>
750
653
  <td style="padding:15px">Yes</td>
751
654
  </tr>
752
655
  <tr>
753
656
  <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>
657
+ <td style="padding:15px">getCertificateTemplate</td>
756
658
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}?{query}</td>
757
659
  <td style="padding:15px">Yes</td>
758
660
  </tr>
759
661
  <tr>
760
662
  <td style="padding:15px">updateCertificateTemplate(certificateTemplateId, body, callback)</td>
761
- <td style="padding:15px">Use this endpoint to update a certificate template.
762
- </td>
663
+ <td style="padding:15px">updateCertificateTemplate</td>
763
664
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}?{query}</td>
764
665
  <td style="padding:15px">Yes</td>
765
666
  </tr>
766
667
  <tr>
767
668
  <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>
669
+ <td style="padding:15px">Clone certificate template</td>
770
670
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/clone?{query}</td>
771
671
  <td style="padding:15px">Yes</td>
772
672
  </tr>
773
673
  <tr>
774
674
  <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>
675
+ <td style="padding:15px">disableCertificateTemplate</td>
777
676
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/disable?{query}</td>
778
677
  <td style="padding:15px">Yes</td>
779
678
  </tr>
780
679
  <tr>
781
680
  <td style="padding:15px">enableCertificateTemplate(certificateTemplateId, callback)</td>
782
- <td style="padding:15px">Use this endpoint to enable a certificate template.
783
- </td>
681
+ <td style="padding:15px">enableCertificateTemplate</td>
784
682
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/enable?{query}</td>
785
683
  <td style="padding:15px">Yes</td>
786
684
  </tr>
787
685
  <tr>
788
686
  <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>
687
+ <td style="padding:15px">deleteCertificateTemplate</td>
793
688
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/delete?{query}</td>
794
689
  <td style="padding:15px">Yes</td>
795
690
  </tr>
796
691
  <tr>
797
692
  <td style="padding:15px">restoreCertificateTemplate(certificateTemplateId, callback)</td>
798
- <td style="padding:15px">Use this endpoint to restore a deleted certificate template.
799
- </td>
693
+ <td style="padding:15px">restoreCertificateTemplate</td>
800
694
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-template/{pathv1}/undelete?{query}</td>
801
695
  <td style="padding:15px">Yes</td>
802
696
  </tr>
803
697
  <tr>
804
698
  <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>
699
+ <td style="padding:15px">createDevice</td>
806
700
  <td style="padding:15px">{base_path}/{version}/api/v1/device?{query}</td>
807
701
  <td style="padding:15px">Yes</td>
808
702
  </tr>
809
703
  <tr>
810
704
  <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>
705
+ <td style="padding:15px">getDeviceList</td>
812
706
  <td style="padding:15px">{base_path}/{version}/api/v1/device?{query}</td>
813
707
  <td style="padding:15px">Yes</td>
814
708
  </tr>
815
709
  <tr>
816
710
  <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>
711
+ <td style="padding:15px">getDeviceDetails</td>
818
712
  <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}?{query}</td>
819
713
  <td style="padding:15px">Yes</td>
820
714
  </tr>
821
715
  <tr>
822
716
  <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>
717
+ <td style="padding:15px">updateDevice</td>
827
718
  <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}?{query}</td>
828
719
  <td style="padding:15px">Yes</td>
829
720
  </tr>
830
721
  <tr>
831
722
  <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>
723
+ <td style="padding:15px">archiveDevice</td>
833
724
  <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}?{query}</td>
834
725
  <td style="padding:15px">Yes</td>
835
726
  </tr>
836
727
  <tr>
837
728
  <td style="padding:15px">enableDevice(deviceIdentifier, divisionId, callback)</td>
838
- <td style="padding:15px">Use this endpoint to enable a disabled device.</td>
729
+ <td style="padding:15px">enableDevice</td>
839
730
  <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}/enable?{query}</td>
840
731
  <td style="padding:15px">Yes</td>
841
732
  </tr>
842
733
  <tr>
843
734
  <td style="padding:15px">disableDevice(deviceIdentifier, divisionId, callback)</td>
844
- <td style="padding:15px">Use this endpoint to disable an enabled device.</td>
735
+ <td style="padding:15px">disableDevice</td>
845
736
  <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}/disable?{query}</td>
846
737
  <td style="padding:15px">Yes</td>
847
738
  </tr>
848
739
  <tr>
849
740
  <td style="padding:15px">restoreDevice(deviceIdentifier, divisionId, callback)</td>
850
- <td style="padding:15px">Use this endpoint to restore an archived device.</td>
741
+ <td style="padding:15px">restoreDevice</td>
851
742
  <td style="padding:15px">{base_path}/{version}/api/v1/device/{pathv1}/undelete?{query}</td>
852
743
  <td style="padding:15px">Yes</td>
853
744
  </tr>
854
745
  <tr>
855
746
  <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>
747
+ <td style="padding:15px">createDevice_v2</td>
857
748
  <td style="padding:15px">{base_path}/{version}/api/v2/device?{query}</td>
858
749
  <td style="padding:15px">Yes</td>
859
750
  </tr>
860
751
  <tr>
861
752
  <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>
753
+ <td style="padding:15px">getDeviceList_v2</td>
863
754
  <td style="padding:15px">{base_path}/{version}/api/v2/device?{query}</td>
864
755
  <td style="padding:15px">Yes</td>
865
756
  </tr>
866
757
  <tr>
867
758
  <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>
759
+ <td style="padding:15px">getDeviceDetails_v2</td>
877
760
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}?{query}</td>
878
761
  <td style="padding:15px">Yes</td>
879
762
  </tr>
880
763
  <tr>
881
764
  <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>
765
+ <td style="padding:15px">updateDevice_v2</td>
889
766
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}?{query}</td>
890
767
  <td style="padding:15px">Yes</td>
891
768
  </tr>
892
769
  <tr>
893
770
  <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>
771
+ <td style="padding:15px">archiveDevice_v2</td>
895
772
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}?{query}</td>
896
773
  <td style="padding:15px">Yes</td>
897
774
  </tr>
898
775
  <tr>
899
776
  <td style="padding:15px">enableDeviceV2(deviceId, callback)</td>
900
- <td style="padding:15px">Use this endpoint to enable a disabled device.</td>
777
+ <td style="padding:15px">enableDevice_v2</td>
901
778
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/enable?{query}</td>
902
779
  <td style="padding:15px">Yes</td>
903
780
  </tr>
904
781
  <tr>
905
782
  <td style="padding:15px">disableDeviceV2(deviceId, callback)</td>
906
- <td style="padding:15px">Use this endpoint to disable an enabled device.</td>
783
+ <td style="padding:15px">disableDevice_v2</td>
907
784
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/disable?{query}</td>
908
785
  <td style="padding:15px">Yes</td>
909
786
  </tr>
910
787
  <tr>
911
788
  <td style="padding:15px">restoreDeviceV2(deviceId, callback)</td>
912
- <td style="padding:15px">Use this endpoint to restore an archived device.</td>
789
+ <td style="padding:15px">restoreDevice_v2</td>
913
790
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/undelete?{query}</td>
914
791
  <td style="padding:15px">Yes</td>
915
792
  </tr>
916
793
  <tr>
917
794
  <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>
795
+ <td style="padding:15px">renewDeviceCertificate_v2</td>
925
796
  <td style="padding:15px">{base_path}/{version}/api/v2/device/{pathv1}/renew?{query}</td>
926
797
  <td style="padding:15px">Yes</td>
927
798
  </tr>
928
799
  <tr>
929
800
  <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>
801
+ <td style="padding:15px">listDivisions</td>
932
802
  <td style="padding:15px">{base_path}/{version}/api/v1/division/?{query}</td>
933
803
  <td style="padding:15px">Yes</td>
934
804
  </tr>
935
805
  <tr>
936
806
  <td style="padding:15px">createDivision(body, callback)</td>
937
- <td style="padding:15px">Use this endpoint to create a new division.
938
- </td>
807
+ <td style="padding:15px">createDivision</td>
939
808
  <td style="padding:15px">{base_path}/{version}/api/v1/division/?{query}</td>
940
809
  <td style="padding:15px">Yes</td>
941
810
  </tr>
942
811
  <tr>
943
812
  <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>
813
+ <td style="padding:15px">getDivision</td>
946
814
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}?{query}</td>
947
815
  <td style="padding:15px">Yes</td>
948
816
  </tr>
949
817
  <tr>
950
818
  <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>
819
+ <td style="padding:15px">updateDivision</td>
953
820
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}?{query}</td>
954
821
  <td style="padding:15px">Yes</td>
955
822
  </tr>
956
823
  <tr>
957
824
  <td style="padding:15px">disableDivision(divisionId, callback)</td>
958
- <td style="padding:15px">Use this endpoint to disable a division.
959
- </td>
825
+ <td style="padding:15px">disableDivision</td>
960
826
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/disable?{query}</td>
961
827
  <td style="padding:15px">Yes</td>
962
828
  </tr>
963
829
  <tr>
964
830
  <td style="padding:15px">enableDivision(divisionId, callback)</td>
965
- <td style="padding:15px">Use this endpoint to enable a disabled a division.
966
- </td>
831
+ <td style="padding:15px">enableDivision</td>
967
832
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/enable?{query}</td>
968
833
  <td style="padding:15px">Yes</td>
969
834
  </tr>
970
835
  <tr>
971
836
  <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>
837
+ <td style="padding:15px">deleteDivision</td>
974
838
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/delete?{query}</td>
975
839
  <td style="padding:15px">Yes</td>
976
840
  </tr>
977
841
  <tr>
978
842
  <td style="padding:15px">restoreDivision(divisionId, callback)</td>
979
- <td style="padding:15px">Use this endpoint to restore a deleted division.
980
- </td>
843
+ <td style="padding:15px">restoreDivision</td>
981
844
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/undelete?{query}</td>
982
845
  <td style="padding:15px">Yes</td>
983
846
  </tr>
984
847
  <tr>
985
848
  <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>
849
+ <td style="padding:15px">assignDivisionUsers</td>
988
850
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/users/assign?{query}</td>
989
851
  <td style="padding:15px">Yes</td>
990
852
  </tr>
991
853
  <tr>
992
854
  <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>
855
+ <td style="padding:15px">listDivisionUsers</td>
995
856
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/users?{query}</td>
996
857
  <td style="padding:15px">Yes</td>
997
858
  </tr>
998
859
  <tr>
999
860
  <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>
861
+ <td style="padding:15px">removeDivisionUsers</td>
1002
862
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/users/remove?{query}</td>
1003
863
  <td style="padding:15px">Yes</td>
1004
864
  </tr>
1005
865
  <tr>
1006
866
  <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>
867
+ <td style="padding:15px">Assign ICAs to division</td>
1009
868
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/ica/assign?{query}</td>
1010
869
  <td style="padding:15px">Yes</td>
1011
870
  </tr>
1012
871
  <tr>
1013
872
  <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>
873
+ <td style="padding:15px">Remove ICAs from division</td>
1016
874
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/ica/remove?{query}</td>
1017
875
  <td style="padding:15px">Yes</td>
1018
876
  </tr>
1019
877
  <tr>
1020
878
  <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>
879
+ <td style="padding:15px">List division ICA assignments</td>
1023
880
  <td style="padding:15px">{base_path}/{version}/api/v1/division/{pathv1}/ica?{query}</td>
1024
881
  <td style="padding:15px">Yes</td>
1025
882
  </tr>
1026
883
  <tr>
1027
884
  <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>
885
+ <td style="padding:15px">listEnrollmentProfiles</td>
1030
886
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile?{query}</td>
1031
887
  <td style="padding:15px">Yes</td>
1032
888
  </tr>
1033
889
  <tr>
1034
890
  <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>
891
+ <td style="padding:15px">createEnrollmentProfile</td>
1045
892
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile?{query}</td>
1046
893
  <td style="padding:15px">Yes</td>
1047
894
  </tr>
1048
895
  <tr>
1049
896
  <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>
897
+ <td style="padding:15px">getExampleCertificateRequestEnrollmentProfileID</td>
1054
898
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/example-request?{query}</td>
1055
899
  <td style="padding:15px">Yes</td>
1056
900
  </tr>
1057
901
  <tr>
1058
902
  <td style="padding:15px">getEnrollmentProfile(enrollmentProfileId, callback)</td>
1059
- <td style="padding:15px">Use this endpoint to get details for an enrollment profile.</td>
903
+ <td style="padding:15px">getEnrollmentProfile</td>
1060
904
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}?{query}</td>
1061
905
  <td style="padding:15px">Yes</td>
1062
906
  </tr>
1063
907
  <tr>
1064
908
  <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>
909
+ <td style="padding:15px">updateEnrollmentProfile</td>
1069
910
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}?{query}</td>
1070
911
  <td style="padding:15px">Yes</td>
1071
912
  </tr>
1072
913
  <tr>
1073
914
  <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>
915
+ <td style="padding:15px">listAssignableICAs</td>
1075
916
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/assignable-ca?{query}</td>
1076
917
  <td style="padding:15px">Yes</td>
1077
918
  </tr>
1078
919
  <tr>
1079
920
  <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>
921
+ <td style="padding:15px">getIssuingICA</td>
1081
922
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/issuer?{query}</td>
1082
923
  <td style="padding:15px">Yes</td>
1083
924
  </tr>
1084
925
  <tr>
1085
926
  <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>
927
+ <td style="padding:15px">getEnrollmentProfileSpecification</td>
1090
928
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/enrollment-specification?{query}</td>
1091
929
  <td style="padding:15px">Yes</td>
1092
930
  </tr>
1093
931
  <tr>
1094
932
  <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>
933
+ <td style="padding:15px">getEnrollmentProfileStatus</td>
1100
934
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/status?{query}</td>
1101
935
  <td style="padding:15px">Yes</td>
1102
936
  </tr>
1103
937
  <tr>
1104
938
  <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>
939
+ <td style="padding:15px">listEnrollmentPasscodes</td>
1107
940
  <td style="padding:15px">{base_path}/{version}/api/v1/passcode?{query}</td>
1108
941
  <td style="padding:15px">Yes</td>
1109
942
  </tr>
1110
943
  <tr>
1111
944
  <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>
945
+ <td style="padding:15px">createEnrollmentPasscode</td>
1117
946
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode?{query}</td>
1118
947
  <td style="padding:15px">Yes</td>
1119
948
  </tr>
1120
949
  <tr>
1121
950
  <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>
951
+ <td style="padding:15px">getEnrollmentPasscodeDetails</td>
1123
952
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}?{query}</td>
1124
953
  <td style="padding:15px">Yes</td>
1125
954
  </tr>
1126
955
  <tr>
1127
956
  <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>
957
+ <td style="padding:15px">updateEnrollmentPasscode</td>
1132
958
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}?{query}</td>
1133
959
  <td style="padding:15px">Yes</td>
1134
960
  </tr>
1135
961
  <tr>
1136
962
  <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>
963
+ <td style="padding:15px">deleteEnrollmentPasscode</td>
1139
964
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}?{query}</td>
1140
965
  <td style="padding:15px">Yes</td>
1141
966
  </tr>
1142
967
  <tr>
1143
968
  <td style="padding:15px">restoreEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1144
- <td style="padding:15px">Use this endpoint to restore a deleted enrollment passcode.</td>
969
+ <td style="padding:15px">restoreEnrollmentPasscode</td>
1145
970
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/undelete?{query}</td>
1146
971
  <td style="padding:15px">Yes</td>
1147
972
  </tr>
1148
973
  <tr>
1149
974
  <td style="padding:15px">disableEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1150
- <td style="padding:15px">Use this endpoint to disable an enrollment passcode.</td>
975
+ <td style="padding:15px">disableEnrollmentPasscode</td>
1151
976
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/disable?{query}</td>
1152
977
  <td style="padding:15px">Yes</td>
1153
978
  </tr>
1154
979
  <tr>
1155
980
  <td style="padding:15px">enableEnrollmentPasscode(enrollmentProfileId, passcodeId, callback)</td>
1156
- <td style="padding:15px">Use this endpoint to enable an enrollment passcode.</td>
981
+ <td style="padding:15px">enableEnrollmentPasscode</td>
1157
982
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/enable?{query}</td>
1158
983
  <td style="padding:15px">Yes</td>
1159
984
  </tr>
1160
985
  <tr>
1161
986
  <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>
987
+ <td style="padding:15px">regenerateEnrollmentPasscode</td>
1166
988
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/passcode/{pathv2}/regenerate?{query}</td>
1167
989
  <td style="padding:15px">Yes</td>
1168
990
  </tr>
1169
991
  <tr>
1170
992
  <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>
993
+ <td style="padding:15px">createAcmeAuthentication</td>
1174
994
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication?{query}</td>
1175
995
  <td style="padding:15px">Yes</td>
1176
996
  </tr>
1177
997
  <tr>
1178
998
  <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>
999
+ <td style="padding:15px">listAcmeAuthentication</td>
1181
1000
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication?{query}</td>
1182
1001
  <td style="padding:15px">Yes</td>
1183
1002
  </tr>
1184
1003
  <tr>
1185
1004
  <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>
1005
+ <td style="padding:15px">getAcmeAuthentication</td>
1188
1006
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}?{query}</td>
1189
1007
  <td style="padding:15px">Yes</td>
1190
1008
  </tr>
1191
1009
  <tr>
1192
1010
  <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>
1011
+ <td style="padding:15px">updateAcmeAuthentication</td>
1195
1012
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}?{query}</td>
1196
1013
  <td style="padding:15px">Yes</td>
1197
1014
  </tr>
1198
1015
  <tr>
1199
1016
  <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>
1017
+ <td style="padding:15px">disableAcmeAuthentication</td>
1202
1018
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/disable?{query}</td>
1203
1019
  <td style="padding:15px">Yes</td>
1204
1020
  </tr>
1205
1021
  <tr>
1206
1022
  <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>
1023
+ <td style="padding:15px">enableAcmeAuthentication</td>
1209
1024
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/enable?{query}</td>
1210
1025
  <td style="padding:15px">Yes</td>
1211
1026
  </tr>
1212
1027
  <tr>
1213
1028
  <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>
1029
+ <td style="padding:15px">deleteAcmeAuthentication</td>
1216
1030
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/delete?{query}</td>
1217
1031
  <td style="padding:15px">Yes</td>
1218
1032
  </tr>
1219
1033
  <tr>
1220
1034
  <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>
1035
+ <td style="padding:15px">restoreAcmeAuthentication</td>
1223
1036
  <td style="padding:15px">{base_path}/{version}/api/v1/acme-authentication/{pathv1}/undelete?{query}</td>
1224
1037
  <td style="padding:15px">Yes</td>
1225
1038
  </tr>
1226
1039
  <tr>
1227
1040
  <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>
1041
+ <td style="padding:15px">batchCSREnroll</td>
1232
1042
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll?{query}</td>
1233
1043
  <td style="padding:15px">Yes</td>
1234
1044
  </tr>
1235
1045
  <tr>
1236
1046
  <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>
1047
+ <td style="padding:15px">batchEnrollWithKeyGen</td>
1240
1048
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll-key-gen?{query}</td>
1241
1049
  <td style="padding:15px">Yes</td>
1242
1050
  </tr>
1243
1051
  <tr>
1244
1052
  <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>
1053
+ <td style="padding:15px">batchEnrollWithKeyGenMac</td>
1249
1054
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll-key-gen-mac?{query}</td>
1250
1055
  <td style="padding:15px">Yes</td>
1251
1056
  </tr>
1252
1057
  <tr>
1253
1058
  <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>
1059
+ <td style="padding:15px">listBatchJobs</td>
1256
1060
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll?{query}</td>
1257
1061
  <td style="padding:15px">Yes</td>
1258
1062
  </tr>
1259
1063
  <tr>
1260
1064
  <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>
1065
+ <td style="padding:15px">getBatchJobSettings</td>
1262
1066
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}?{query}</td>
1263
1067
  <td style="padding:15px">Yes</td>
1264
1068
  </tr>
1265
1069
  <tr>
1266
1070
  <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>
1071
+ <td style="padding:15px">updateBatchJobSettings</td>
1269
1072
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}?{query}</td>
1270
1073
  <td style="padding:15px">Yes</td>
1271
1074
  </tr>
1272
1075
  <tr>
1273
1076
  <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>
1077
+ <td style="padding:15px">regenerateBatchJobPasscode</td>
1278
1078
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/regenerate-passcode?{query}</td>
1279
1079
  <td style="padding:15px">Yes</td>
1280
1080
  </tr>
1281
1081
  <tr>
1282
1082
  <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>
1083
+ <td style="padding:15px">approveJob</td>
1285
1084
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/approve?{query}</td>
1286
1085
  <td style="padding:15px">Yes</td>
1287
1086
  </tr>
1288
1087
  <tr>
1289
1088
  <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>
1089
+ <td style="padding:15px">rejectJob</td>
1292
1090
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/reject?{query}</td>
1293
1091
  <td style="padding:15px">Yes</td>
1294
1092
  </tr>
1295
1093
  <tr>
1296
1094
  <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>
1095
+ <td style="padding:15px">downloadReport</td>
1299
1096
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-report?{query}</td>
1300
1097
  <td style="padding:15px">Yes</td>
1301
1098
  </tr>
1302
1099
  <tr>
1303
1100
  <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>
1101
+ <td style="padding:15px">downloadCertificates</td>
1316
1102
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-certificates?{query}</td>
1317
1103
  <td style="padding:15px">Yes</td>
1318
1104
  </tr>
1319
1105
  <tr>
1320
1106
  <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>
1107
+ <td style="padding:15px">deleteDownloadUrls</td>
1323
1108
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/delete-download-urls?{query}</td>
1324
1109
  <td style="padding:15px">Yes</td>
1325
1110
  </tr>
1326
1111
  <tr>
1327
1112
  <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>
1113
+ <td style="padding:15px">resendDownloadUrls</td>
1330
1114
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/resend-download-urls?{query}</td>
1331
1115
  <td style="padding:15px">Yes</td>
1332
1116
  </tr>
1333
1117
  <tr>
1334
1118
  <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>
1119
+ <td style="padding:15px">batchEnrollExternal</td>
1340
1120
  <td style="padding:15px">{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/external-batch-enroll?{query}</td>
1341
1121
  <td style="padding:15px">Yes</td>
1342
1122
  </tr>
1343
1123
  <tr>
1344
1124
  <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>
1125
+ <td style="padding:15px">downloadMapping</td>
1349
1126
  <td style="padding:15px">{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-mapping?{query}</td>
1350
1127
  <td style="padding:15px">Yes</td>
1351
1128
  </tr>
1352
1129
  <tr>
1353
1130
  <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>
1131
+ <td style="padding:15px">downloadByJobIdAndUniqueId</td>
1356
1132
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/unique-identifier/{pathv2}/format/{pathv3}?{query}</td>
1357
1133
  <td style="padding:15px">Yes</td>
1358
1134
  </tr>
1359
1135
  <tr>
1360
1136
  <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>
1137
+ <td style="padding:15px">downloadByCommonName</td>
1365
1138
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/common-name/{pathv1}/format/{pathv2}?{query}</td>
1366
1139
  <td style="padding:15px">Yes</td>
1367
1140
  </tr>
1368
1141
  <tr>
1369
1142
  <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>
1143
+ <td style="padding:15px">downloadByJobIdAndCommonName</td>
1374
1144
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/common-name/{pathv2}/format/{pathv3}?{query}</td>
1375
1145
  <td style="padding:15px">Yes</td>
1376
1146
  </tr>
1377
1147
  <tr>
1378
1148
  <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>
1149
+ <td style="padding:15px">downloadByCertificateValue</td>
1383
1150
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/certificate-value/{pathv1}/format/{pathv2}?{query}</td>
1384
1151
  <td style="padding:15px">Yes</td>
1385
1152
  </tr>
1386
1153
  <tr>
1387
1154
  <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>
1155
+ <td style="padding:15px">downloadByJobIdAndCertificateValue</td>
1392
1156
  <td style="padding:15px">{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/certificate-value/{pathv2}/format/{pathv3}?{query}</td>
1393
1157
  <td style="padding:15px">Yes</td>
1394
1158
  </tr>
1395
1159
  <tr>
1396
1160
  <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>
1161
+ <td style="padding:15px">createDeviceProfile</td>
1401
1162
  <td style="padding:15px">{base_path}/{version}/api/v1/device-profile?{query}</td>
1402
1163
  <td style="padding:15px">Yes</td>
1403
1164
  </tr>
1404
1165
  <tr>
1405
1166
  <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>
1167
+ <td style="padding:15px">List device profiles</td>
1408
1168
  <td style="padding:15px">{base_path}/{version}/api/v1/device-profile?{query}</td>
1409
1169
  <td style="padding:15px">Yes</td>
1410
1170
  </tr>
1411
1171
  <tr>
1412
1172
  <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>
1173
+ <td style="padding:15px">getDeviceProfile</td>
1415
1174
  <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}?{query}</td>
1416
1175
  <td style="padding:15px">Yes</td>
1417
1176
  </tr>
1418
1177
  <tr>
1419
1178
  <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>
1179
+ <td style="padding:15px">updateDeviceProfile</td>
1422
1180
  <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}?{query}</td>
1423
1181
  <td style="padding:15px">Yes</td>
1424
1182
  </tr>
1425
1183
  <tr>
1426
1184
  <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>
1185
+ <td style="padding:15px">deleteDeviceProfile</td>
1429
1186
  <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}/delete?{query}</td>
1430
1187
  <td style="padding:15px">Yes</td>
1431
1188
  </tr>
1432
1189
  <tr>
1433
1190
  <td style="padding:15px">restoreDeviceProfile(deviceProfileId, callback)</td>
1434
- <td style="padding:15px">Use this endpoint to restore a deleted device profile.
1435
- </td>
1191
+ <td style="padding:15px">restoreDeviceProfile</td>
1436
1192
  <td style="padding:15px">{base_path}/{version}/api/v1/device-profile/{pathv1}/undelete?{query}</td>
1437
1193
  <td style="padding:15px">Yes</td>
1438
1194
  </tr>
1439
1195
  <tr>
1440
1196
  <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>
1197
+ <td style="padding:15px">getICA</td>
1443
1198
  <td style="padding:15px">{base_path}/{version}/api/v1/managed-ca/{pathv1}?{query}</td>
1444
1199
  <td style="padding:15px">Yes</td>
1445
1200
  </tr>
1446
1201
  <tr>
1447
1202
  <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>
1203
+ <td style="padding:15px">List ICAs</td>
1450
1204
  <td style="padding:15px">{base_path}/{version}/api/v1/managed-ca?{query}</td>
1451
1205
  <td style="padding:15px">Yes</td>
1452
1206
  </tr>
1453
1207
  <tr>
1454
1208
  <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>
1209
+ <td style="padding:15px">getGatewayDetails</td>
1456
1210
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}?{query}</td>
1457
1211
  <td style="padding:15px">Yes</td>
1458
1212
  </tr>
1459
1213
  <tr>
1460
1214
  <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>
1215
+ <td style="padding:15px">updateGateway</td>
1468
1216
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}?{query}</td>
1469
1217
  <td style="padding:15px">Yes</td>
1470
1218
  </tr>
1471
1219
  <tr>
1472
1220
  <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>
1221
+ <td style="padding:15px">listGateways</td>
1477
1222
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway?{query}</td>
1478
1223
  <td style="padding:15px">Yes</td>
1479
1224
  </tr>
1480
1225
  <tr>
1481
1226
  <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>
1227
+ <td style="padding:15px">createGateway</td>
1485
1228
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway?{query}</td>
1486
1229
  <td style="padding:15px">Yes</td>
1487
1230
  </tr>
1488
1231
  <tr>
1489
1232
  <td style="padding:15px">enableGateway(gatewayId, callback)</td>
1490
- <td style="padding:15px">Use this endpoint to enable a gateway.
1491
- </td>
1233
+ <td style="padding:15px">enableGateway</td>
1492
1234
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/enable?{query}</td>
1493
1235
  <td style="padding:15px">Yes</td>
1494
1236
  </tr>
1495
1237
  <tr>
1496
1238
  <td style="padding:15px">disableGateway(gatewayId, callback)</td>
1497
- <td style="padding:15px">Use this endpoint to disable a gateway.
1498
- </td>
1239
+ <td style="padding:15px">disableGateway</td>
1499
1240
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/disable?{query}</td>
1500
1241
  <td style="padding:15px">Yes</td>
1501
1242
  </tr>
1502
1243
  <tr>
1503
1244
  <td style="padding:15px">deleteGateway(gatewayId, callback)</td>
1504
- <td style="padding:15px">Use this endpoint to delete a gateway.
1505
- </td>
1245
+ <td style="padding:15px">deleteGateway</td>
1506
1246
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/delete?{query}</td>
1507
1247
  <td style="padding:15px">Yes</td>
1508
1248
  </tr>
1509
1249
  <tr>
1510
1250
  <td style="padding:15px">restoreGateway(gatewayId, callback)</td>
1511
- <td style="padding:15px">Use this endpoint to restore a deleted gateway.
1512
- </td>
1251
+ <td style="padding:15px">restoreGateway</td>
1513
1252
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/undelete?{query}</td>
1514
1253
  <td style="padding:15px">Yes</td>
1515
1254
  </tr>
1516
1255
  <tr>
1517
1256
  <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>
1257
+ <td style="padding:15px">downloadGatewayConfig</td>
1520
1258
  <td style="padding:15px">{base_path}/{version}/api/v1/gateway/{pathv1}/config?{query}</td>
1521
1259
  <td style="padding:15px">Yes</td>
1522
1260
  </tr>
1523
1261
  <tr>
1524
1262
  <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>
1263
+ <td style="padding:15px">listOCSPGroups</td>
1529
1264
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group?{query}</td>
1530
1265
  <td style="padding:15px">Yes</td>
1531
1266
  </tr>
1532
1267
  <tr>
1533
1268
  <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>
1269
+ <td style="padding:15px">createOCSPGroup</td>
1545
1270
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group?{query}</td>
1546
1271
  <td style="padding:15px">Yes</td>
1547
1272
  </tr>
1548
1273
  <tr>
1549
1274
  <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>
1275
+ <td style="padding:15px">getOCSPGroupDetails</td>
1552
1276
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}?{query}</td>
1553
1277
  <td style="padding:15px">Yes</td>
1554
1278
  </tr>
1555
1279
  <tr>
1556
1280
  <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>
1281
+ <td style="padding:15px">updateOCSPGroup</td>
1559
1282
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}?{query}</td>
1560
1283
  <td style="padding:15px">Yes</td>
1561
1284
  </tr>
1562
1285
  <tr>
1563
1286
  <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>
1287
+ <td style="padding:15px">deleteOCSPGroup</td>
1568
1288
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}?{query}</td>
1569
1289
  <td style="padding:15px">Yes</td>
1570
1290
  </tr>
1571
1291
  <tr>
1572
1292
  <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>
1293
+ <td style="padding:15px">addCertsOCSPGroup</td>
1581
1294
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}/add-certificates?{query}</td>
1582
1295
  <td style="padding:15px">Yes</td>
1583
1296
  </tr>
1584
1297
  <tr>
1585
1298
  <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>
1299
+ <td style="padding:15px">removeCertsOCSPGroup</td>
1588
1300
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}/remove-certificates?{query}</td>
1589
1301
  <td style="padding:15px">Yes</td>
1590
1302
  </tr>
1591
1303
  <tr>
1592
1304
  <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>
1305
+ <td style="padding:15px">listOCSPGroupCerts</td>
1597
1306
  <td style="padding:15px">{base_path}/{version}/api/v1/ocsp-group/{pathv1}/certificates?{query}</td>
1598
1307
  <td style="padding:15px">Yes</td>
1599
1308
  </tr>