Manage scopes

Scopes group Boundary resources. You can update the name or description of an org or project scope, or delete a scope and the resources it contains.

When Terraform manages a scope, update or delete it in Terraform. Making the same change in the Admin UI or CLI can cause the next Terraform plan to report drift.

Requirements

You have a role with permission to update or delete the scope. Refer to Resource tables and Manage access with roles.
You have logged in to Boundary when you use the Admin UI or CLI.
You have configured the Terraform Boundary provider when you use Terraform.

Update a scope

You can update the name or description of an existing org or project scope.

Complete the following steps to update a scope:

Select whether you want to update an org scope or a project scope:

Log in to Boundary.
Select Orgs in the navigation pane, and then select the org scope that you want to update.
Select Org Settings in the navigation pane.
Click Edit Form.
Update the Name or Description fields.
Click Save.

Log in to Boundary.
Run the scopes update command with the scope ID and the values you want to change:
```
$ boundary scopes update \
    -id ORG_SCOPE_ID \
    -name "operations" \
    -description "Org scope for the operations team"
```
Replace ORG_SCOPE_ID with a project scope ID when you update a project scope. You can also use the -primary-auth-method-id option to set the scope's primary auth method.
Confirm that the scope reflects the updated values.

For the full set of supported options, refer to scopes update.

Use the following steps for an org scope or a project scope:

Update the name or description attribute in the existing boundary_scope resource:

resource "boundary_scope" "project" {
  name        = "operations"
  description = "Project scope for shared operations systems"
  scope_id    = boundary_scope.org.id
}

Review the proposed in-place update:
```
$ terraform plan
```
Apply the change:
```
$ terraform apply
```

Terraform updates the scope in place.

Delete a scope

Warning

Deleting a scope also deletes the resources it contains, including nested scopes and their resources. This operation cannot be undone. Review the scope and its resources before you delete it.

You cannot delete the global scope.

Complete the following steps to delete an org or project scope:

Select whether you want to delete an org scope or a project scope:

Log in to Boundary.
Select Orgs in the navigation pane, and then select the org scope that you want to delete.
Select Org Settings in the navigation pane.
Click Manage, and then select Delete.
Click Delete to confirm.

Log in to Boundary.
Run the scopes delete command with the scope ID:
```
$ boundary scopes delete -id PROJECT_SCOPE_ID
```
Replace PROJECT_SCOPE_ID with an org scope ID when you delete an org scope.
Confirm that Boundary no longer lists the scope.

For the full command reference, refer to scopes delete.

More information

To learn more about scope types and their relationships, refer to Scopes.
To view all scope commands, refer to the CLI scopes topic.
For more information about managing scopes using Terraform, refer to the Boundary provider documentation for scopes.

Next steps

To create an org or project scope, refer to Create scopes to group resources.
To manage permissions within a scope, refer to Manage access with roles.