Skip to content
TinyConductorTinyConductorTinyConductor

Search tenants

POST
/v2/tenants/search
curl --request POST \
  --url http://localhost:8080/v2/tenants/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filter": { "ownerType": "GROUP" } }'
Available inEmbeddedBundledCluster
AuthAuthenticated Bearer token or console session with X-CSRF-Token · requires tenant:admin

Lists the tenants the caller administers.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
x-tenant-id
string
>= 1 characters

Tenant selection. A principal bound to one tenant may omit it; if sent, it must equal that tenant (403 otherwise). A principal that may act in several tenants must send it on every request: without it the request is refused with 400, and a tenant it may not act in is refused with 403.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

An optional filter object of exact field matches, for example {"filter": {"ownerType": "GROUP"}}.

object
filter
object
Example
{
  "filter": {
    "ownerType": "GROUP"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The result.

Media typeapplication/json
object
items
required
Array<object>
object
tenantId
required
string
name
required
string
description
string | null
state
required
string
Allowed values: ACTIVE SUSPENDED
quotas

The tenant’s quotas (Bundled and Cluster), or null.

object | null
limits

The tenant’s size limits (Bundled and Cluster), or null.

object
maxDeploymentBytes
integer
maxVariablesBytes
integer
maxBatchSize
integer
retention

The tenant’s record retention (Bundled and Cluster), or null.

object
recordRetentionMicros
integer
members

Who is a member of the tenant.

Array<object>
object
memberType
string
memberId
string
admins

Who holds the built-in admin role in the tenant.

Array<object>
object
memberType
string
memberId
string
quarantine
Any of:
null
runningInstances

How many of the tenant’s process instances are running now, call-activity children included (the count activeInstanceLimit bounds), as the reporting tables count them, so it can trail the engine by a moment (Bundled and Cluster); null in Embedded mode or when it cannot be read.

integer | null
page
required
object
totalItems
required
integer
Example
{
  "items": [
    {
      "state": "ACTIVE"
    }
  ]
}

400

Section titled “400”

The request is malformed, or it uses a property or filter this release does not support.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:invalid-argument",
  "title": "Bad Request",
  "status": 400,
  "detail": "entity key must be a positive int64 string",
  "instance": "/v2/process-instances/0"
}

401

Section titled “401”

No valid credential was presented.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer credential is required",
  "instance": "/v2/tenants/search"
}

Headers

Section titled “Headers”
WWW-Authenticate
string
Allowed value: Bearer

403

Section titled “403”

The caller lacks the required permission, a tenant named in the request is not the caller’s tenant, or a cookie write has no valid CSRF token.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The principal lacks the action this route requires",
  "instance": "/v2/tenants/search"
}

500

Section titled “500”

An internal failure. The details are never exposed.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:internal",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed",
  "instance": "/v2/tenants/search"
}

503

Section titled “503”

Backpressure, or a dependency is not ready. Retry with the same idempotency key.

Media typeapplication/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/v2/tenants/search"
}