> For the complete documentation index, see [llms.txt](/llms.txt). Every page on this site is also available as markdown at `<path>.md`.

# Tenant

Tenant identity value used by `RuntimeSpec`.

<span id="flowai_harness.tenant.define_tenant"></span>

## `define_tenant`

`define_tenant(tenant: 'str | Mapping[str, Any] | TenantIdentity | None' = None, /, version: 'str | None' = None, *, resource_id: 'str | None' = None, **kwargs: 'Any') -> 'TenantIdentity'`

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>tenant</code></td>
<td><code>str | Mapping[str, Any] | TenantIdentity | None</code></td>
<td><code>None</code></td>
</tr>
<tr>
<td><code>version</code></td>
<td><code>str | None</code></td>
<td><code>None</code></td>
</tr>
<tr>
<td><code>resource_id</code></td>
<td><code>str | None</code></td>
<td><code>None</code></td>
</tr>
<tr>
<td><code>kwargs</code></td>
<td><code>Any</code></td>
<td>required</td>
</tr>
</tbody>
</table>

<p><strong>Returns:</strong> <code>TenantIdentity</code></p>

Create a validated Flow AI tenant identity.

Accepts ``define_tenant("acme", "v1")``, a mapping, an existing
``TenantIdentity``, or keyword arguments.

Args:
    tenant: Positional resource id string, mapping of tenant fields, or
        an existing ``TenantIdentity`` to copy from.
    version: Tenant configuration version label, e.g. ``"v1"``.
    resource_id: Keyword override for the tenant resource id.
    **kwargs: Additional fields merged into the validated payload.

Returns:
    A frozen, validated ``TenantIdentity``.

Raises:
    pydantic.ValidationError: If ``resource_id`` or ``version`` is
        missing or empty.

<span id="flowai_harness.tenant.TenantIdentity"></span>

## `TenantIdentity`

`TenantIdentity(*, resourceId: Annotated[str, MinLen(min_length=1)], version: Annotated[str, MinLen(min_length=1)]) -> None`

<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>resourceId</code></td>
<td><code>typing.Annotated</code></td>
<td>required</td>
</tr>
<tr>
<td><code>version</code></td>
<td><code>typing.Annotated</code></td>
<td>required</td>
</tr>
</tbody>
</table>

<p><strong>Returns:</strong> <code>None</code></p>

Runtime tenant identity aligned with `agent_fw_core::TenantId`.