OKTA-577368: add new fields to device profile object by chrisclare-okta · Pull Request #4182 · okta/okta-developer-docs

chrisclare-okta · 2023-06-05T22:18:12Z

NOTE (from Brent): The Devices API is deprecated from VuePress. I'll manually add this content to the Redocly site (before the final, full handoff to Van). We'll likely still merge this PR into the commented-out VuePress content.

Description:

*Documented all currently available signals collected by a Device Assurance policy in the Device API’s

Device.Profile.Properties.Update.mov

Update maximum 200 to recommended 20

Added screenLockType

Resolves:

OKTA-577368

acrolinxdevdocs-okta · 2023-06-05T22:18:23Z

Acrolinx score DRAFT 06.01.22

A minimum Acrolinx Score of 40 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, ex. Correctness. Your article will be clearer and more consistent with Microsoft standards.

Article	Total score Required:70	Word and phrases (Brand, terms) Preferred: 40	Correctness (Spelling, grammar) Preferred: 40	Clarity (Readability) Preferred: 10	Inclusive language (+ accesibility) Preferred: 10
✅ packages/@okta/vuepress-site/docs/reference/api/devices/index.md	77	86	100	83	57

The results from this response were procced by the hugo-targets1.solution.acrolinx.sh Acrolinx Cloud Host.
Scorecard links by default are only good for 7 days. Link for this commit's Content Analysis Dashboard

acrolinxdevdocs-okta · 2023-06-05T22:19:48Z

Acrolinx score DRAFT 06.01.22

A minimum Acrolinx Score of 40 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, ex. Correctness. Your article will be clearer and more consistent with Microsoft standards.

Article	Total score Required:70	Word and phrases (Brand, terms) Preferred: 40	Correctness (Spelling, grammar) Preferred: 40	Clarity (Readability) Preferred: 10	Inclusive language (+ accesibility) Preferred: 10
✅ packages/@okta/vuepress-site/docs/reference/api/devices/index.md	77	86	100	83	57

The results from this response were procced by the hugo-targets1.solution.acrolinx.sh Acrolinx Cloud Host.
Scorecard links by default are only good for 7 days. Link for this commit's Content Analysis Dashboard

acrolinxdevdocs-okta · 2023-06-06T15:54:08Z

Acrolinx score DRAFT 06.01.22

A minimum Acrolinx Score of 40 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, ex. Correctness. Your article will be clearer and more consistent with Microsoft standards.

Article	Total score Required:70	Word and phrases (Brand, terms) Preferred: 40	Correctness (Spelling, grammar) Preferred: 40	Clarity (Readability) Preferred: 10	Inclusive language (+ accesibility) Preferred: 10
✅ packages/@okta/vuepress-site/docs/reference/api/devices/index.md	77	86	100	83	57

The results from this response were procced by the hugo-targets1.solution.acrolinx.sh Acrolinx Cloud Host.
Scorecard links by default are only good for 7 days. Link for this commit's Content Analysis Dashboard

acrolinxdevdocs-okta · 2023-06-06T16:47:45Z

Acrolinx score DRAFT 06.01.22

A minimum Acrolinx Score of 40 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, ex. Correctness. Your article will be clearer and more consistent with Microsoft standards.

Article	Total score Required:70	Word and phrases (Brand, terms) Preferred: 40	Correctness (Spelling, grammar) Preferred: 40	Clarity (Readability) Preferred: 10	Inclusive language (+ accesibility) Preferred: 10
✅ packages/@okta/vuepress-site/docs/reference/api/devices/index.md	77	86	96	83	57

The results from this response were procced by the hugo-targets1.solution.acrolinx.sh Acrolinx Cloud Host.
Scorecard links by default are only good for 7 days. Link for this commit's Content Analysis Dashboard

franklu-okta

LGTM. Can you please also ask @vanngo-okta to review it. Thank you.

jane-kuang-okta · 2023-06-07T00:01:35Z

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

+        "tpmPublicKeyHash": null,
+        "registered": true,
+        "secureHardwarePresent": false,
+        "diskEncryptionType": null


Is null an acceptable value for diskEncryptionType? It's not defined in the table

I assumed it was, however, that is a good question. @apoorvadeshpande-okta could you confirm?

Usually null values are not shown on the API response over http, but for the sake of an example please populate the correct value for macOS platform in this case

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

jane-kuang-okta · 2023-06-07T00:08:37Z

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

+}
+```
+
+```json


Do we need 2 examples if the only difference is that the second one has integrityJailbreak while the first one does not? Can we clump it to 1?

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.

Thoughts?

CC @brentschaus-okta

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

acrolinxdevdocs-okta · 2023-06-09T16:17:18Z

Acrolinx score DRAFT 06.01.22

A minimum Acrolinx Score of 40 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, ex. Correctness. Your article will be clearer and more consistent with Microsoft standards.

Article	Total score Required:70	Word and phrases (Brand, terms) Preferred: 40	Correctness (Spelling, grammar) Preferred: 40	Clarity (Readability) Preferred: 10	Inclusive language (+ accesibility) Preferred: 10
✅ packages/@okta/vuepress-site/docs/reference/api/devices/index.md	77	86	96	83	57

The results from this response were procced by the hugo-targets1.solution.acrolinx.sh Acrolinx Cloud Host.
Scorecard links by default are only good for 7 days. Link for this commit's Content Analysis Dashboard

chrisclare-okta · 2023-06-09T16:29:33Z

LGTM. Can you please also ask @vanngo-okta to review it. Thank you.

@franklu-okta I think @brentschaus-okta has more context to review, but if there is a good reason why you think @vanngo-okta should review let me know and I can ask him. Thoughts?

apoorvadeshpande-okta · 2023-06-09T16:28:18Z

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

+        "tpmPublicKeyHash": null,
+        "registered": true,
+        "secureHardwarePresent": false,
+        "diskEncryptionType": null


Usually null values are not shown on the API response over http, but for the sake of an example please populate the correct value for macOS platform in this case

apoorvadeshpande-okta · 2023-06-09T16:29:42Z

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

+| `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`
+


Could you please add a section here for the possible values for ScreenLockType, similar to diskEncryptionType?

I can add that, however I wasn't clear where to add them. There is no "possible value" description for managementStatus either.

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

No. Please don't update the user object.
Feel free to add managementStatus possible values as well
Suggesting the new header as Device - User attributes for these properties

acrolinxdevdocs-okta · 2023-06-09T20:08:07Z

Acrolinx score DRAFT 06.01.22

A minimum Acrolinx Score of 40 is required. The total score is an average of the subscores.

Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, ex. Correctness. Your article will be clearer and more consistent with Microsoft standards.

Article	Total score Required:70	Word and phrases (Brand, terms) Preferred: 40	Correctness (Spelling, grammar) Preferred: 40	Clarity (Readability) Preferred: 10	Inclusive language (+ accesibility) Preferred: 10
✅ packages/@okta/vuepress-site/docs/reference/api/devices/index.md	76	83	96	81	58

The results from this response were procced by the hugo-targets1.solution.acrolinx.sh Acrolinx Cloud Host.
Scorecard links by default are only good for 7 days. Link for this commit's Content Analysis Dashboard

chrisclare-okta · 2023-06-20T12:25:59Z

Oas3 change for this documentation: https://github.com/atko-eng/okta-oas3/pull/538

@brentschaus-okta @vanngo-okta.

Thanks!

chrisclare-okta requested a review from brentschaus-okta June 5, 2023 22:18

OKTA-577368: add new fields to device profile object

b5d3b2b

chrisclare-okta force-pushed the OKTA-577368_deviceProfileDoc branch from b2f24ca to b5d3b2b Compare June 5, 2023 22:19

added screenLockType to response examples

65d58d0

update limit messaging to say recommended 20 instead of max 200

454ddeb

franklu-okta approved these changes Jun 6, 2023

View reviewed changes

jane-kuang-okta reviewed Jun 7, 2023

View reviewed changes

brentschaus-okta reviewed Jun 8, 2023

View reviewed changes

packages/@okta/vuepress-site/docs/reference/api/devices/index.md Outdated Show resolved Hide resolved

brentschaus-okta reviewed Jun 8, 2023

View reviewed changes

packages/@okta/vuepress-site/docs/reference/api/devices/index.md Outdated Show resolved Hide resolved

brentschaus-okta reviewed Jun 8, 2023

View reviewed changes

packages/@okta/vuepress-site/docs/reference/api/devices/index.md Outdated Show resolved Hide resolved

brentschaus-okta reviewed Jun 8, 2023

View reviewed changes

packages/@okta/vuepress-site/docs/reference/api/devices/index.md Outdated Show resolved Hide resolved

Updating based on PR comments

13f5a85

apoorvadeshpande-okta reviewed Jun 9, 2023

View reviewed changes

Updated doc with suggestions

00c8bff

brentschaus-okta added DO NOT MERGE On Hold For features that were going to be released, but are now on hold and removed DO NOT MERGE labels Jun 15, 2023

+              }
+              ```
+              ```json

		\| `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`

Conversation

chrisclare-okta commented Jun 5, 2023 • edited by brentschaus-okta Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Resolves:

Uh oh!

acrolinxdevdocs-okta commented Jun 5, 2023

Acrolinx score DRAFT 06.01.22

Uh oh!

acrolinxdevdocs-okta commented Jun 5, 2023

Acrolinx score DRAFT 06.01.22

Uh oh!

acrolinxdevdocs-okta commented Jun 6, 2023

Acrolinx score DRAFT 06.01.22

Uh oh!

acrolinxdevdocs-okta commented Jun 6, 2023

Acrolinx score DRAFT 06.01.22

Uh oh!

franklu-okta left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisclare-okta Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

acrolinxdevdocs-okta commented Jun 9, 2023

Acrolinx score DRAFT 06.01.22

Uh oh!

chrisclare-okta commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisclare-okta Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

acrolinxdevdocs-okta commented Jun 9, 2023

Acrolinx score DRAFT 06.01.22

Uh oh!

chrisclare-okta commented Jun 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

chrisclare-okta commented Jun 5, 2023 •

edited by brentschaus-okta

Loading

chrisclare-okta Jun 9, 2023 •

edited

Loading

chrisclare-okta commented Jun 9, 2023 •

edited

Loading

chrisclare-okta Jun 9, 2023 •

edited

Loading