[Fundamentals] Added User Groups docs #22596
Conversation
|
Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment. We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally. PR Change SummaryAdded documentation for User Groups Beta, enhancing user management capabilities.
Modified Files
Added Files
How can I customize these reviews?Check out the Hyperlint AI Reviewer docs for more information on how to customize the review. If you just want to ignore it on this PR, you can add the Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add |
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
|
||
| 1. Get an access token | ||
|
|
||
| Get an Entra access token. Note that the example below is using the Azure CLI. |
There was a problem hiding this comment.
[blocking, suggestion] Do we want to provide another blurb, warning, or caveat notice that these instructions are for Entra specifically? Should we also produce equivalent steps for other IdP integrations? Should we create some new sections that categorize our IdP specific guidance within these docs?
There was a problem hiding this comment.
Yep, totally happy to add in additional info that will make this as clear as we can to users.
I definitely think we should create equivalent sections if it makes sense.
Also, something to consider: if this page page may grow to include multiple IdP integrations over time, would it also be easier to consume as a user if we had a page devoted to Microsoft Provisioning and a separate for Okta? I feel like this page is on the verge of being a lot to scroll through. Thoughts?
There was a problem hiding this comment.
yeah, IMO we should have (newly created) separate dedicated pages for detailed instructions for Microsoft and Okta, similar to what ZT developer docs have for SSO integration IdPs. If we do this, we can still keep this page as an introduction and overview and maybe use something like a table to list IdPs we support and link out to the dedicated pages?
That said, I think the "Automate Entra via API" section is probably more of a reference implementation. So:
- Yes from me to dedicated pages per IdP. Cleaner structure, keeps pages smaller, and scales nicely.
- We should adjust (or remove) the Entra specific "automate" instructions to make it very clear that they are more of a reference implementation. Given how much IdP setups can vary, steering users towards Microsoft docs is probably a better bet.
| ``` | ||
| 2. Create a new application via template. | ||
|
|
||
| The template ID 8adf8e6e-67b2-4cf2-a259-e3dc5476c621 is the suggested template to create non-gallery apps in the Entra docs. Replace `<accessToken>` and `displayName` with your values. |
There was a problem hiding this comment.
[non-blocking, suggestion] Should this link to the guidance in the Microsoft documentation in the event it is updated or deeper understanding is desirable by the customer?
There was a problem hiding this comment.
I'm a fan of linking out to Microsoft docs in areas like that were there's the potential for their docs to update/change.
There was a problem hiding this comment.
I'm also a fan of linking out but for whatever it's worth in my experience with Entra SCIM docs is that they are dense and there is a lot of clicking around to find what I want. Mentioning this because in order to find this template ID I had to read multiple documents and fail a few times to sort out what the right ID was.
Echoing myself on an above comment: The Entra automation instructions are more of a reference implementation that could change.
src/content/docs/fundamentals/setup/manage-members/user-groups.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/fundamentals/setup/manage-members/user-groups.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/fundamentals/setup/manage-members/user-groups.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/fundamentals/setup/manage-members/user-groups.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| </TabItem> </Tabs> | ||
|
|
||
| ## Create a User Group with SCIM |
There was a problem hiding this comment.
Might consider a bit explaining that SCIM-managed groups have certain settings that can't be changed through either the Dashboard or the API:
- name
- members
- group delete
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
|
CI run failed: build logs |
| - Test and save after updating the config. | ||
| - Provisioning after configuration is complete | ||
|
|
||
| ## Expected behaviors |
There was a problem hiding this comment.
[suggestion, non-blocking] Consider moving this up to index.mdx for the SCIM overview, the Dash vs. IdP actions described here are generic rather than provider-specific and it would be valuable information for any SCIM customer.
|
@bnelz @mcescalante @steve-thousand Please leave feedback/review the new PR at #22766. Fundamentals had some major updates and this PR is pretty behind, and I'd love to save everyone from reviewing a wild PR because I caught it up with production. I'll be closing this one in favor of the new one. Thanks! |
4 participants
Added new docs for User Groups Beta. Addresses PCX-17480.