TenantService
Tenants
List a tenant's subjects
Lists the subjects asserted under a tenant. Subjects are only listable through their tenant: a subject's external_id is unique within its tenant, not across the workspace, so the same key can name different people under different tenants.
get/v1/workspaces/{workspaceId}/tenants/{tenantId}/subjects
Path parameters
workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
Workspace ID.
tenantIdstring required
Tenant whose subjects to list. Accepts the canonical tenant_… form or the external_id:<value> form.
Query parameters
limitinteger
Maximum number of results to return.
cursorstring
Pagination cursor from previous response.
querystring
Substring match against the subject's name and external_id.
sortOrderstring
Sort order for results (asc or desc by creation time).
includeInfoboolean
When true, the info field on each returned subject is populated.
Response
OK
Example response
{
"items": [
{
"metadata": {
"accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
"workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
"profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
},
"info": {
"tenant": {
"id": "tenant_01HXKD2E5NQM3T9AYWCF133E3Q",
"externalId": "acme-corp",
"name": "Acme Corp"
}
}
}
]
}