Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
List every member of the tenant with an access summary
Every member of the tenant, whatever its access: a member whose access was
taken away entirely stays a member (removal is DELETE /scopes/{scopeId}/iam/users/{userId}) and
is listed with accessSummary.kind = none. Each row is the full IamUser (its roles included,
tenant rows too) plus accessSummary. q matches name or email; access=none lists only members
without any access row in the tenant.
Authorization: the caller must reach the tenant (404 otherwise; a bearer is confined to its home
tenant) and hold iam: read somewhere in it (403).
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
tenantId*stringThe tenant id.
q?stringFree-text search.
sort?stringField to sort by (entity-specific; defaults to the entity's natural order).
order?stringSort direction.
"asc""asc""desc"page?integer1-based page number.
1 <= value1pageSize?integerItems per page (max 200).
1 <= value <= 20050access?stringnone = only members without any access row in the tenant; any (default) = all.
"any""any""none"A page of the tenant's members.
application/json- response
data*array<>meta*Pagination envelope metadata. List responses are always { data, meta } — never a naked array.
curl -X GET "https://example.com/tenants/string/iam/users"{ "data": [ { "id": "string", "name": "string", "email": "string", "title": "string", "avatarColor": "string", "status": "ACTIVE", "operatorLocked": true, "type": "MEMBER", "mfaEnabled": true, "lastLogin": "2019-08-24T14:15:22Z", "invitedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "lastPasswordChange": "2019-08-24T14:15:22Z", "department": "string", "manager": "string", "phone": "string", "employeeId": "string", "groups": [ "string" ], "mfaDevices": [ { "id": "string", "kind": "TOTP", "name": "string", "addedAt": "2019-08-24T14:15:22Z", "lastUsedAt": "2019-08-24T14:15:22Z", "primary": true } ], "apiKeys": [ { "id": "string", "name": "string", "prefix": "string", "createdAt": "2019-08-24T14:15:22Z", "lastUsedAt": "2019-08-24T14:15:22Z", "status": "ACTIVE" } ], "roles": [ { "role": "owner", "roleId": "string", "roleName": "string", "scopeKind": "tenant", "scopeLabel": "string", "assignedAt": "2019-08-24T14:15:22Z" } ], "activity": [ { "id": "string", "at": "2019-08-24T14:15:22Z", "action": "string", "resource": "string", "status": "SUCCESS" } ], "tags": [ { "key": "string", "value": "string" } ], "accessSummary": { "kind": "tenant", "subscriptions": 0, "projects": 0 } } ], "meta": { "page": 1, "pageSize": 1, "total": 0, "hasNext": true }}