plerion tenant

With plerion tenant, you can retrieve tenant information and usage, set the dashboard your team lands on, and list the API operations your API key can call.

Synopsis

plerion tenant <subcommand>

Subcommands

get

plerion tenant get

Returns tenant ID, organization ID, name, risk score, and timestamps.

get-usage

plerion tenant get-usage [--date <yyyy-MM-dd>]

Returns tenant usage details. Supports all output formats (table, json, yaml, text).

Option	Type	Description
`--date`	string	Usage date in `yyyy-MM-dd` format (defaults to today)

home-dashboard get

plerion tenant home-dashboard get

Returns the tenant’s default home dashboard.

home-dashboard set

plerion tenant home-dashboard set --home-report-id <id>

Sets the tenant’s default home dashboard, replacing any current default.

Option	Type	Description
`--home-report-id`	string	(required) ID of the custom dashboard to use. Find it with `plerion custom-reports list`

home-dashboard clear

plerion tenant home-dashboard clear

Clears the tenant default, so users fall back to the built-in home page.

api-access

plerion tenant api-access

Lists the API operations the current API key can call, one row per operation. With --output json or --output yaml, it returns the full OpenAPI document, limited to the operations the key’s role allows.

Examples

# Get tenant info as a table
plerion tenant get

# Get tenant info as JSON
plerion tenant get --output json

# Extract just the risk score
plerion tenant get --output json --query 'data.riskScore'

# Get usage details as a table
plerion tenant get-usage

# Get usage for a specific date
plerion tenant get-usage --date 2025-03-01 --output json

# Make a custom dashboard the tenant's home page
plerion tenant home-dashboard set --home-report-id <dashboard-id>

# Go back to the built-in home page
plerion tenant home-dashboard clear

# List the API operations this key can call
plerion tenant api-access

# Save the OpenAPI document for this key
plerion tenant api-access --output json > plerion-openapi.json

Output columns (get)

Column	Description
TENANT ID	Tenant ID
ORG ID	Organization ID
NAME	Tenant name
RISK SCORE	Numeric risk score
CREATED AT	Creation timestamp
UPDATED AT	Update timestamp

Output columns (get-usage)

Column	Description
ASSETS	Number of assets in the tenant
INTEGRATIONS	Number of integrations configured

Example output (JSON)

{
  "data": {
    "tenantId": "t-abc123",
    "organizationId": "org-xyz",
    "name": "Acme Corp",
    "riskScore": 7.2,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-06-01T14:00:00Z"
  }
}

Output columns (home-dashboard)

Column	Description
TENANT ID	Tenant ID
HOME REPORT ID	ID of the default home dashboard
UPDATED AT	Update timestamp

Output columns (api-access)

Column	Description
METHOD	HTTP method
PATH	API path
OPERATION ID	Operation ID
SUMMARY	What the operation does

Getting started

Commands

Synopsis

Subcommands

get

get-usage

home-dashboard get

home-dashboard set

home-dashboard clear

api-access

Examples

Output columns (get)

Output columns (get-usage)

Example output (JSON)

Output columns (home-dashboard)

Output columns (api-access)

​Synopsis

​Subcommands

​get

​get-usage

​home-dashboard get

​home-dashboard set

​home-dashboard clear

​api-access

​Examples

​Output columns (get)

​Output columns (get-usage)

​Example output (JSON)

​Output columns (home-dashboard)

​Output columns (api-access)

Synopsis

Subcommands

get

get-usage

home-dashboard get

home-dashboard set

home-dashboard clear

api-access

Examples

Output columns (get)

Output columns (get-usage)

Example output (JSON)

Output columns (home-dashboard)

Output columns (api-access)