> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hotglue.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tenants

> hotglue CLI commands for tenants

View tenants directly from the CLI.

# Tenants List

### Description

Lists the tenants in the hotglue environment.

### Sample

```shell theme={null}
$ hotglue tenants list
```

# Tenants Delete

### Description

Deletes a tenant from hotglue (including scheduled jobs and any related jobs history/config files).

### Sample

```shell theme={null}
$ hotglue tenants delete -e prod.acme.com -u test-user
✔ Finished: Deleting tenant test-user schedules.
✔ Finished: Verifying user and authorizing.
✔ Finished: Deleting tenant test-user for environment prod.acme.com.
┌─────────────┐
│ Tenant ID   │
├─────────────┤
│ test-user   │
└─────────────┘
```

# Tenants Update Config

### Description

Bulk updates the configs of all tenants.

This will update the passed JSON into the tenants' configs, not completely overwrite the tenants' configs.

### Sample

```shell theme={null}
hotglue tenants update-config
✔ Finished: Retrieving tenants for environment dev.hotglue.testcompany.com.
✔ Finished: Updating config for connector salesforce and flow abc123.
┌─────────────┐
│ Tenant ID           │
├─────────────┤
│ test-user           │
└─────────────┘
```

### Parameters

| Option             | Default         | Description                                                            |
| ------------------ | --------------- | ---------------------------------------------------------------------- |
| `--flow`           |                 | The flow to update linked sources/connectors for                       |
| `--connector`      |                 | The connector id to update                                             |
| `--configFilePath` | `./config.json` | The relative path to a JSON file containing the desired config updates |

# Tenants Custom ETL

### Description

Lists all tenants with custom ETL Scripts

### Sample

```shell theme={null}
hotglue tenants custom-etl
✔ Finished: Retrieving tenants for environment dev.hotglue.test.com.
✔ Finished: Querying for custom ETL scripts for flow ABC123.
┌─────────────┐
│ Tenant ID           │
├─────────────┤
│ test-user           │
└─────────────┘
```

### Parameters

| Option        | Default | Description                                  |
| ------------- | ------- | -------------------------------------------- |
| `--flow`      |         | The flow to check for forked scripts         |
| `--connector` |         | The connector ID to check for forked scripts |

# Tenants Custom Field Map

### Description

Lists all tenants with a custom Field Map

### Sample

```shell theme={null}
hotglue tenants custom-field-map
✔ Finished: Retrieving tenants for environment dev.hotglue.testcompany.com.
✔ Finished: Querying for custom field maps for flow KeJ5dstJ2.
┌──────────────┬──────────┐
│ Tenant ID             │ Connector IDs │
├──────────────┼──────────┤
│ anonymous-user-5      │ intacct       │
└──────────────┴──────────┘
```

### Parameters

| Option        | Default | Description                                     |
| ------------- | ------- | ----------------------------------------------- |
| `--flow`      |         | The flow to check for forked field maps         |
| `--connector` |         | The connector ID to check for forked field maps |

# Tenants Custom Catalog

### Description

Lists all tenants with a custom catalog

### Sample

```shell theme={null}
hotglue tenants custom-catalog
✔ Finished: Retrieving tenants for environment dev.hotglue.test.com.
✔ Finished: Querying for custom catalogs for flow abc123.
┌───────┬────────────┐
│ Tenant ID │ Connector IDs      │
├───────┼────────────┤
│ qb-user   │ quickbooks:sandbox │
├───────┼───────────┤
│ abc31     │ stripe-v2          │
└────────────────────┘
```

### Parameters

| Option        | Default | Description                                   |
| ------------- | ------- | --------------------------------------------- |
| `--flow`      |         | The flow to check for forked catalogs         |
| `--connector` |         | The connector ID to check for forked catalogs |

# Tenants Tenant Config Get

### Description

Gets the current tenant config stored in hotglue.

### Sample

```shell theme={null}
hotglue tenants tenant-config get --tenant tenant123
```

### Parameters

| Option       | Default | Description    |
| ------------ | ------- | -------------- |
| `--tenant`   |         | Tenant ID      |
| `--env` `-e` |         | Environment ID |

# Tenants Tenant Config Put

### Description

Sets or replaces the tenant config. The payload must be a JSON object.

### Sample

```shell theme={null}
hotglue tenants tenant-config put '{"hi":"world","bye":5}' --tenant tenant123
```

### Parameters

| Option       | Default | Description                               |
| ------------ | ------- | ----------------------------------------- |
| `json`       |         | JSON object to store as the tenant config |
| `--tenant`   |         | Tenant ID                                 |
| `--env` `-e` |         | Environment ID                            |

# Tenants Tenant Config Patch

### Description

Merges updates into the existing tenant config. The payload must be a JSON object.

### Sample

```shell theme={null}
hotglue tenants tenant-config patch '{"hi":"world","byetwo":5}' --tenant tenant123
```

### Parameters

| Option       | Default | Description                                             |
| ------------ | ------- | ------------------------------------------------------- |
| `json`       |         | JSON object with fields to merge into the tenant config |
| `--tenant`   |         | Tenant ID                                               |
| `--env` `-e` |         | Environment ID                                          |