mba-cli tenant

2 commands

Read tenants (key-scoped)

Synopsis#

bash

mba-cli tenant <command> [flags]

Available commands#

mba-cli tenant getGet one tenant by id or tenant ID

Retrieve a tenant by id Returns the tenant with the given `id` and its configuration. Related: `List tenants`. --- Retrieve a tenant by tenant id Returns the tenant with the given `tenantID` (the tenant's own identifier, distinct from the record id). Related: `List tenants`. Get one tenant by id or tenant ID

--id	string	Tenant record id
--tenant-id	string	Tenant slug (e.g. waggytails)

GET/tenants/{id}GET/tenants/tenant/{tenantID}

mba-cli tenant lsList tenants (default: page 1, 20 per page)

List tenants Returns the tenants visible to the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by name and status. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a tenant by id`, `Retrieve a tenant by tenant id`. List tenants (default: page 1, 20 per page)

--all	bool = false	Return all rows (paginate=false)
--limit	int = 20	Query parameter limit (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = true	Query parameter paginate (from the API spec)

GET/tenants

Was this page helpful?