52bf0279Enrollment requests#
| Property | Value |
|---|---|
| Service | crossfire |
| Operation | enrollments |
| Method | GET |
| Path | /api/enrollments |
| Authentication | human |
| Success status | 200 |
| Response data | Paginated collection |
| Request format | json |
| Maximum request body | 2097152 bytes (service default) |
| Permission codes | enrollment.read.owned, enrollment.read.any |
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:
scoped
; see function below
Accepted query parameters: ownerId.
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 scoped(input: unknown) {
const parsed = checked(input, ['ownerId']);
if (!parsed.ok)
return parsed;
const bounds = pagination(parsed.value);
if (!bounds.ok)
return bounds;
const ownerId = parsed.value.get('ownerId');
if (ownerId === null)
return success(bounds.value);
const valid = check.identifier(ownerId);
return valid.ok ? success({ ...bounds.value, ownerId }) : valid;
}Validation#
query.scopedReferenced 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 (
enrollment
)
| Field path | Representation and constraints |
|---|---|
[].owner | object; fields below; unknown fields rejected (
principal
) |
[].owner.principalId | lowercase opaque UUID |
[].owner.matrixUserId | well-formed Matrix user ID; maximum 255 UTF-16 units |
[].owner.kind | human or agent |
[].owner.displayName | string; 1–255 UTF-16 units; well-formed Unicode; no C0/DEL controls |
[].owner.ownerId | lowercase opaque UUID |
[].owner.ownerMatrixId | well-formed Matrix user ID; maximum 255 UTF-16 units |
[].controllerName | string; 1–100 UTF-16 units; well-formed Unicode; no C0/DEL controls |
[].enrollmentId | lowercase opaque UUID |
[].ownerId | lowercase opaque UUID |
[].fleetKey | lowercase name; pattern [a-z][a-z0-9-]{0,39} |
[].verificationCode | string; 12–12 UTF-16 units; well-formed Unicode; no C0/DEL controls |
[].status | pending or approved or rejected or expired |
[].revision | exact JSON integer; 0…9007199254740991 |
[].createdAt | exact JSON integer; 0…9007199254740991 |
[].expiresAt | exact JSON integer; 0…9007199254740991 |
[].decidedByMemberId | lowercase opaque UUID; JSON null permitted |
[].decidedAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
Validation#
check.list(res.enrollment, 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
}
}