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

Commit

Permalink
Call out that sso-team-ids are only applicable to business tier orgs
Browse files Browse the repository at this point in the history
  • Loading branch information
JarrettSpiker committed Mar 30, 2022
1 parent 5cba1ee commit 75d51d1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions content/cloud-docs/api-docs/teams.mdx
Expand Up @@ -38,8 +38,6 @@ page_title: Teams - API Docs - Terraform Cloud and Terraform Enterprise

-> **Note:** Team management is a paid feature, available as part of the **Team** upgrade package. Single sign-on is also a paid feature, available as part of the **Business** upgrade package. Refer to [Terraform Cloud pricing](https://www.hashicorp.com/products/terraform/pricing) for details.

-> **Note:** Single sign-on is a paid feature, available as part of the **Business** upgrade package. [Learn more about Terraform Cloud pricing here](https://www.hashicorp.com/products/terraform/pricing).

The Teams API is used to create, edit, and destroy teams as well as manage a team's organization-level permissions. The [Team Membership API](/cloud-docs/api-docs/team-members) is used to add or remove users from a team. Use the [Team Access API](/cloud-docs/api-docs/team-access) to associate a team with privileges on an individual workspace.

Any member of an organization can view visible teams and any secret teams they are a member of. Only organization owners can modify teams or view the full set of secret teams. The organization token and the owners team token can act as an owner on these endpoints. ([More about permissions.](/cloud-docs/users-teams-organizations/permissions))
Expand Down Expand Up @@ -79,6 +77,8 @@ $ curl \

### Sample Response

_The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier._

```json
{
"data": [
Expand Down Expand Up @@ -180,6 +180,8 @@ $ curl \

### Sample Response

_The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier._

```json
{
"data": {
Expand Down Expand Up @@ -241,6 +243,8 @@ $ curl \

### Sample Response

_The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier._

```json
{
"data": {
Expand Down Expand Up @@ -341,6 +345,8 @@ $ curl \

### Sample Response

_The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier._

```json
{
"data": {
Expand Down
Expand Up @@ -67,7 +67,7 @@ Terraform Cloud can automatically add users to teams based on their SAML asserti

If the SAML assertion includes a `MemberOf` attribute, users logging in via SSO are automatically added to the teams included in their assertion and removed from any teams that _aren't_ included in their assertion. This overrides any manually set team memberships; whenever the user logs in, their team membership is adjusted to match their SAML assertion.

Any team names that don't match existing teams are ignored; Terraform Cloud will not automatically create new teams. Terraform Cloud expects the team names in the `MemberOf` SAML attribute to exactly match its own team names. This match is case sensitive. It is not possible to assign users to the `owners` team through this attribute.
Any team names that don't match existing teams are ignored; Terraform Cloud will not automatically create new teams. Terraform Cloud expects the team names in the `MemberOf` SAML attribute to exactly match its own team names or SSO team IDs. This match is case sensitive. It is not possible to assign users to the `owners` team through this attribute.

If the `MemberOf` attribute is not provided, users are assigned to a default team named `sso` and are not removed from any existing teams.

Expand Down

0 comments on commit 75d51d1

Please sign in to comment.