Add docs for sso-team-id to the Teams API #2210
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/hashicorp/terraform-website/CiHAsdK6YoEp1riZGT4GQQCTgctf |
@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. |
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.
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!
e474b25
to
75d51d1
Compare
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.
Approved with a few final nits :-) If you add those in, you have my support to merge! 🚀
576f1c3
to
0e6adac
Compare
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
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.
thank you! a little correction for flow and then I approve :-)
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 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 :/ |
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 |
d12e34d
to
68c96df
Compare
68c96df
to
d49d2d7
Compare
@laurapacilio, @JarrettSpiker do you think it's safe to merge this change? |
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.
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!
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
content/cloud-docs/users-teams-organizations/single-sign-on/index.mdx
Outdated
Show resolved
Hide resolved
d7d8a48
to
a323f3a
Compare
a323f3a
to
d85fb73
Compare
…e can be configured
d85fb73
to
cc20cee
Compare
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 newfunctionality 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 organizationwith 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