Skip to main content
GET
JavaScript
The subjects asserted under a tenant, newest first. Like tenants, subjects are never created directly: one appears when an assertion names it, on an objective or a widget session.

Subjects scope to their tenant

There is no workspace-wide subject list, because a subject’s external_id is unique within its tenant, not across the workspace. user-42 under Acme and user-42 under Initech can be different people, and neither assertion knows about the other. To find a person, go through their tenant.

Filtering

query does a substring match against each subject’s name and external_id. includeInfo=true populates the per-subject info counts. sortOrder, limit, and cursor page the list the usual way; the SDK iterators follow the cursor for you.

List tenants

The parent records these subjects live under.

Create a widget session

Where a subject gets asserted alongside its tenant.

Erase a tenant

Subjects go down with their tenant.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

tenantId
string
required

Tenant whose subjects to list. Accepts the canonical tenant_… form or the external_id:<value> form.

Query Parameters

limit
integer<int32>

Maximum number of results to return.

cursor
string

Pagination cursor from previous response.

query
string

Substring match against the subject's name and external_id.

sortOrder
string

Sort order for results (asc or desc by creation time).

includeInfo
boolean

When true, the info field on each returned subject is populated.

Response

OK

List tenant subjects response.

items
object[]
pagination
object

Page carries cursor-based pagination state. There is no total: the cursor walks the result set without ever counting it, and a count would cost a second query on every list.