52bf0279Members#
| Property | Value |
|---|---|
| Service | crossfire |
| Operation | members |
| Method | GET |
| Path | /api/members |
| Authentication | human |
| Success status | 200 |
| Response data | Paginated collection |
| Request format | json |
| Maximum request body | 2097152 bytes (service default) |
| Permission codes | member.manage |
Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.
Path parameters#
empty object; unknown fields rejected
Validation#
check.emptyReferenced definitions:
Query parameters#
custom validation:
page
; see function below
Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.
Additional checks#
The following checks apply in addition to the field limits.
Constraint on value:
export function page(input: unknown) {
const parsed = checked(input, []);
return parsed.ok ? pagination(parsed.value) : parsed;
}Validation#
query.pageReferenced definitions:
Request body#
empty object; unknown fields rejected
Validation#
check.emptyReferenced definitions:
Response data#
array; 0–100 entries; item: object; fields below; unknown fields rejected (
member
)
| Field path | Representation and constraints |
|---|---|
[].memberId | lowercase opaque UUID |
[].matrixUserId | well-formed Matrix user ID; maximum 255 UTF-16 units |
[].displayName | string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls |
[].roleCode | member or administrator |
[].status | validator choice('active', 'suspended', 'revoked') (
status
) |
[].revision | exact JSON integer; 0…9007199254740991 |
[].createdAt | exact JSON integer; 0…9007199254740991 |
[].application | object; fields below; unknown fields rejected (
application
) |
[].application.appliedRevision | exact JSON integer; 0…9007199254740991; JSON null permitted |
[].application.appliedStatus | validator choice('active', 'suspended', 'revoked') (
status
); JSON null permitted |
[].application.nativeDisplayName | string; 1–255 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted |
[].application.lastAttemptAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
[].application.lastSuccessAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
[].application.errorCode | string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted |
[].application.errorMessage | string; 1–4096 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted |
Validation#
check.list(res.member, 100)Referenced definitions:
Response envelope#
A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.
{
"data": "<value matching the response-data validator>",
"meta": {
"requestId": "00000000-0000-0000-0000-000000000001",
"page": 1,
"pageSize": 20,
"totalItems": 0,
"totalPages": 1
}
}