Skip to content

Commit b5d3b2b

Browse files
chrisclare-oktachrisclare-okta
committed
OKTA-577368: add new fields to device profile object
1 parent b1db65c commit b5d3b2b

File tree

1 file changed

+58
-20
lines changed
  • packages/@okta/vuepress-site/docs/reference/api/devices

1 file changed

+58
-20
lines changed

‎packages/@okta/vuepress-site/docs/reference/api/devices/index.md‎

Lines changed: 58 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,23 +1151,37 @@ The following diagram shows the state object for a Device:
11511151

11521152
#### Device profile properties
11531153

1154-
| Property | Type | Description |
1155-
| :----------------- | :--------- | :---------------------------------------------------------------------------------------------|
1156-
| `displayName` | String | The display name of the device (from 1 through 255 characters) |
1157-
| `platform` | String | OS platform of the device. Possible values: `MACOS`, `WINDOWS`, `ANDROID`, `IOS`. |
1158-
| `registered` | Boolean | Indicates if the device is registered at Okta |
1159-
| `imei` | String | (Optional) International Mobile Equipment Identity of the device (from 15 through 17 numeric characters) |
1160-
| `manufacturer` | String | (Optional) Name of the manufacturer of the device (from 0 through 127 characters) |
1161-
| `meid` | String | (Optional) Mobile equipment identifier of the device (14 characters) |
1162-
| `model` | String | (Optional) Model of the device (127 characters) |
1163-
| `osVersion` | String | (Optional) Version of the device OS (127 characters) |
1164-
| `serialNumber` | String | (Optional) Serial number of the device (127 characters) |
1165-
| `sid` | String | (Optional) Windows Security identifier of the device (256 characters) |
1166-
| `udid` | String | (Optional) macOS Unique Device identifier (47 characters) |
1167-
| `tpmPublicKeyHash` | String | (Optional) Windows Trusted Platform Module hash value |
1168-
| `secureHardwarePresent` | Boolean | (Optional) Indicates if the device contains a secure hardware functionality |
1169-
1170-
#### Device profile example
1154+
| Property | Type | Description | Applicable Platforms |
1155+
| :----------------------- | :--------- | :-----------------------------------------------------------------------------------------------------------------| :---------------------------|
1156+
| `displayName` | String | The display name of the device (from 1 through 255 characters) | All |
1157+
| `platform` | Enum | OS platform of the device. Possible values: `MACOS`, `WINDOWS`, `ANDROID`, `IOS`. | All |
1158+
| `registered` | Boolean | Indicates if the device is registered at Okta | All |
1159+
| `diskEncryptionType` | Enum | (Optional) The type of disk encryption on the device. [Possible Values for `diskEncryptionType`](#possible-values-for-diskencryptiontype) | All |
1160+
| `imei` | String | (Optional) International Mobile Equipment Identity of the device (from 15 through 17 numeric characters) | All |
1161+
| `integrityJailbreak` | Boolean | (Optional) Indicates if the device is jailbroken or rooted | `IOS` and `ANDROID` |
1162+
| `manufacturer` | String | (Optional) Name of the manufacturer of the device (from 0 through 127 characters) | All |
1163+
| `meid` | String | (Optional) Mobile equipment identifier of the device (14 characters) | All |
1164+
| `model` | String | (Optional) Model of the device (127 characters) | All |
1165+
| `osVersion` | String | (Optional) Version of the device OS (127 characters) | All |
1166+
| `serialNumber` | String | (Optional) Serial number of the device (127 characters) | All |
1167+
| `sid` | String | (Optional) Windows Security identifier of the device (256 characters) | All |
1168+
| `udid` | String | (Optional) macOS Unique Device identifier (47 characters) | All |
1169+
| `tpmPublicKeyHash` | String | (Optional) Windows Trusted Platform Module hash value | All |
1170+
| `secureHardwarePresent` | Boolean | (Optional) Indicates if the device contains a secure hardware functionality | All |
1171+
1172+
##### Possible Values for `diskEncryptionType`
1173+
1174+
| Value | Description | Applicable Platforms |
1175+
| :-------------------------- | :--------------------------------------------------------| :---------------------------|
1176+
| `NONE` | No encryption has been set | All |
1177+
| `FULL` | Disk is fully encrypted | `IOS` and `ANDROID` |
1178+
| `USER` | Encryption key is tied to the user or profile | `ANDROID` |
1179+
| `ALL_INTERNAL_VOLUMES` | All internal disks are encrypted | `WINDOWS` and `MACOS` |
1180+
| `SYSTEM_VOLUME` | Only the system volume is encrypted | `WINDOWS` and `MACOS` |
1181+
1182+
**Note:** The following values map to Disk Encryption ON (otherwise OFF): `FULL`, `USER`, `ALL_INTERNAL_VOLUMES`
1183+
1184+
#### Device profile examples
11711185

11721186
```json
11731187
{
@@ -1182,9 +1196,33 @@ The following diagram shows the state object for a Device:
11821196
"meid": null,
11831197
"udid": "36A56558-1793-5B3A-8362-ECBAA14EDD2D",
11841198
"sid": null,
1185-
"tpmPublicKeyHash":null,
1186-
"registered":true,
1187-
"secureHardwarePresent":false
1199+
"tpmPublicKeyHash": null,
1200+
"registered": true,
1201+
"secureHardwarePresent": false,
1202+
"diskEncryptionType": null
1203+
}
1204+
}
1205+
```
1206+
1207+
```json
1208+
{
1209+
"profile": {
1210+
"displayName": "Bob - New Device",
1211+
"platform": "IOS",
1212+
"manufacturer": "Apple Inc.",
1213+
"model": "iPhone 13 Pro Max",
1214+
"osVersion": "15.1.1",
1215+
"serialNumber": "C02VW333HTDF",
1216+
"imei": null,
1217+
"integrityJailbreak": ,
1218+
"meid": null,
1219+
"udid": "36A56558-1793-5B3A-8362-ECBAA14EDD2D",
1220+
"sid": null,
1221+
"tpmPublicKeyHash": null,
1222+
"registered": true,
1223+
"secureHardwarePresent": false,
1224+
"diskEncryptionType": "FULL",
1225+
"integrityJailbreak": false
11881226
}
11891227
}
11901228
```

0 commit comments

Comments
 (0)