OKTA-577368: add new fields to device profile object #4182
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -217,7 +217,7 @@ None | |
| | Parameter | Type | Description | | ||
| | -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- | | ||
| | `search` | String | Searches for devices with a supported [filtering](/docs/reference/core-okta-api/#filter) expression for most properties | | ||
| | `limit` | Number | Specifies the number of results returned (recomended `20`) | | ||
| | `after` | String | Specifies the pagination cursor for the next page of devices | | ||
| | `expand=user` | String | Lists associated users for the device in `_embedded` element | | ||
|
|
||
|
|
@@ -526,6 +526,7 @@ curl -v -X GET \ | |
| "users":[ | ||
| { | ||
| "managementStatus": "MANAGED", | ||
| "screenLockType": "BIOMETRIC", | ||
| "created":"2021-10-01T16:52:41.000Z", | ||
| "user":{ | ||
| "id":"${userId}", | ||
|
|
@@ -639,6 +640,7 @@ curl -v -X GET \ | |
| { | ||
| "created":"2021-08-20T17:13:35.000Z", | ||
| "managementStatus":"NOT_MANAGED", | ||
| "screenLockType":"BIOMETRIC", | ||
| "user":{ | ||
| "id":"00u17vh0q8ov8IU881d7", | ||
| "status":"ACTIVE", | ||
|
|
@@ -1151,23 +1153,37 @@ The following diagram shows the state object for a Device: | |
|
|
||
| #### Device profile properties | ||
|
|
||
| | Property | Type | Description | Applicable Platforms | | ||
| | :----------------------- | :--------- | :-----------------------------------------------------------------------------------------------------------------| :---------------------------| | ||
| | `displayName` | String | The display name of the device (max 255 chars) | All | | ||
| | `platform` | Enum | OS platform of the device. Possible values: `MACOS`, `WINDOWS`, `ANDROID`, `IOS`. | All | | ||
| | `registered` | Boolean | Indicates if the device is registered at Okta | All | | ||
| | `diskEncryptionType` | Enum | (Optional) The type of disk encryption on the device. See [Possible values for `diskEncryptionType`](#possible-values-for-diskencryptiontype) | All | | ||
| | `imei` | String | (Optional) International Mobile Equipment Identity of the device (15-17 numeric chars) | All | | ||
| | `integrityJailbreak` | Boolean | (Optional) Indicates if the device is jailbroken or rooted | `IOS` and `ANDROID` | | ||
| | `manufacturer` | String | (Optional) Name of the manufacturer of the device (0-127 chars) | All | | ||
| | `meid` | String | (Optional) Mobile equipment identifier of the device (14 characters) | All | | ||
| | `model` | String | (Optional) Model of the device (127 characters) | All | | ||
| | `osVersion` | String | (Optional) Version of the device OS (127 characters) | All | | ||
| | `serialNumber` | String | (Optional) Serial number of the device (127 characters) | All | | ||
| | `sid` | String | (Optional) Windows Security identifier of the device (256 characters) | All | | ||
| | `udid` | String | (Optional) macOS Unique Device identifier (47 characters) | All | | ||
| | `tpmPublicKeyHash` | String | (Optional) Windows Trusted Platform Module hash value | All | | ||
| | `secureHardwarePresent` | Boolean | (Optional) Indicates if the device contains a secure hardware functionality | All | | ||
|
|
||
| ##### Possible values for `diskEncryptionType` | ||
|
|
||
| | Value | Description | Applicable Platforms | | ||
| | :-------------------------- | :--------------------------------------------------------| :---------------------------| | ||
| | `NONE` | No encryption has been set | All | | ||
| | `FULL` | Disk is fully encrypted | `IOS` and `ANDROID` | | ||
| | `USER` | Encryption key is tied to the user or profile | `ANDROID` | | ||
| | `ALL_INTERNAL_VOLUMES` | All internal disks are encrypted | `WINDOWS` and `MACOS` | | ||
| | `SYSTEM_VOLUME` | Only the system volume is encrypted | `WINDOWS` and `MACOS` | | ||
|
|
||
| **Note:** The following values map to Disk Encryption ON (otherwise OFF): `FULL`, `USER`, `ALL_INTERNAL_VOLUMES` | ||
|
|
||
| #### Device profile examples | ||
|
|
||
| ```json | ||
| { | ||
|
|
@@ -1182,9 +1198,32 @@ The following diagram shows the state object for a Device: | |
| "meid": null, | ||
| "udid": "36A56558-1793-5B3A-8362-ECBAA14EDD2D", | ||
| "sid": null, | ||
| "tpmPublicKeyHash": null, | ||
| "registered": true, | ||
| "secureHardwarePresent": false, | ||
| "diskEncryptionType": null | ||
|
There was a problem hiding this comment. Is There was a problem hiding this comment. I assumed it was, however, that is a good question. @apoorvadeshpande-okta could you confirm? There was a problem hiding this comment. Usually |
||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```json | ||
|
There was a problem hiding this comment. Do we need 2 examples if the only difference is that the second one has There was a problem hiding this comment. We could, but one is a device profile for MACOS and another is IOS. iOS can have different properties so wanted to express that in an example. There was a problem hiding this comment. Thoughts? |
||
| { | ||
| "profile": { | ||
| "displayName": "Bob - New Device", | ||
| "platform": "IOS", | ||
| "manufacturer": "Apple Inc.", | ||
| "model": "iPhone 13 Pro Max", | ||
| "osVersion": "15.1.1", | ||
| "serialNumber": "C02VW333HTDF", | ||
| "imei": null, | ||
| "meid": null, | ||
| "udid": "36A56558-1793-5B3A-8362-ECBAA14EDD2D", | ||
| "sid": null, | ||
| "tpmPublicKeyHash": null, | ||
| "registered": true, | ||
| "secureHardwarePresent": false, | ||
| "diskEncryptionType": "FULL", | ||
| "integrityJailbreak": false | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please add a section here for the possible values for
ScreenLockType, similar todiskEncryptionType?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can add that, however I wasn't clear where to add them. There is no "possible value" description for
managementStatuseither.Should I add them both in this page and appended it to the Response description where it says the description returns an array of users? or should I add it to the user object here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. Please don't update the user object.
Feel free to add
managementStatuspossible values as wellSuggesting the new header as
Device - User attributesfor these properties