Human guide / 08-requests-apis-routes.json
Source-qualified discovery inventory
Requests apis routes
Signing inputs, headers, verification, route families, authentication descriptions, and operation signatures.
Document context
How to read this page Every value below mirrors the JSON document. Friendly labels and explanations add context without replacing the exact field name or recorded value. Follow any “raw record” link to inspect or edit the same data.
Schema versionschema_version Version of the discovery-inventory document shape.
0.1.0
Catalogue statuscatalogue_status Maturity of this catalogue data, not implementation status.
discovery_inventory
Authorityauthority How this document may be used and what it must not be mistaken for.
Evidence-derived inventory; not a final implementation-governing SSOT. Preserve source modality and consult conflicts.json.
Categorycategory Stable subject area used to organize the inventory.
requests_apis_routes
Descriptiondescription Human-language explanation preserved by the inventory.
Signing inputs, headers, verification, route families, authentication descriptions, and operation signatures.
On this page Items8
Fixed versioned byte input signed by Authentication private key; arbitrary serialized JSON must not be signed directly.
What this represents This entry is recorded as Protocol component in the Items section.
Statement status: Firm statement The source states this firmly, rather than as a suggestion.
IdidStable catalogue identity. Ordinary edits should preserve it. api.signing_input
NamenameRecorded inventory field; its exact name and structure are preserved. CRE8-REQUEST-V1 signing input
KindkindStructural role of this entry within the catalogue. protocol_component
DescriptiondescriptionHuman-language explanation preserved by the inventory. Fixed versioned byte input signed by Authentication private key; arbitrary serialized JSON must not be signed directly.
ModalitymodalityStrength or status of the source statement. firm_statement FieldsfieldsRecorded inventory field; its exact name and structure are preserved. credential_id component_version method uppercase normalized path SHA-256 normalized query hash SHA-256 exact-body hash Unix timestamp random base64url nonce CRE8 API origin audience Candidate request headers for credential, version, freshness, digest, and signatures.
What this represents This entry is recorded as Protocol component in the Items section.
Statement status: Recommendation This is recommended guidance rather than a final requirement.
IdidStable catalogue identity. Ordinary edits should preserve it. api.headers
NamenameRecorded inventory field; its exact name and structure are preserved. Suggested CRE8 headers
KindkindStructural role of this entry within the catalogue. protocol_component
DescriptiondescriptionHuman-language explanation preserved by the inventory. Candidate request headers for credential, version, freshness, digest, and signatures.
ModalitymodalityStrength or status of the source statement. recommendation HeadersheadersRecorded inventory field; its exact name and structure are preserved. CRE8-Credential-ID CRE8-Component-Version CRE8-Timestamp CRE8-Nonce CRE8-Body-Digest CRE8-Auth-Signature CRE8-Purpose-Signature Strict parsing, component lookup/status, freshness/replay/digest/signature checks, authorization/limits, decision record, execution.
What this represents This entry is recorded as Protocol flow in the Items section.
Statement status: Firm statement The source states this firmly, rather than as a suggestion.
IdidStable catalogue identity. Ordinary edits should preserve it. api.verification
NamenameRecorded inventory field; its exact name and structure are preserved. Server verification sequence
KindkindStructural role of this entry within the catalogue. protocol_flow
DescriptiondescriptionHuman-language explanation preserved by the inventory. Strict parsing, component lookup/status, freshness/replay/digest/signature checks, authorization/limits, decision record, execution.
ModalitymodalityStrength or status of the source statement. firm_statement StepsstepsRecorded inventory field; its exact name and structure are preserved. Parse with strict size limits Locate authentication public component Reject unknown/inactive versions Check timestamp window Atomically record nonce Reject replay Recalculate body digest Verify Authentication signature Verify purpose signature when required Evaluate effective permissions Apply limits Record authorization decision Execute Deterministic representation such as JCS is proposed for policy documents and authorship metadata.
What this represents This entry is recorded as Protocol component in the Items section.
Statement status: Recommendation This is recommended guidance rather than a final requirement.
IdidStable catalogue identity. Ordinary edits should preserve it. api.canonicalization
NamenameRecorded inventory field; its exact name and structure are preserved. Signed document canonicalization
KindkindStructural role of this entry within the catalogue. protocol_component
DescriptiondescriptionHuman-language explanation preserved by the inventory. Deterministic representation such as JCS is proposed for policy documents and authorship metadata.
ModalitymodalityStrength or status of the source statement. recommendation Public routes listed as /, /health, /.well-known/jwks.json, /ui*, and authentication bootstrap routes.
What this represents This entry is recorded as Route family in the Items section.
Statement status: Source description This records how the historical source describes the system.
IdidStable catalogue identity. Ordinary edits should preserve it. route.public
NamenameRecorded inventory field; its exact name and structure are preserved. Public route surface
KindkindStructural role of this entry within the catalogue. route_family
DescriptiondescriptionHuman-language explanation preserved by the inventory. Public routes listed as /, /health, /.well-known/jwks.json, /ui*, and authentication bootstrap routes.
ModalitymodalityStrength or status of the source statement. source_description RoutesroutesRecorded inventory field; its exact name and structure are preserved. / /health /.well-known/jwks.json /ui* auth bootstrap routes /api/* described as protected by key JWT, device header, and use-key constraints; conflicts with signed-request model.
What this represents This entry is recorded as Route family in the Items section.
Statement status: Conflict The evidence contains competing descriptions; this page does not choose a winner.
IdidStable catalogue identity. Ordinary edits should preserve it. route.gateway
NamenameRecorded inventory field; its exact name and structure are preserved. Gateway route surface
KindkindStructural role of this entry within the catalogue. route_family
DescriptiondescriptionHuman-language explanation preserved by the inventory. /api/* described as protected by key JWT, device header, and use-key constraints; conflicts with signed-request model.
ModalitymodalityStrength or status of the source statement. conflict RoutesroutesRecorded inventory field; its exact name and structure are preserved. /api/* /console/api/* described as owner-JWT protected; conflicts with opaque hashed Owner session source.
What this represents This entry is recorded as Route family in the Items section.
Statement status: Conflict The evidence contains competing descriptions; this page does not choose a winner.
IdidStable catalogue identity. Ordinary edits should preserve it. route.console
NamenameRecorded inventory field; its exact name and structure are preserved. Console route surface
KindkindStructural role of this entry within the catalogue. route_family
DescriptiondescriptionHuman-language explanation preserved by the inventory. /console/api/* described as owner-JWT protected; conflicts with opaque hashed Owner session source.
ModalitymodalityStrength or status of the source statement. conflict RoutesroutesRecorded inventory field; its exact name and structure are preserved. /console/api/* Operation-specific Authentication, Delegation, Authorship, Box-encryption, Owner, and step-up combinations.
What this represents This entry is recorded as Protocol matrix in the Items section.
Statement status: Source description This records how the historical source describes the system.
IdidStable catalogue identity. Ordinary edits should preserve it. api.signature_matrix
NamenameRecorded inventory field; its exact name and structure are preserved. Signature requirements by operation
KindkindStructural role of this entry within the catalogue. protocol_matrix
DescriptiondescriptionHuman-language explanation preserved by the inventory. Operation-specific Authentication, Delegation, Authorship, Box-encryption, Owner, and step-up combinations.
ModalitymodalityStrength or status of the source statement. source_description OperationsoperationsRecorded inventory field; its exact name and structure are preserved.
Operationoperation Read an authorized resource
Required components or authorityrequired_components_or_authority Authentication
Source linesource_line 3
Operationoperation Create an ordinary resource
Required components or authorityrequired_components_or_authority Authentication
Source linesource_line 4
Operationoperation Publish authored material
Required components or authorityrequired_components_or_authority Authentication + Authorship
Source linesource_line 5
Operationoperation Issue a signed credential
Required components or authorityrequired_components_or_authority Authentication + Authorship
Source linesource_line 6
Operationoperation Send an encrypted message
Required components or authorityrequired_components_or_authority Authentication; encryption occurs using recipient Box public key
Source linesource_line 7
Operationoperation Mint a child Key
Required components or authorityrequired_components_or_authority Authentication + Delegation
Source linesource_line 8
Operationoperation Assign child permissions
Required components or authorityrequired_components_or_authority Authentication + Delegation
Source linesource_line 9
Operationoperation Expand child permissions
Required components or authorityrequired_components_or_authority Authentication + Delegation, possibly Owner approval
Source linesource_line 10
Operationoperation Rotate the authentication component
Required components or authorityrequired_components_or_authority Delegation or Owner
Source linesource_line 11
Operationoperation Rotate the authorship component
Required components or authorityrequired_components_or_authority Authentication + Delegation, or Owner
Source linesource_line 12
Operationoperation Rotate the delegation component
Required components or authorityrequired_components_or_authority Owner approval recommended
Source linesource_line 13
Operationoperation Revoke a child
Required components or authorityrequired_components_or_authority Authentication + Delegation
Source linesource_line 14
Operationoperation Revoke a subtree
Required components or authorityrequired_components_or_authority Authentication + Delegation plus elevated policy or Owner
Source linesource_line 15
Operationoperation Owner action
Required components or authorityrequired_components_or_authority Owner session plus step-up when required
Source linesource_line 16