Skip to content

Commit 54c4be7

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #25684 from microsoftgraph/iot/device-prov-apis
Unhiding devices and device template api docs
2 parents 3b539d0 + 9cb6d00 commit 54c4be7

File tree

42 files changed

+2124
-16
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2124
-16
lines changed

‎api-reference/beta/api/certificateauthoritypath-list-mutualtlsoauthconfigurations.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: "List mutualTlsOauthConfigurations"
3+
description: "Get a list of the available mutualTlsOauthConfiguration resources."
4+
author: "sofia-geislinger"
5+
ms.date: 12/31/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# List mutualTlsOauthConfigurations
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Get a list of the available [mutualTlsOauthConfiguration](../resources/mutualtlsoauthconfiguration.md) resources.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "certificateauthoritypath-list-mutualtlsoauthconfigurations-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/certificateauthoritypath-list-mutualtlsoauthconfigurations-permissions.md)]
29+
30+
[!INCLUDE [rbac-mtlsoauthconfig-apis](../includes/rbac-for-apis/rbac-mtlsoauthconfig-apis.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
``` http
39+
GET /certificateAuthorities/mutualTlsOauthConfigurations
40+
```
41+
42+
## Optional query parameters
43+
44+
This method supports the `$count`, `$filter`, and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
45+
46+
## Request headers
47+
48+
|Name|Description|
49+
|:---|:---|
50+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
51+
52+
## Request body
53+
54+
Don't supply a request body for this method.
55+
56+
## Response
57+
58+
If successful, this method returns a `200 OK` response code and a collection of [mutualTlsOauthConfiguration](../resources/mutualtlsoauthconfiguration.md) objects in the response body.
59+
60+
For more information, see [Microsoft Graph error responses and resource types](/graph/errors).
61+
62+
## Examples
63+
64+
### Request
65+
66+
The following example shows a request.
67+
<!-- {
68+
"blockType": "request",
69+
"name": "certificateauthoritypath-list-mutualtlsoauthconfigurations-permissions"
70+
}
71+
-->
72+
73+
```http
74+
GET https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations
75+
```
76+
77+
### Response
78+
79+
The following example shows the response.
80+
>**Note:** The response object shown here might be shortened for readability.
81+
<!-- {
82+
"blockType": "response",
83+
"truncated": true,
84+
"@odata.type": "Collection(microsoft.graph.mutualTlsOauthConfiguration)"
85+
}
86+
-->
87+
``` http
88+
HTTP/1.1 200 OK
89+
Content-Type: application/json
90+
91+
{
92+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations",
93+
"value": [
94+
{
95+
"id": "a7199212-950f-4a2d-ba1e-017c48da1d19",
96+
"deletedDateTime": null,
97+
"displayName": "Standard TLS cert config",
98+
"tlsClientAuthParameter": "tls_client_auth_san_uri",
99+
"certificateAuthorities": [
100+
{
101+
"@odata.type": "microsoft.graph.certificateAuthority"
102+
}
103+
]
104+
}
105+
]
106+
}
107+
```

‎api-reference/beta/api/certificateauthoritypath-post-mutualtlsoauthconfigurations.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: "Create mutualTlsOauthConfiguration"
3+
description: "Create a mutualTlsOauthConfiguration resource that contains a specified certificate authority object."
4+
author: "sofia-geislinger"
5+
ms.date: 12/31/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# Create mutualTlsOauthConfiguration
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Create a [mutualTlsOauthConfiguration](../resources/mutualtlsoauthconfiguration.md) resource that contains a specified certificate authority object.
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "certificateauthoritypath-post-mutualtlsoauthconfigurations-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/certificateauthoritypath-post-mutualtlsoauthconfigurations-permissions.md)]
29+
30+
[!INCLUDE [rbac-mtlsoauthconfig-apis](../includes/rbac-for-apis/rbac-mtlsoauthconfig-apis.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
39+
``` http
40+
POST /directory/certificateAuthorities/mutualTlsOauthConfigurations
41+
```
42+
43+
## Request headers
44+
45+
|Name|Description|
46+
|:---|:---|
47+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
48+
|Content-Type|application/json. Required.|
49+
50+
## Request body
51+
52+
In the request body, supply a JSON representation of the [mutualTlsOauthConfiguration](../resources/mutualtlsoauthconfiguration.md) object.
53+
54+
You can specify the following properties when you create a **mutualTlsOauthConfiguration**.
55+
56+
|Property|Type|Description|
57+
|:---|:---|:---|
58+
|certificateAuthority|[certificateAuthority](../resources/certificateauthority.md) collection | Multi-value property that represents a list of trusted certificate authorities. Optional. |
59+
|displayName|String|Friendly name. Optional. |
60+
|tlsClientAuthParameter| tlsClientRegistrationMetadata | Specifies which field in the certificate contains the subject ID. The possible values are: `tls_client_auth_subject_dn`, `tls_client_auth_san_dns`, `tls_client_auth_san_uri`, `tls_client_auth_san_ip`, `tls_client_auth_san_email`, `unknownFutureValue`. Required. Read-only. |
61+
62+
## Response
63+
64+
If successful, this method returns a `201 Created` response code and a [mutualTlsOauthConfiguration](../resources/mutualtlsoauthconfiguration.md) object in the response body. If a validation failure occurs during the certificate validation steps, the method returns a `400 Bad Request` along with the error message, `Invalid value specified for property 'certificate' of resource 'CertificateAuthorityInformation'.`.
65+
66+
For more information, see [Microsoft Graph error responses and resource types](/graph/errors).
67+
68+
## Examples
69+
70+
### Request
71+
72+
The following example shows a request.
73+
<!-- {
74+
"blockType": "request",
75+
"name": "create_mutualtlsoauthconfiguration_from_"
76+
}
77+
-->
78+
79+
```http
80+
POST https://graph.microsoft.com/beta/directory/certificateAuthorities/mutualTlsOauthConfigurations
81+
Content-Type: application/json
82+
83+
{
84+
"displayName": "DoorCamera_Model_X_TrustedCAs",
85+
"tlsClientAuthParameter": "tls_client_auth_san_uri",
86+
"certificateAuthorities": [
87+
{
88+
"@odata.type": "microsoft.graph.certificateAuthority"
89+
}
90+
]
91+
}
92+
```
93+
94+
95+
### Response
96+
97+
The following example shows the response.
98+
>**Note:** The response object shown here might be shortened for readability.
99+
<!-- {
100+
"blockType": "response",
101+
"truncated": true,
102+
"@odata.type": "microsoft.graph.mutualTlsOauthConfiguration"
103+
}
104+
-->
105+
``` http
106+
HTTP/1.1 201 Created
107+
Content-Type: application/json
108+
109+
{
110+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/certificateAuthorities/mutualTlsOauthConfigurations/$entity",
111+
"id":"eec5ba11-2fc0-4113-83a2-ed986ed13cdb",
112+
"displayName": "DoorCamera_Model_X_TrustedCAs",
113+
"tlsClientAuthParameter": "tls_client_auth_san_uri",
114+
"certificateAuthorities": [
115+
{
116+
"@odata.type": "microsoft.graph.certificateAuthority"
117+
}
118+
]
119+
}
120+
```

‎api-reference/beta/api/device-update.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "sandeo-MSFT"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-directory-management"
77
doc_type: apiPageType
8-
ms.date: 10/25/2024
8+
ms.date: 12/31/2024
99
---
1010

1111
# Update device
@@ -50,11 +50,12 @@ In the request body, supply the values for the [device](../resources/device.md)
5050
| Property | Type |Description|
5151
|:---------------|:--------|:----------|
5252
|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers with at least the *Cloud Device Administrator* role can update this property. |
53-
|operatingSystem|String|The type of operating system on the device.|
54-
|operatingSystemVersion|String|The version of the operating system on the device|
53+
|alternativeNames|String collection|List of alternative names for the device, for example, `resourceIds`.|
5554
|displayName|String|The display name for the device.|
5655
|isCompliant|Boolean|`true` if the device complies with Mobile Device Management (MDM) policies; otherwise, `false`. This can only be updated by Intune for any device OS type or by an [approved MDM app](/windows/client-management/mdm/azure-active-directory-integration-with-mdm) for Windows OS devices. |
5756
|isManaged|Boolean|`true` if the device is managed by a Mobile Device Management (MDM) app; otherwise, `false`. This can only be updated by Intune for any device OS type or by an [approved MDM app](/windows/client-management/mdm/azure-active-directory-integration-with-mdm) for Windows OS devices. |
57+
|operatingSystem|String|The type of operating system on the device.|
58+
|operatingSystemVersion|String|The version of the operating system on the device.|
5859

5960
Since the **device** resource supports [extensions](/graph/extensibility-overview), you can use the `PATCH` operation to
6061
add, update, or delete your own app-specific data in custom properties of an extension in an existing **device** instance.

‎api-reference/beta/api/devicetemplate-createdevicefromtemplate.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
title: "deviceTemplate: createDeviceFromTemplate"
3+
description: "Create a new device from a device template."
4+
author: "atastrophic"
5+
ms.date: 12/31/2024
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-id"
8+
doc_type: apiPageType
9+
---
10+
11+
# deviceTemplate: createDeviceFromTemplate
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Create a new [device](../resources/device.md) from a [deviceTemplate](../resources/devicetemplate.md).
18+
19+
## Permissions
20+
21+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
22+
23+
<!-- {
24+
"blockType": "permissions",
25+
"name": "devicetemplate-createdevicefromtemplate-permissions"
26+
}
27+
-->
28+
[!INCLUDE [permissions-table](../includes/permissions/devicetemplate-createdevicefromtemplate-permissions.md)]
29+
30+
[!INCLUDE [rbac-devicestemplate-apis](../includes/rbac-for-apis/rbac-devicetemplate-apis.md)]
31+
> **Note:** Users must be owner of the object.
32+
33+
## HTTP request
34+
35+
<!-- {
36+
"blockType": "ignored"
37+
}
38+
-->
39+
``` http
40+
POST /directory/templates/deviceTemplates/{deviceTemplateId}/createDeviceFromTemplate
41+
```
42+
43+
## Request headers
44+
45+
|Name|Description|
46+
|:---|:---|
47+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
48+
|Content-Type|application/json. Required.|
49+
50+
## Request body
51+
52+
In the request body, supply a JSON representation of the parameters.
53+
54+
The following table lists the parameters that you can use when you call this action.
55+
56+
|Parameter|Type|Description|
57+
|:---|:---|:---|
58+
| accountEnabled | Boolean | `true` if the account is enabled; otherwise, `false`. The default value is `true`. A disabled device can't authenticate with Microsoft Entra ID. Optional.|
59+
| alternativeNames | String collection | A collection of ARM resource IDs associated with the device, if any. Optional. |
60+
| externalDeviceId | String | UUID of the device by IoT registry. Must be unique within a tenant. Required. |
61+
| externalSourceName | String | Identifies the source name of the device. Optional. |
62+
| keyCredential | [keyCredential](../resources/keycredential.md) | The key credential when you use self-signed certificates. Optional. |
63+
| operatingSystemVersion | String | The operating system version of the device specified. Optional. |
64+
65+
## Response
66+
67+
If successful, this action returns a `200 OK` response code and a [device](../resources/device.md) object in the response body.
68+
69+
For more information, see [Microsoft Graph error responses and resource types](/graph/errors).
70+
71+
## Examples
72+
73+
### Request
74+
75+
The following example shows a request.
76+
<!-- {
77+
"blockType": "request",
78+
"name": "devicetemplatethis.createdevicefromtemplate"
79+
}
80+
-->
81+
``` http
82+
POST https://graph.microsoft.com/beta/templates/deviceTemplates/2d62b12a-0163-457d-9796-9602e9807e1/createDeviceFromTemplate
83+
Content-Type: application/json
84+
85+
{
86+
"externalDeviceId": "2fa9424e-7ab0-4a22-8c90-2a20d15d8183",
87+
"operatingSystemVersion": "Ubuntu 18.04",
88+
"externalSourceName": "unknown",
89+
"accountEnabled": false,
90+
"alternativeNames": [
91+
"/subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourcegroups/testrg/providers/microsoft.deviceregistry/assets/asset1"
92+
]
93+
}
94+
```
95+
96+
### Response
97+
98+
The following example shows the response.
99+
>**Note:** The response object shown here might be shortened for readability.
100+
<!-- {
101+
"blockType": "response",
102+
"truncated": true,
103+
"@odata.type": "microsoft.graph.device"
104+
}
105+
-->
106+
``` http
107+
HTTP/1.1 200 OK
108+
Content-Type: application/json
109+
110+
{
111+
"id": "06d59f74-dbf3-432a-9971-c5f60374e4f0",
112+
"accountEnabled": false,
113+
"alternativeNames": [
114+
"/subscriptions/00001111-aaaa-2222-bbbb-3333cccc4444/resourcegroups/testrg/providers/microsoft.deviceregistry/assets/asset1"
115+
],
116+
"deviceId": "c6ca2657-8685-4398-9edc-a6a603f177b3",
117+
"displayName": "2fa9424e-7ab0-4a22-8c90-2a20d15d8183",
118+
"externalSourceName": "unknown",
119+
"manufacturer": "IoT Device Template Manufacturer",
120+
"model": "IoT Device Template Model",
121+
"operatingSystem": "WindowsIoT",
122+
"operatingSystemVersion": "Ubuntu 18.04",
123+
"physicalIds": [
124+
"[EXTID]:2fa9424e-7ab0-4a22-8c90-2a20d15d8183"
125+
],
126+
"profileType": "IoT",
127+
"sourceType": "External",
128+
"alternativeSecurityIds": [
129+
{
130+
"type": 2,
131+
"identityProvider": null,
132+
"key": "WAA1ADAAOQA6ADwAVQB..."
133+
}
134+
]
135+
}
136+
```

0 commit comments

Comments
 (0)