{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-core-mfaloginviewset-1b7b790b","title":"MFALogin API reference · mansoq-core","summary":"Static source contract for MFALogin: 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/mfa/`. verified core mount in config/urls.py 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| POST | `/api/v1/mfa/login/` | login | @action declaration |"},{"title":"login · POST","body":"**POST /api/v1/mfa/login/** — action `login`. static contract extracted; runtime/permission/payload behavior review pending.\n\n**decorator request: MFALoginRequest**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| method | LoginMethod | true | No extra constraint extracted |\n| code | str | true | No extra constraint extracted |\n| temp_token | str | true | No extra constraint extracted |\n\n**decorator responses: MFALoginResponse**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| access | str | true | No extra constraint extracted |\n| refresh | str | true | No extra constraint extracted |\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**Declared refusal/error evidence:** ValidationError: Invalid login method; ValidationError: Invalid TOTP code; ValidationError: Invalid or already used backup code.\n\n**Direct refusal present:** the handler/helper contains a top-level raise. Review whether the operation is intentionally disabled or only performs validation before relying on it."},{"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/api_router.py","line":282,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":19,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":322,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":48,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":55,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":34,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-cafa673e1b7b790b","backend-resource-cafa673e1b7b790b:POST:login"]},"backend":{"resources":[{"id":"backend-resource-cafa673e1b7b790b","localPrefix":"mfa","viewset":"MFALoginViewSet","classId":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.mfa_login.MFALoginViewSet","basename":"mfa","source":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":282,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/platform/mansoq-core","classSource":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":19,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/v1/mfa/","mountStatus":"verified core mount in config/urls.py","operationIds":["backend-resource-cafa673e1b7b790b:POST:login"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-cafa673e1b7b790b:POST:login","resourceId":"backend-resource-cafa673e1b7b790b","repository":"repositories/platform/mansoq-core","boundary":"primary-core","method":"POST","path":"/api/v1/mfa/login/","declaredPattern":"/api/v1/mfa/login/","action":"login","viewset":"MFALoginViewSet","classId":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.mfa_login.MFALoginViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"verified core mount in config/urls.py","routeEvidence":{"path":"repositories/platform/mansoq-core/config/api_router.py","line":282,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py:31:login","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:322:get_queryset","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py:48:_handle_totp_login","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py:55:_handle_backup_login"],"schemaIds":{"decorator request":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginRequest","decorator responses":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginResponse"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[]}],"methodEvidence":[{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py:31:login","name":"login","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.mfa_login.MFALoginViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"ValidationError","message":"Invalid login method","dynamicMessage":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":45,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[],"conditions":[],"schemaIds":["repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginRequest","repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginResponse"],"schemaUsages":[{"purpose":"decorator request","schemaId":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginRequest","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":20,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"purpose":"decorator responses","schemaId":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginResponse","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":20,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"unconditionalRaise":true,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:322:get_queryset","name":"get_queryset","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRBaseViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":322,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py:48:_handle_totp_login","name":"_handle_totp_login","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.mfa_login.MFALoginViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":48,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[{"name":"user","type":"unspecified","required":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":48,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"code","type":"unspecified","required":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":48,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"ValidationError","message":"Invalid TOTP code","dynamicMessage":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":52,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":true,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py:55:_handle_backup_login","name":"_handle_backup_login","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.mfa_login.MFALoginViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":55,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[{"name":"user","type":"unspecified","required":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":55,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"code","type":"unspecified","required":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":55,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"ValidationError","message":"Invalid or already used backup code","dynamicMessage":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/mfa_login.py","line":69,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginRequest","name":"MFALoginRequest","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"method","type":"LoginMethod","required":true,"hasDefault":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"code","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":30,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"temp_token","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["BaseModel"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":["repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.LoginMethod"]},{"id":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.LoginMethod","name":"LoginMethod","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python enum/choice declaration","fields":[],"validation":[],"baseTypes":["str","Enum"],"reviewStatus":"declared fields extracted; runtime validation review pending","members":[{"name":"totp","value":"totp","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":24,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"backup","value":"backup","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":25,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"referencedSchemaIds":[]},{"id":"repositories/platform/mansoq-core:mansoq.emr.resources.mfa.spec.MFALoginResponse","name":"MFALoginResponse","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":34,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"access","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"refresh","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/mfa/spec.py","line":36,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["BaseModel"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"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":[]}