docs(scim): document okta integration with datahub for scim provisioning #11120
Conversation
WalkthroughThe recent changes enhance the documentation structure by creating a dedicated category for SCIM provisioning in the sidebar, improving clarity and accessibility. Additionally, a new guide has been added, detailing the integration of Okta with DataHub for SCIM provisioning, providing comprehensive steps for automating user and group management. Changes
Sequence Diagram(s)sequenceDiagram
participant Admin
participant Okta
participant DataHub
Admin->>Okta: Configure SWA App Integration
Okta->>Admin: Provide Integration Details
Admin->>Okta: Set up SCIM Configuration
Okta->>DataHub: Sync User/Group Data
DataHub->>Okta: Confirm User/Group Creation
Admin->>DataHub: Verify User Management
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
github-actions
bot
added
docs
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (5)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (5)
42-42: Consider rephrasing for clarity.Replace "only" to enhance clarity and avoid redundancy.
- Note: this app-integration will only be used for SCIM provisioning. + Note: this app-integration is exclusively for SCIM provisioning.Tools
LanguageTool
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
50-50: Remove unnecessary comma.The comma before "so that" is not needed.
- You may also want to configure the other selections as shown in the above image, so that this application isn't visible to your users. + You may also want to configure the other selections as shown in the above image so that this application isn't visible to your users.Tools
LanguageTool
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
89-89: Add a comma before "i.e."Consider adding a comma before "i.e." for better readability.
- c). Add a similar attribute for groups i.e. repeat step (b) above, but select `Attribute Type` as `Group`. + c). Add a similar attribute for groups, i.e., repeat step (b) above, but select `Attribute Type` as `Group`.Tools
LanguageTool
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
47-47: Add alt text to images.Images should have alternate text for accessibility.
<img width="70%" src="..." alt="Description of image"/>Also applies to: 57-57, 65-65, 74-74, 80-80, 95-95, 114-114
Tools
Markdownlint
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
27-29: Use consistent list style.Switch from asterisks to dashes for unordered lists to maintain consistency.
- * If the `governance-team` group is assigned... + - If the `governance-team` group is assigned...Also applies to: 60-60, 68-68, 83-87
Tools
Markdownlint
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs-website/sidebars.js (1 hunks)
- docs/managed-datahub/configuring-identity-provisioning-with-okta.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
Markdownlint
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
60-60: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
68-68: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
83-83: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
85-85: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
86-86: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
87-87: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
65-65: null
Images should have alternate text (alt text)(MD045, no-alt-text)
74-74: null
Images should have alternate text (alt text)(MD045, no-alt-text)
80-80: null
Images should have alternate text (alt text)(MD045, no-alt-text)
95-95: null
Images should have alternate text (alt text)(MD045, no-alt-text)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
docs-website/sidebars.js (1)
530-534: LGTM!The changes to the sidebar structure enhance the organization of the documentation by grouping related topics under "SCIM Provisioning."
|
|
||
| Consider the following configuration in Okta | ||
| - A group `governance-team` | ||
| - And it has two members `john` and `sid` |
There was a problem hiding this comment.
Remove repeated word.
The word "And" is repeated unnecessarily.
- - And it has two members `john` and `sid`
+ - It has two members `john` and `sid`Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - And it has two members `john` and `sid` | |
| - It has two members `john` and `sid` |
Tools
LanguageTool
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (4)
39-42: Consider rephrasing for clarity.Consider replacing 'only' with a different word to enhance clarity.
- Note: this app-integration will only be used for SCIM provisioning. + Note: this app-integration will be exclusively used for SCIM provisioning.Tools
LanguageTool
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
50-50: Remove unnecessary comma.The conjunction "so that" does not require a comma.
- You may also want to configure the other selections as shown in the above image, so that this application isn't visible to your users. + You may also want to configure the other selections as shown in the above image so that this application isn't visible to your users.Tools
LanguageTool
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
47-48: Add alt text for images.Images should have alternate text for accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/appSettingsEnableScim.png" alt="Enable SCIM provisioning settings in Okta"/>Tools
Markdownlint
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
89-89: Add comma before "i.e."Consider putting a comma before the abbreviation "i.e." for clarity.
- c). Add a similar attribute for groups i.e. repeat step (b) above, but select `Attribute Type` as `Group`. + c). Add a similar attribute for groups, i.e., repeat step (b) above, but select `Attribute Type` as `Group`.Tools
LanguageTool
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/managed-datahub/configuring-identity-provisioning-with-okta.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...lication. This guide also covers other variations such as how to assign a role to a user ...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
Markdownlint
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
83-83: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
85-85: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
86-86: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
87-87: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
65-65: null
Images should have alternate text (alt text)(MD045, no-alt-text)
74-74: null
Images should have alternate text (alt text)(MD045, no-alt-text)
80-80: null
Images should have alternate text (alt text)(MD045, no-alt-text)
95-95: null
Images should have alternate text (alt text)(MD045, no-alt-text)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (10)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (10)
1-5: Metadata and imports look good.The metadata and import statements are correctly formatted and relevant to the document.
10-16: Overview section is clear and informative.The overview provides a concise introduction to the SCIM provisioning process.
21-23: Remove repeated word.The word "And" is repeated unnecessarily.
Tools
LanguageTool
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
24-31: Example section is clear and well-structured.The example effectively illustrates the SCIM provisioning process.
Tools
Markdownlint
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
35-35: Note on roles is clear.The note accurately describes the supported roles in DataHub.
54-68: Configuration steps are clear and well-structured.The steps for configuring SCIM are logically ordered and easy to follow.
Tools
Markdownlint
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
65-65: null
Images should have alternate text (alt text)(MD045, no-alt-text)
70-99: Custom attribute configuration is clear.The instructions for adding custom attributes are clear and detailed.
Tools
LanguageTool
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
Markdownlint
83-83: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
85-85: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
86-86: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
87-87: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
74-74: null
Images should have alternate text (alt text)(MD045, no-alt-text)
80-80: null
Images should have alternate text (alt text)(MD045, no-alt-text)
95-95: null
Images should have alternate text (alt text)(MD045, no-alt-text)
91-99: User and group assignment instructions are clear.The instructions for assigning users and groups are straightforward and easy to follow.
Tools
Markdownlint
95-95: null
Images should have alternate text (alt text)(MD045, no-alt-text)
101-107: Notes on provisioning completion and user deletion are clear.The notes accurately describe the behavior of user provisioning and deletion.
109-117: Optional push group configuration is clear.The optional steps for configuring push groups are well-explained.
Tools
Markdownlint
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (6)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (6)
42-42: Consider rephrasing for clarity.Replace ‘only’ with a different word to enhance clarity.
- Note: this app-integration will only be used for SCIM provisioning. + Note: this app-integration will be exclusively used for SCIM provisioning.Tools
LanguageTool
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
50-50: Remove unnecessary comma.The conjunction “so that” does not require a comma.
- You may also want to configure the other selections as shown in the above image, so that this application isn't visible to your users. + You may also want to configure the other selections as shown in the above image so that this application isn't visible to your users.Tools
LanguageTool
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
89-89: Add a comma before "i.e."Consider adding a comma before the abbreviation “i.e.” for clarity.
- c). Add a similar attribute for groups i.e. repeat step (b) above, but select `Attribute Type` as `Group`. + c). Add a similar attribute for groups, i.e., repeat step (b) above, but select `Attribute Type` as `Group`.Tools
LanguageTool
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
107-107: Add missing preposition.Consider adding the missing preposition "to" for clarity.
- Refer the Okta documentation on [Delete (Deprovision)](https://developer.okta.com/docs/concepts/scim/#delete-deprovision) for more details. + Refer to the Okta documentation on [Delete (Deprovision)](https://developer.okta.com/docs/concepts/scim/#delete-deprovision) for more details.Tools
LanguageTool
[uncategorized] ~107-~107: Possible missing preposition found.
Context: ...n DataHub does not get deleted. Refer the Okta documentation on [Delete (Deprovis...(AI_HYDRA_LEO_MISSING_TO)
113-115: Add alt text to images.Images should have alternate text for accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/pushGroups.png" alt="Push Groups Configuration in Okta"/>Tools
Markdownlint
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
27-29: Use dashes for unordered lists.Consistent use of dashes for unordered lists is recommended for markdown documents.
- * If the `governance-team` group is assigned... - * If you remove `john` from group `governance-team`... - * If you remove `sid` from the DataHub app in Okta... + - If the `governance-team` group is assigned... + - If you remove `john` from group `governance-team`... + - If you remove `sid` from the DataHub app in Okta... - * Set value of `External name` to `roles.^[primary==true].value` - * Set value of `External namespace` to `urn:ietf:params:scim:schemas:core:2.0:User` - * Define an enumerated list of values as shown in the above image - * Mark this attribute as required - * Select `Attribute type` as `Personal` + - Set value of `External name` to `roles.^[primary==true].value` + - Set value of `External namespace` to `urn:ietf:params:scim:schemas:core:2.0:User` + - Define an enumerated list of values as shown in the above image + - Mark this attribute as required + - Select `Attribute type` as `Personal`Also applies to: 83-87
Tools
Markdownlint
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/managed-datahub/configuring-identity-provisioning-with-okta.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ... in Okta - directly or through groups - are automatically reflected in the DataHub ...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
[typographical] ~89-~89: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
[uncategorized] ~107-~107: Possible missing preposition found.
Context: ...n DataHub does not get deleted. Refer the Okta documentation on [Delete (Deprovis...(AI_HYDRA_LEO_MISSING_TO)
Markdownlint
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
83-83: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
84-84: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
85-85: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
86-86: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
87-87: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
65-65: null
Images should have alternate text (alt text)(MD045, no-alt-text)
74-74: null
Images should have alternate text (alt text)(MD045, no-alt-text)
80-80: null
Images should have alternate text (alt text)(MD045, no-alt-text)
95-95: null
Images should have alternate text (alt text)(MD045, no-alt-text)
114-114: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (3)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (3)
10-16: Overview section looks good!The introduction to SCIM provisioning and the need for an additional SWA-app-integration is clear and informative.
21-23: Remove repeated word.The word "And" is repeated unnecessarily.
Tools
LanguageTool
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
91-99: Assignment instructions are clear.The steps for assigning users and groups to the app are well-documented.
Tools
Markdownlint
95-95: null
Images should have alternate text (alt text)(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range, codebase verification and nitpick comments (8)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (8)
42-42: Consider replacing "only" for style improvement.Replacing "only" with a different word can enhance the writing style.
- this app-integration will only be used for SCIM provisioning. + this app-integration will be exclusively used for SCIM provisioning.Tools
LanguageTool
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
47-47: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/appSettingsEnableScim.png" alt="Enable SCIM provisioning in Okta app settings"/>Tools
Markdownlint
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
59-59: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/scimConfig1.png" alt="Configure DataHub-SCIM endpoint in Okta"/>Tools
Markdownlint
59-59: null
Images should have alternate text (alt text)(MD045, no-alt-text)
67-67: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/scimConfig2.png" alt="Configure 'To App' section in Okta"/>Tools
Markdownlint
67-67: null
Images should have alternate text (alt text)(MD045, no-alt-text)
76-76: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/profileEditor.png" alt="Profile Editor in Okta"/>Tools
Markdownlint
76-76: null
Images should have alternate text (alt text)(MD045, no-alt-text)
82-82: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/defineRoleAttribute.png" alt="Define role attribute in Okta"/>Tools
Markdownlint
82-82: null
Images should have alternate text (alt text)(MD045, no-alt-text)
97-97: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/assignUsersGroups.png" alt="Assign users and groups in Okta"/>Tools
Markdownlint
97-97: null
Images should have alternate text (alt text)(MD045, no-alt-text)
116-116: Add alt text to image.Consider adding alt text to the image for improved accessibility.
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/pushGroups.png" alt="Configure push groups in Okta"/>Tools
Markdownlint
116-116: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/managed-datahub/configuring-identity-provisioning-with-okta.md (1 hunks)
Additional context used
LanguageTool
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...s/apps_app_integration_wizard_swa.htm), called say,DataHub-SCIM-SWA. Note: this ap...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~42-~42: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...-SWA`. Note: this app-integration will only be used for SCIM provisioning. You woul...(ONLY_EXCLUSIVELY_STYLE)
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
[typographical] ~91-~91: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
Markdownlint
docs/managed-datahub/configuring-identity-provisioning-with-okta.md
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
85-85: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
86-86: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
87-87: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
88-88: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
89-89: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
59-59: null
Images should have alternate text (alt text)(MD045, no-alt-text)
67-67: null
Images should have alternate text (alt text)(MD045, no-alt-text)
76-76: null
Images should have alternate text (alt text)(MD045, no-alt-text)
82-82: null
Images should have alternate text (alt text)(MD045, no-alt-text)
97-97: null
Images should have alternate text (alt text)(MD045, no-alt-text)
116-116: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (2)
docs/managed-datahub/configuring-identity-provisioning-with-okta.md (2)
1-16: Introduction and Overview: Well-written.The introduction provides a clear overview of the document's purpose and prerequisites for SCIM provisioning with Okta.
21-23: Remove repeated word.The word "And" is repeated unnecessarily, which can be removed for clarity.
Tools
LanguageTool
[duplication] ~23-~23: Possible typo: you repeated a word
Context: ...e-team- And it has two membersjohnandsid- And the group has roleReader` Through SC...(ENGLISH_WORD_REPEAT_RULE)
| ## Configuring SCIM provisioning | ||
|
|
||
| ### 1. Create an SWA app integration | ||
| a). Create a new [SWA app integration](https://help.okta.com/en-us/content/topics/apps/apps_app_integration_wizard_swa.htm), called say, `DataHub-SCIM-SWA`. |
There was a problem hiding this comment.
Add a missing comma.
Consider adding a comma for clarity in the sentence structure.
- called say, `DataHub-SCIM-SWA`.
+ called, say, `DataHub-SCIM-SWA`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| a). Create a new [SWA app integration](https://help.okta.com/en-us/content/topics/apps/apps_app_integration_wizard_swa.htm), called say, `DataHub-SCIM-SWA`. | |
| a). Create a new [SWA app integration](https://help.okta.com/en-us/content/topics/apps/apps_app_integration_wizard_swa.htm), called, say, `DataHub-SCIM-SWA`. |
Tools
LanguageTool
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...s/apps_app_integration_wizard_swa.htm), called say,DataHub-SCIM-SWA. Note: this ap...(AI_HYDRA_LEO_MISSING_COMMA)
| * Mark this attribute as required | ||
| * Select `Attribute type` as `Personal` | ||
|
|
||
| c). Add a similar attribute for groups i.e. repeat step (b) above, but select `Attribute Type` as `Group`. (Specify the variable name as, say, `dataHubGroupRoles`.) |
There was a problem hiding this comment.
Add a comma before "i.e."
Consider putting a comma before the abbreviation “i.e.” for improved readability.
- for groups i.e. repeat step (b) above,
+ for groups, i.e., repeat step (b) above,Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| c). Add a similar attribute for groups i.e. repeat step (b) above, but select `Attribute Type` as `Group`. (Specify the variable name as, say, `dataHubGroupRoles`.) | |
| c). Add a similar attribute for groups, i.e., repeat step (b) above, but select `Attribute Type` as `Group`. (Specify the variable name as, say, `dataHubGroupRoles`.) |
Tools
LanguageTool
[typographical] ~91-~91: Consider putting a comma before the abbreviation “i.e.”.
Context: ...sonalc). Add a similar attribute for groups i.e. repeat step (b) above, but selectAttr...(IE_COMMA)
| <img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/scim/okta/appSettingsEnableScim.png"/> | ||
| </p> | ||
|
|
||
| You may also want to configure the other selections as shown in the above image, so that this application isn't visible to your users. |
There was a problem hiding this comment.
Remove unnecessary comma.
The conjunction “so that” does not require a comma.
- as shown in the above image, so that this application isn't visible to your users.
+ as shown in the above image so that this application isn't visible to your users.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| You may also want to configure the other selections as shown in the above image, so that this application isn't visible to your users. | |
| You may also want to configure the other selections as shown in the above image so that this application isn't visible to your users. |
Tools
LanguageTool
[typographical] ~50-~50: The conjunction “so that” does not require a comma.
Context: ...r selections as shown in the above image, so that this application isn't visible to your ...(SO_THAT_UNNECESSARY_COMMA)
Checklist
Summary by CodeRabbit
New Features
Documentation