Manage alias suffixes

When you create an alias in a project scope, you must also create suffixes for the project and the containing org scope. Suffixes provide scope administrators with granular control over the resources in their scopes. They also allow you to reuse alias values across scopes because the suffix makes them globally unique values.

You can edit or delete existing suffixes.

Permissions

You must have write permissions for a scope to create, edit, or delete a suffix in that scope. Any user who has the * all action grant for a scope can set or remove aliases.

If you want to configure a new role to manage suffixes, use the following commands to create a new role with the required grants.

For a specified org:

$ boundary roles create -scope-id global -name "org-alias-suffix-manager" \

boundary roles add-grants -id $ROLE_ID \
  -grant "ids=$ORG_ID; type=scope;actions=set-alias-suffix,remove-alias-suffix"

boundary roles add-principals -id "ROLE_ID" \
  -principal "$USER_ID"

For a specified project:

$ boundary roles create -scope-id $ORG_ID -name "project-alias-suffix-manager" \

boundary roles add-grants -id $ROLE_ID \
  -grant "ids=$PROJECT_ID; type=scope;actions=set-alias-suffix,remove-alias-suffix"

boundary roles add-principals -id "$ROLE_ID" \
  -principal "$USER_ID"

Edit a suffix value

You can edit a suffix value. When you change a suffix value, existing aliases continue to use the old suffix, while new aliases use the updated suffix. If you update an existing alias, it will use the new suffix going forward.

Complete the following steps to edit a suffix:

Select whether you want to edit a suffix for an org or project scope:

Log in to Boundary.
Select Orgs in the navigation pane, and then select the org scope.
Select Org Settings in the navigation pane.
Click the suffix, and then click Edit suffix.
In the Alias suffix field, type a unique value for the suffix.
Click Save.
Confirm the change.

Log in to Boundary.
Use the following command to edit an existing alias suffix:
```
$ boundary scopes set-alias-suffix \
    -id o_1234567890 \
    -alias-suffix org1
```
You must include the following attributes when you edit a suffix:
- -id=<string> - The ID of the org or project scope for which you want to create the suffix. You can also specify the scope using the BOUNDARY_SCOPE_ID environment variable.
- -alias-suffix - Specifies the string that you want to use as the suffix to append to aliases in the designated scope or scopes. The alias-suffix can be a hostname or a DNS-like string.

Delete a suffix

You can delete a suffix if you no longer need it. Before deleting it, make sure no associated aliases are using the suffix.

Boundary prevents you from deleting a suffix if any aliases are using it. Org suffixes may be associated with aliases in projects nested under the org. You must delete any associated aliases before deleting the suffix.

Complete the following steps to delete a suffix:

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

Log in to Boundary.
Select Orgs in the navigation pane, and then select the org scope.
Select Org Settings in the navigation pane.
Click the suffix, and then click Delete suffix.
Click Delete to confirm.

Log in to Boundary.
Use the following command to delete an alias suffix:
```
$ boundary scopes remove-alias-suffix \
    -id o_1234567890 \
```
You must provide the following attribute when you delete a suffix:
- -id=<string> - The ID of the project or org scope from which you want to delete the suffix. You can also specify the scope using the BOUNDARY_SCOPE_ID environment variable.

More information

For more information about aliases, refer to Overview of aliases.