Description
A tenant is one customer or site that your projects are deployed to. This lists the tenants of a workspace, sorted by name, each with its tags.
Archived tenants are left out unless you ask for them. Deleted tenants are never returned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
workspaceId |
query | string | yes | ID of the workspace. |
includeArchived |
query | boolean | no | Set to true to include archived tenants. Defaults to false. |
Errors
| Status | Meaning |
|---|---|
400 |
Invalid workspaceId. |
401 |
Missing or invalid Basic auth credentials, or the service account lacks permission to manage tenants in this workspace. |