{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-core-usage-a8f8b658","title":"Usage API reference · mansoq-core","summary":"Static source contract for Usage: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-core** at `/api/v1/tenant/usage/`. project URL declaration A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| ANY | `/api/v1/tenant/usage/` | usage | explicit Django path/view declaration |"},{"title":"usage · ANY","body":"Signed account and facility usage for the tenant controller.\n\nThe request and the response are bound to the tenant launch key the\ncontroller derives for this tenant, in the controller channel's\n``timestamp.path.body`` form; the public health probe never carries usage.\n\n**ANY /api/v1/tenant/usage/** — action `usage`. static function declaration extracted; request/runtime review pending.\n\nDirectly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):\n\n| Location | Field | Declared/inferred read type | Requiredness evidence |\n| --- | --- | --- | --- |\n| header | `X-MANSOQ-Timestamp` | not declared at read site | not established |\n| header | `X-MANSOQ-Signature` | not declared at read site | not established |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Explicit response statuses in observed code:** 401. Other branches/framework exception handling may differ."},{"title":"Integration review checklist","body":"Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/platform/mansoq-core/config/tenant_urls.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/config/tenant_runtime.py","line":451,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-path-0d935265a8f8b658","backend-path-0d935265a8f8b658:ANY:usage"]},"backend":{"resources":[{"id":"backend-path-0d935265a8f8b658","declaredPath":"api/v1/tenant/usage/","dynamicPath":false,"source":{"path":"repositories/platform/mansoq-core/config/tenant_urls.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"kind":"view","view":"usage","classId":"repositories/platform/mansoq-core:config.tenant_runtime.usage","actionMapping":null,"operationIds":["backend-path-0d935265a8f8b658:ANY:usage"],"path":"/api/v1/tenant/usage/","mountStatus":"project URL declaration","reviewStatus":"direct route enumerated; behavioral review pending"}],"operations":[{"id":"backend-path-0d935265a8f8b658:ANY:usage","resourceId":"backend-path-0d935265a8f8b658","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"ANY","path":"/api/v1/tenant/usage/","declaredPattern":"api/v1/tenant/usage/","action":"usage","viewset":"usage","classId":"repositories/platform/mansoq-core:config.tenant_runtime.usage","detail":null,"mountStatus":"project URL declaration","routeEvidence":{"path":"repositories/platform/mansoq-core/config/tenant_urls.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/platform/mansoq-core/config/tenant_runtime.py","line":451,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"explicit Django path/view declaration","decoratorStatus":null,"decoratorPolicy":{},"methodEvidenceIds":["repositories/platform/mansoq-core/config/tenant_runtime.py:451:usage"],"schemaIds":{},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static function declaration extracted; request/runtime review pending","pathParameters":[]}],"methodEvidence":[{"id":"repositories/platform/mansoq-core/config/tenant_runtime.py:451:usage","name":"usage","owner":"repositories/platform/mansoq-core:config.tenant_runtime.usage","summary":"Signed account and facility usage for the tenant controller.\n\nThe request and the response are bound to the tenant launch key the\ncontroller derives for this tenant, in the controller channel's\n``timestamp.path.body`` form; the public health probe never carries usage.","source":{"path":"repositories/platform/mansoq-core/config/tenant_runtime.py","line":451,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[{"name":"X-MANSOQ-Timestamp","in":"header","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/platform/mansoq-core/config/tenant_runtime.py","line":458,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"X-MANSOQ-Signature","in":"header","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/platform/mansoq-core/config/tenant_runtime.py","line":459,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":401,"symbol":null,"source":{"path":"repositories/platform/mansoq-core/config/tenant_runtime.py","line":468,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[],"frameworkSettings":[{"name":"DEFAULT_AUTHENTICATION_CLASSES","value":["config.authentication.CustomJWTAuthentication","config.authentication.CustomBasicAuthentication","rest_framework.authentication.SessionAuthentication","rest_framework.authentication.TokenAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PERMISSION_CLASSES","value":["rest_framework.permissions.IsAuthenticated","mansoq.security.utils.permission_class.MansoqAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PAGINATION_CLASS","value":"mansoq.utils.pagination.mansoq_pagination.MansoqLimitOffsetPagination","source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"PAGE_SIZE","value":14,"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"}]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}