Skip to content

Commit c9bdcb3

Browse files
committed
changes after review
1 parent 1045098 commit c9bdcb3

File tree

2 files changed

+32
-42
lines changed

2 files changed

+32
-42
lines changed

articles/iot-central/core/howto-manage-devices-with-rest-api.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ ms.date: 06/22/2022
77
ms.topic: how-to
88
ms.service: iot-central
99
services: iot-central
10-
zone_pivot_groups: enrollment-group
1110

1211
---
1312

@@ -550,17 +549,19 @@ The response to this request looks like the following example:
550549

551550
## Enrollment groups
552551

553-
Enrollment groups are used to manage the device authentication options in your IoT Central application. To learn more, see [Device authentication concepts in IoT Central](concepts-device-authentication.md)
552+
Enrollment groups are used to manage the device authentication options in your IoT Central application. To learn more, see [Device authentication concepts in IoT Central](concepts-device-authentication.md).
554553

555554
To learn how to create and manage enrollment groups in the UI, see [How to connect devices with X.509 certificates to IoT Central Application](how-to-connect-devices-x509.md).
556555

557-
## Add enrollment groups
556+
## Create an enrollment group
558557

559-
:::zone pivot="enrollment-group-x509"
558+
### [X.509](#tab/X.509)
559+
560+
When you create an enrollment group for devices that use X.509 certificates, you first need to upload the root or intermediate certificate to your IoT Central application.
560561

561562
### Generate root and device certificates
562563

563-
In this section, you use an X.509 certificate to connect a device with a certificate derived from the IoT Central enrollment group's certificate.
564+
In this section, you generate the X.509 certificates you need to connect a device to IoT Central.
564565

565566
> [!WARNING]
566567
> This way of generating X.509 certs is for testing only. For a production environment you should use your official, secure mechanism for certificate generation.
@@ -586,14 +587,14 @@ These commands produce the following root and the device certificate
586587
587588
| filename | contents |
588589
| -------- | -------- |
589-
| mytestrootcert_cert.pem | The public portion of the root X509 certificate |
590-
| mytestrootcert_key.pem | The private key for the root X509 certificate |
591-
| mytestrootcert_fullchain.pem | The entire keychain for the root X509 certificate. |
592-
| mytestrootcert.pfx | The PFX file for the root X509 certificate. |
593-
| sampleDevice01_cert.pem | The public portion of the device X509 certificate |
594-
| sampleDevice01_key.pem | The private key for the device X509 certificate |
595-
| sampleDevice01_fullchain.pem | The entire keychain for the device X509 certificate. |
596-
| sampleDevice01.pfx | The PFX file for the device X509 certificate. |
590+
| mytestrootcert_cert.pem | The public portion of the root X.509 certificate |
591+
| mytestrootcert_key.pem | The private key for the root X.509 certificate |
592+
| mytestrootcert_fullchain.pem | The entire keychain for the root X.509 certificate. |
593+
| mytestrootcert.pfx | The PFX file for the root X.509 certificate. |
594+
| sampleDevice01_cert.pem | The public portion of the device X.509 certificate |
595+
| sampleDevice01_key.pem | The private key for the device X.509 certificate |
596+
| sampleDevice01_fullchain.pem | The entire keychain for the device X.509 certificate. |
597+
| sampleDevice01.pfx | The PFX file for the device X.509 certificate. |
597598
598599
Make a note of the location of these files. You need it later.
599600
@@ -662,7 +663,7 @@ The response to this request looks like the following example:
662663
}
663664
```
664665

665-
### Add a X.509 certificate to an enrollment group
666+
### Add an X.509 certificate to an enrollment group
666667

667668
Use the following request to set the primary X.509 certificate of the myx509eg enrollment group:
668669

@@ -674,7 +675,7 @@ PUT https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/myx509
674675

675676
Use this request to add either a primary or secondary X.509 certificate to the enrollment group.
676677

677-
The following example shows a request body that adds a X.509 certificate to an enrollment group:
678+
The following example shows a request body that adds an X.509 certificate to an enrollment group:
678679

679680
```json
680681
{
@@ -700,7 +701,7 @@ The response to this request looks like the following example:
700701

701702
### Generate verification code for an X.509 certificate
702703

703-
Use the following request to generate a verification code for the primary or secondary X509 certificate of an enrollment group.
704+
Use the following request to generate a verification code for the primary or secondary X.509 certificate of an enrollment group.
704705

705706
If you set `verified` to `false` in the previous request, use the following request to generate a verification code for the primary X.509 certificate in the `myx509eg` enrollment group:
706707

@@ -739,10 +740,10 @@ Make a note of the base-64 encoded version of the certifcate. You need it later.
739740
Use the following request to verify the primary X.509 certificate of the `myx509eg` enrollment group by providing the certificate with the signed verification code:
740741

741742
```http
742-
POST https://{subdomain}.{baseDomain}/api/enrollmentGroups/{enrollmentGroupId}/certificates/{entry}/verify?api-version=2022-07-31
743+
POST PUT https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/myx509eg/certificates/primary/verify?api-version=2022-07-31
743744
```
744745

745-
The following example shows a request body that verifys a X509 certificate:
746+
The following example shows a request body that verifies an X.509 certificate:
746747

747748
```json
748749
{
@@ -752,10 +753,10 @@ The following example shows a request body that verifys a X509 certificate:
752753

753754
### Get X.509 certificate of an enrollment group
754755

755-
Use the following request to retrieve details of X509 certificate of an enrollment group from your application:
756+
Use the following request to retrieve details of X.509 certificate of an enrollment group from your application:
756757

757758
```http
758-
GET https://{subdomain}.{baseDomain}/api/enrollmentGroups/{enrollmentGroupId}/certificates/{entry}?api-version=2022-07-31
759+
GET https://{your app subdomain}/api/enrollmentGroups/myx509eg/certificates/primary?api-version=2022-07-31
759760
```
760761

761762
The response to this request looks like the following example:
@@ -770,17 +771,15 @@ The response to this request looks like the following example:
770771
}
771772
```
772773

773-
### Delete a X.509 certificate from an enrollment group
774+
### Delete an X.509 certificate from an enrollment group
774775

775776
Use the following request to delete the primary X.509 certificate from an enrollment group with ID `myx509eg`:
776777

777778
```http
778779
DELETE https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/myx509eg/certificates/primary?api-version=2022-07-31
779780
```
780781

781-
:::zone-end
782-
783-
:::zone pivot="enrollment-group-symmetrickey"
782+
### [Symmetric Key](#tab/SymmetricKey)
784783

785784
### Add an symmetric key enrollment group
786785

@@ -822,21 +821,21 @@ The response to this request looks like the following example:
822821
}
823822
```
824823

825-
:::zone-end
824+
IoT Central generates the primary and secondary syymetric keys when you make this api call.
826825

827826
### Get an enrollment group
828827

829-
Use the following request to retrieve details of an enrollment group from your application:
828+
Use the following request to retrieve details of an enrollment group with `mysymmetric` as the ID:
830829

831830
```http
832-
GET https://{subdomain}.{baseDomain}/api/enrollmentGroups/{enrollmentGroupId}?api-version=2022-07-31
831+
GET https://{your app subdomain}/api/enrollmentGroups/mysymmetric?api-version=2022-07-31
833832
```
834833

835834
The response to this request looks like the following example:
836835

837836
```json
838837
{
839-
"id": "enrollmentGroupId",
838+
"id": "mysymmetric",
840839
"displayName": "My group",
841840
"enabled": true,
842841
"type": "iot",
@@ -856,7 +855,7 @@ The response to this request looks like the following example:
856855
Use the following request to update an enrollment group.
857856

858857
```http
859-
PATCH https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/mysampleeg?api-version=2022-07-31
858+
PATCH https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/myx509eg?api-version=2022-07-31
860859
```
861860

862861
The following example shows a request body that updates the display name of a enrollment group:
@@ -888,18 +887,18 @@ The response to this request looks like the following example:
888887

889888
### Delete an enrollment group
890889

891-
Use the following request to delete an enrollment group with ID `mysampleeg`:
890+
Use the following request to delete an enrollment group with ID `myx509eg`:
892891

893892
```http
894-
DELETE https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/mysampleeg?api-version=2022-07-31
893+
DELETE https://{your app subdomain}.azureiotcentral.com/api/enrollmentGroups/myx509eg?api-version=2022-07-31
895894
```
896895

897896
### List enrollment groups
898897

899898
Use the following request to retrive a list of enrollment groups from your application:
900899

901900
```http
902-
GET https://{subdomain}.{baseDomain}/api/enrollmentGroups?api-version=2022-07-31
901+
GET https://{your app subdomain}/api/enrollmentGroups?api-version=2022-07-31
903902
```
904903

905904
The response to this request looks like the following example:

articles/zone-pivot-groups.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -254,16 +254,7 @@ groups:
254254
- id: programming-language-python
255255
title: Python
256256
- id: programming-language-embedded-c
257-
title: Embedded C
258-
- id: enrollment-group
259-
# Owner: v-krishnag
260-
title: Enrollment groups
261-
prompt: Choose an enrollment-group
262-
pivots:
263-
- id: enrollment-group-x509
264-
title: X.509
265-
- id: enrollment-group-symmetrickey
266-
title: Symmetric Key
257+
title: Embedded C
267258
- id: programming-languages-set-twenty-eight
268259
# Owner: aahi
269260
title: Programming languages

0 commit comments

Comments
 (0)