Azure / azure-iot-sdk-node

A Node.js SDK for connecting devices to Microsoft Azure IoT services
https://docs.microsoft.com/en-us/azure/iot-hub/
Other
261 stars 227 forks source link

[API Docs issue] provisioning service client group enrollment by symmetric key #873

Closed elhorton closed 4 years ago

elhorton commented 4 years ago

------------------------------- delete below -------------------------------

INSTRUCTIONS

Please follow the instructions and template below to save us time requesting additional information from you. For more information on all of your support options, please see Azure IoT support and help options.

If this is an issue encountered by following a Microsoft document, please open an issue on that page itself. This ensures the fastest targeted response, and you can do this by scrolling all the way down to the bottom of the page to the Feedback section to report the issue.

  1. Search existing issues to avoid creating duplicates.

  2. If possible test using the latest release to make sure your issues has not already been fixed.

  3. Do not share information from your Azure subscription here (connection strings, service names (IoT Hub name, Device Provisioning Service scope ID), etc...). If you need to share any of this information, you can create a ticket and get assistance from Microsoft Support.

  4. Include enough information for us to address the bug:

    • A detailed description.
    • A Minimal Complete Reproducible Example. This is code we can cut and paste into a readily available sample and run, or a link to a project you've written that we can compile to reproduce the bug.
    • Console logs.
  5. Delete these instructions before submitting the bug.

Below is a generic bug report format. We recommend you use it as a template and replace the information below each header with your own.

------------------------------- delete above -------------------------------

Context

Description of the issue

The docs for the EnrollmentGroup show that the attestation property “currently this MUST be x509.” However, its show the type is AttestationMechanism, and if you click through, the AttestationMechanism] object has a symmetricKey property. The documentation for the type property shows “will be set to a string either tpm or x509.” These docs are erroneous as group enrollment by symmetric key is possible with the Node SDK.

FIX: Update API reference docs for the EnrollmentGroup and type parameter of the AttestationMechanism object

AB#7923337