Feat: document team assignments with built-in roles (#821)

* Feat: document team assignments with built-in roles * Fix example * markup
env0 · Apr 7, 2024 · b604743 · b604743
1 parent dc3d675
commit b604743
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/env0/resource_team_environment_assignment.go b/env0/resource_team_environment_assignment.go
@@ -31,7 +31,7 @@ func resourceTeamEnvironmentAssignment() *schema.Resource {
 			},
 			"role_id": {
 				Type:             schema.TypeString,
-				Description:      "id of the assigned role",
+				Description:      "id of the assigned custom role. The following built-in roles can be passed as well: `Viewer`, `Planner`, `Deployer`, `Admin`",
 				Required:         true,
 				ValidateDiagFunc: ValidateNotEmptyString,
 			},

diff --git a/env0/resource_team_organization_assignment.go b/env0/resource_team_organization_assignment.go
@@ -27,7 +27,7 @@ func resourceTeamOrganizationAssignment() *schema.Resource {
 			},
 			"role_id": {
 				Type:             schema.TypeString,
-				Description:      "id of the assigned role",
+				Description:      "id of the assigned custom role. The following built-in roles can be passed as well: `User`, `Admin`",
 				Required:         true,
 				ValidateDiagFunc: ValidateNotEmptyString,
 			},

diff --git a/examples/resources/env0_team_environment_assignment/resource.tf b/examples/resources/env0_team_environment_assignment/resource.tf
@@ -23,8 +23,14 @@ resource "env0_custom_role" "custom_role" {
   ]
 }
 
-resource "env0_team_environment_assignment" "assignment" {
+resource "env0_team_environment_assignment" "custom_role_assignment" {
   team_id        = env0_team.team.id
   environment_id = env0_environment.environment.id
   role_id        = env0_custom_role.custom_role.id
 }
+
+resource "env0_team_environment_assignment" "builtin_role_assignment" {
+  team_id        = env0_team.team.id
+  environment_id = env0_environment.environment.id
+  role_id        = "Viewer"
+}
diff --git a/examples/resources/env0_team_organization_assignment/resource.tf b/examples/resources/env0_team_organization_assignment/resource.tf
@@ -10,7 +10,12 @@ resource "env0_custom_role" "custom_role" {
   ]
 }
 
-resource "env0_team_organization_assignment" "assignment" {
+resource "env0_team_organization_assignment" "custom_role_assignment" {
   team_id = env0_team.team.id
   role_id = env0_custom_role.custom_role.id
 }
+
+resource "env0_team_organization_assignment" "builtin_role_assignment" {
+  team_id = env0_team.team.id
+  role_id = "Admin"
+}