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

Commit

Permalink
Update API doc to indicate sso-team-id is returned in TFE
Browse files Browse the repository at this point in the history
  • Loading branch information
@JarrettSpiker
JarrettSpiker committed Apr 11, 2022
1 parent 666db95 commit 388cfa5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions content/cloud-docs/api-docs/teams.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ $ curl \

### Sample Response

The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier.
The `sso-team-id` attribute is only returned in Terraform Enterprise 202204-1 and later, or if this team's organization is in the Terraform Cloud Business tier.

```json
{
Expand Down Expand Up @@ -146,7 +146,7 @@ Properties without a default value are required.
| --------------------------------------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `data.type` | string | | Must be `"teams"`. |
| `data.attributes.name` | string | | The name of the team, which can only include letters, numbers, `-`, and `_`. This will be used as an identifier and must be unique in the organization. |
| `data.attributes.sso-team-id` | string | (nothing) | The unique identifier of the team from the SAML `MemberOf` attribute. Only available if the team belongs to an organization in the paid Terraform Cloud Business tier. |
| `data.attributes.sso-team-id` | string | (nothing) | The unique identifier of the team from the SAML `MemberOf` attribute. Only available in Terraform Enterprise 202204-1 and later, or if the team belongs to an organization in the paid Terraform Cloud Business tier. |
| `data.attributes.organization-access` | object | (nothing) | Settings for the team's organization access. This object can include `manage-policies`, `manage-policy-overrides`, `manage-workspaces`, `manage-vcs-settings`, `manage-providers`, and `manage-modules` properties with boolean values. All properties default to `false`. |
| `data.attributes.visibility` **(beta)** | string | `"secret"` | The team's visibility. Must be `"secret"` or `"organization"` (visible). |

Expand Down Expand Up @@ -180,7 +180,7 @@ $ curl \

### Sample Response

The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier.
The `sso-team-id` attribute is only returned in Terraform Enterprise 202204-1 and later, or if this team's organization is in the Terraform Cloud Business tier.

```json
{
Expand Down Expand Up @@ -243,7 +243,7 @@ $ curl \

### Sample Response

The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier.
The `sso-team-id` attribute is only returned in Terraform Enterprise 202204-1 and later, or if this team's organization is in the Terraform Cloud Business tier.

```json
{
Expand Down Expand Up @@ -312,7 +312,7 @@ Properties without a default value are required.
| --------------------------------------- | ------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `data.type` | string | | Must be `"teams"`. |
| `data.attributes.name` | string | (previous value) | The name of the team, which can only include letters, numbers, `-`, and `_`. This will be used as an identifier and must be unique in the organization. |
| `data.attributes.sso-team-id` | string | (previous value) | The unique identifier of the team from the SAML `MemberOf` attribute. Only available if the team belongs to an organization in the paid Terraform Cloud Business tier. |
| `data.attributes.sso-team-id` | string | (previous value) | The unique identifier of the team from the SAML `MemberOf` attribute. Only available in Terraform Enterprise 202204-1 and later, or if the team belongs to an organization in the paid Terraform Cloud Business tier. |
| `data.attributes.organization-access` | object | (previous value) | Settings for the team's organization access. This object can include `manage-policies`, `manage-policy-overrides`, `manage-workspaces`, `manage-vcs-settings`, `manage-providers`, and `manage-modules` properties with boolean values. All properties default to `false`. |
| `data.attributes.visibility` **(beta)** | string | (previous value) | The team's visibility. Must be `"secret"` or `"organization"` (visible). |

Expand Down Expand Up @@ -345,7 +345,7 @@ $ curl \

### Sample Response

The `sso-team-id` attribute is only returned if this team's organization is in the Terraform Cloud Business tier.
The `sso-team-id` attribute is only returned in Terraform Enterprise 202204-1 and later, or if this team's organization is in the Terraform Cloud Business tier.

```json
{
Expand Down

0 comments on commit 388cfa5

Please sign in to comment.