Skip to main content
Version: 2.0.0

Update

Updates the tenant.

Parameters

ctx - The context of the request.
tenantKey - The id of the tenant. This can also be the tenant key.
tenantUpdate - An object that contains the information about the tenant. The payload is defined below.

Payload

Name - optional - A descriptive name for the tenant.
Description - optional - A longer description of the tenant.
Attributes - optional - Arbitraty tenant attributes that will be used to enforce attribute-based access control policies.

tenantUpdate := models.NewUpdateTenant()
tenantUpdate.SetName("New Tenant Name")

Implementation

tenant, err := Permit.Api.Tenants.Update(ctx, "tenant-key", *tenantUpdate)