Update Tenants

As customers change, keep their tenants in step: rename a tenant when a customer rebrands, or update a label when they move to a new plan. UpdateTenant changes a tenant’s name and labels. Updating tenants requires a partner client. The examples start from partnerClient and the tenant to update, found with List and find tenants.

How UpdateTenant treats each field

UpdateTenant has no way to change one field on its own. Each field you leave out is handled differently:

Field	Sent	Left out or empty
`visibleName`	Replaces the name	The name is kept
`labels`	Replaces all labels	All labels are removed
`policies`	Replaces all policies	Policies are kept

Labels are the one to watch: renaming a tenant without sending its labels deletes them. To keep them, send the current labels back with every update.

Update a tenant’s name and labels

Start from the current labels

Copy the tenant’s current labels, then add or change the ones you need. This example moves the customer to a new plan and adds a region.

const labels = new Map(tenant.labels.map((label) => [label.name, label.value]));
labels.set("plan", "enterprise");
labels.set("region", "eu");

labels := map[string]string{}
for _, label := range tenant.Labels {
	labels[label.Name] = label.Value
}
labels["plan"] = "enterprise"
labels["region"] = "eu"

Send the update

const { tenant: updated } = await partnerClient.tenants.updateTenant({
  tenantId: tenant.id,
  visibleName: "Customer 1 (production)",
  labels: [...labels].map(([name, value]) => ({ name, value })),
});

var newLabels []*stdlib.Label
for name, value := range labels {
	newLabels = append(newLabels, &stdlib.Label{Name: name, Value: value})
}

resp, err := partnerClient.Tenants.UpdateTenant(ctx, &iamv1beta.UpdateTenantRequest{
	TenantId:    tenant.Id,
	VisibleName: "Customer 1 (production)",
	Labels:      newLabels,
})
if err != nil {
	log.Fatal(err)
}

The response contains the updated tenant:

Output

{
  "id": "tenant_lqrj7qre0ts32",
  "createdAt": "2026-09-29T13:58:19.121800Z",
  "visibleName": "Customer 1 (production)",
  "externalAccountId": "customer-1",
  "labels": [
    { "name": "plan", "value": "enterprise" },
    { "name": "region", "value": "eu" }
  ]
}

To change only the labels, leave out visibleName. The name stays as it is.

Label rules

Label names start with a lowercase letter and can contain lowercase letters, digits, hyphens, and periods, up to 63 bytes. Values can be up to 255 bytes.

Next steps

Tenant policies

Limit what a tenant can use.

Delete tenants

Remove a tenant when a customer leaves.

Last modified on October 2, 2026

⌘I

Build with Namespace

Building Blocks

How UpdateTenant treats each field

Update a tenant’s name and labels

Start from the current labels

Send the update

Label rules

Next steps

Tenant policies

Delete tenants

​How UpdateTenant treats each field

​Update a tenant’s name and labels

Start from the current labels

Send the update

​Label rules

​Next steps

Tenant policies

Delete tenants

How UpdateTenant treats each field

Update a tenant’s name and labels

Label rules

Next steps