Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

Add docs for sso-team-id to the Teams API #2210

Merged
merged 5 commits into from Apr 11, 2022
Merged

Conversation

xlgmokha
Copy link
Contributor

@xlgmokha xlgmokha commented Mar 24, 2022

Why?

The ability to manage team membership via SAML and the MemberOf attribute is
being expanded to allow mapping teams to a unique sso-team-id. This new
functionality is available to organizations with the SSO entitlement via the
Business tier.

What?

This PR attempts to update the API documentation to show that a new field called
sso-team-id will appear in responses for teams that belong to an organization
with the appropriate entitlement. It also updates examples to show how to
create/update teams with an sso-team-id.

Screen.Recording.2022-03-24.at.15.05.18.mov

Screen Shot 2022-03-24 at 15 38 53


@vercel
Copy link

vercel bot commented Mar 24, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/hashicorp/terraform-website/CiHAsdK6YoEp1riZGT4GQQCTgctf
✅ Preview: https://terraform-website-git-xlgmokha-sso-team-id-hashicorp.vercel.app

@xlgmokha
Copy link
Contributor Author

@laurapacilio would you be able to help me with some of the wording for this change. I'm having a bit of trouble expressing that this change is only available to organizations in the business tier.

@xlgmokha xlgmokha marked this pull request as ready for review March 24, 2022 21:41
Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some initial feedback for you! Let me know if you disagree or have other ideas :-) Otherwise, I'd love to see how this looks and take another editing pass once you've made the changes. Thank you for tagging me for review!

content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a few final nits :-) If you add those in, you have my support to merge! 🚀

content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
content/cloud-docs/api-docs/teams.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you! a little correction for flow and then I approve :-)

@JarrettSpiker
Copy link
Contributor

JarrettSpiker commented Mar 31, 2022

Unfortunately, when making the TFE docs side changes for this, I noticed that the exiting TFC docs (what this review modifies) are a bit misleading. Even before the SSO Team ID changes, they say that the SAML attribute which get's mapped to team names has to be MemberOf.

In fact, the TFE docs describe the actual behaviour, which is that it is configurable https://www.terraform.io/enterprise/user-management/saml/team-membership#configuring-team-membership-mapping

So I am going to update this review (again, sorry) to be closer aligned with the TFE docs.

I hate continuing to modify a PR which has already been reviewed and approved, but unfortunately we dont want to release these website changes until we GA this feature, so there isnt much opportunity to make iterative changes :/

@laurapacilio
Copy link
Contributor

no worries - will you just let me know when its ready again?

@JarrettSpiker
Copy link
Contributor

no worries - will you just let me know when its ready again?

@laurapacilio Updated! I mostly just pulled text from the TFE page, and tweaked it to be Cloud specific

@xlgmokha
Copy link
Contributor Author

xlgmokha commented Apr 8, 2022

@laurapacilio, @JarrettSpiker do you think it's safe to merge this change?

Copy link
Contributor

@laurapacilio laurapacilio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of suggested nits for flow :) A lot of it is changing things to be active voice, but please push back on me if I've materially changed the meaning!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants