-
Notifications
You must be signed in to change notification settings - Fork 593
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OKTA-577368: add new fields to device profile object #4182
base: master
Are you sure you want to change the base?
Conversation
Acrolinx score DRAFT 06.01.22A 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.
|
b2f24ca
to
b5d3b2b
Compare
Acrolinx score DRAFT 06.01.22A 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.
|
Acrolinx score DRAFT 06.01.22A 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.
|
Acrolinx score DRAFT 06.01.22A 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.
|
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.
LGTM. Can you please also ask @vanngo-okta to review it. Thank you.
"tpmPublicKeyHash": null, | ||
"registered": true, | ||
"secureHardwarePresent": false, | ||
"diskEncryptionType": null |
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.
Is null
an acceptable value for diskEncryptionType
? It's not defined in the table
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 assumed it was, however, that is a good question. @apoorvadeshpande-okta could you confirm?
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.
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
Outdated
Show resolved
Hide resolved
} | ||
``` | ||
|
||
```json |
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.
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?
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts?
packages/@okta/vuepress-site/docs/reference/api/devices/index.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/reference/api/devices/index.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/reference/api/devices/index.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/reference/api/devices/index.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/reference/api/devices/index.md
Outdated
Show resolved
Hide resolved
Acrolinx score DRAFT 06.01.22A 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.
|
@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? |
"tpmPublicKeyHash": null, | ||
"registered": true, | ||
"secureHardwarePresent": false, | ||
"diskEncryptionType": null |
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.
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
| `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` | ||
|
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 to diskEncryptionType
?
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 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
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 managementStatus
possible values as well
Suggesting the new header as Device - User attributes
for these properties
Acrolinx score DRAFT 06.01.22A 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.
|
Oas3 change for this documentation: https://github.com/atko-eng/okta-oas3/pull/538 @brentschaus-okta @vanngo-okta. Thanks! |
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:
Device.Profile.Properties.Update.mov
Update maximum 200 to recommended 20
![Screen Shot 2023-06-06 at 10 48 26 AM](https://private-user-images.githubusercontent.com/97486608/243770138-744348b5-e41e-40f3-b75c-299153cf2bb8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ1ODIyODYsIm5iZiI6MTcyNDU4MTk4NiwicGF0aCI6Ii85NzQ4NjYwOC8yNDM3NzAxMzgtNzQ0MzQ4YjUtZTQxZS00MGYzLWI3NWMtMjk5MTUzY2YyYmI4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI1VDEwMzMwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWM1ZjNjMmZkOWQ0ZjUyYWQ1MTIyN2I2Y2E3ODlkMzcwMzBkYzI1MjdmNjE2OTVjMTFjNzQ3NzcyYzdiN2U3ZWMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.ZUu6iV2ahtb9TXmlj9EiiDgdEZ66YU5QtzKvRNd7-UM)
Added screenLockType
![Screen Shot 2023-06-06 at 10 49 27 AM](https://private-user-images.githubusercontent.com/97486608/243770182-811ad561-97d5-48ac-a141-f4343eec4337.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ1ODIyODYsIm5iZiI6MTcyNDU4MTk4NiwicGF0aCI6Ii85NzQ4NjYwOC8yNDM3NzAxODItODExYWQ1NjEtOTdkNS00OGFjLWExNDEtZjQzNDNlZWM0MzM3LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI1VDEwMzMwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWM1OWFiY2NmN2YwMTg4NDBiMDEzMjMyNWRkYjhhYjA5YWFhOTg1MzdkNjRkNmNiM2QzYzc2NzJjZGY5MTdjYWUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.V7aby6f2nuNIl2EH9xSol6aUry-qNGRzq7ukLJG0w0A)
Added screenLockType
![Screen Shot 2023-06-06 at 10 49 56 AM](https://private-user-images.githubusercontent.com/97486608/243770217-c32d5a92-1f4b-44ab-8b29-140231d753d8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ1ODIyODYsIm5iZiI6MTcyNDU4MTk4NiwicGF0aCI6Ii85NzQ4NjYwOC8yNDM3NzAyMTctYzMyZDVhOTItMWY0Yi00NGFiLThiMjktMTQwMjMxZDc1M2Q4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI1VDEwMzMwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ3MGU4NzIxYTJhOTY2ZjA3ZTQ4ZDcyODM2YzBmYmJhODA1YTExYjQ0ZmNlMjJkMGNlYjkyZjM2OTY2YmFkMTcmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.QfD_SSq6gWLx2Sp_UbN-AcM9tRgWIJKPOQ3eColJNTE)
Resolves: