petra_list_tenants
Lists every client tenant in the Petra organization with tenant IDs, Microsoft tenant ID, onboarding date and paused status. Start here to find the tenantId other Petra tools require.
Instructions
List every client tenant (Microsoft 365 customer) in the Petra organization, alphabetically, with its Petra tenant ID, Microsoft tenant ID, onboarding date and paused flag. Start here to find the tenantId other petra_* tools take. Removed tenants are excluded; paused tenants are included unless includePaused is false.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "petra_list_tenants"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| nameContains | No | Case-insensitive substring match on the tenant name (filtered locally; Petra has no search parameter). | |
| includePaused | No | Include tenants whose ingestion is paused. Defaults to true. |