Skip to main content
Version: 2.0.0

updateTenant

Updates the tenant.

Parameters​

tenant_id - The id of the tenant. This can also be the tenant key.
tenant - 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.

{
    "name": "name",
    "description": "description",
    "attributes": {}
}

Implementation​

response = await permit.api.update_tenant(
    tenant_id,
    tenant
)