{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-ayushma-authviewset-edc44903","title":"Auth API reference · mansoq-ayushma","summary":"Static source contract for Auth: 3 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":4,"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-ayushma** at `/api/{installed_plugin_prefix}/auth`. plugin/local mount; actual prefix and enablement require deployment verification 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/{installed_plugin_prefix}/auth/register` | register | @action declaration |\n| POST | `/api/{installed_plugin_prefix}/auth/login` | login | @action declaration |\n| DELETE | `/api/{installed_plugin_prefix}/auth/logout` | logout | @action declaration |"},{"title":"register · POST","body":"**POST /api/{installed_plugin_prefix}/auth/register** — action `register`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**serializer: AuthSerializer**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| email | serializers.EmailField | framework default | write_only: true |\n\n**decorator request: UserCreateSerializer**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| full_name | serializers.CharField | true | required: true |\n| password | serializers.CharField | true | write_only: true; required: true |\n| recaptcha | serializers.CharField | true | write_only: true; required: true |\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**Class policy declarations:** permission_classes: AllowAny.\n\n**Explicit response statuses in observed code:** status.HTTP_201_CREATED. Other branches/framework exception handling may differ."},{"title":"login · POST","body":"**POST /api/{installed_plugin_prefix}/auth/login** — action `login`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**serializer: AuthSerializer**. Declared fields below; inherited fields are retained in the schema inventory.\n\nThe declared field table is shown at its first occurrence in this reference; this operation links the same schema.\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**Class policy declarations:** permission_classes: AllowAny."},{"title":"logout · DELETE","body":"**DELETE /api/{installed_plugin_prefix}/auth/logout** — action `logout`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**serializer: AuthSerializer**. Declared fields below; inherited fields are retained in the schema inventory.\n\nThe declared field table is shown at its first occurrence in this reference; this operation links the same schema.\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**Class policy declarations:** permission_classes: AllowAny.\n\n**Explicit response statuses in observed code:** status.HTTP_204_NO_CONTENT. Other branches/framework exception handling may differ.\n\n**Declared refusal/error evidence:** ParseError: No auth token provided.\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/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":14,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":33,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/auth.py","line":6,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/users.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":50,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-99cd9df4edc44903","backend-resource-99cd9df4edc44903:POST:register","backend-resource-99cd9df4edc44903:POST:login","backend-resource-99cd9df4edc44903:DELETE:logout"]},"backend":{"resources":[{"id":"backend-resource-99cd9df4edc44903","localPrefix":"auth","viewset":"AuthViewSet","classId":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","basename":"auth","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-ayushma","classSource":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":14,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/auth","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-99cd9df4edc44903:POST:register","backend-resource-99cd9df4edc44903:POST:login","backend-resource-99cd9df4edc44903:DELETE:logout"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-99cd9df4edc44903:POST:register","resourceId":"backend-resource-99cd9df4edc44903","repository":"repositories/teleicu/mansoq-ayushma","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/auth/register","declaredPattern":"/api/{installed_plugin_prefix}/auth/register","action":"register","viewset":"AuthViewSet","classId":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":33,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py:33:register"],"schemaIds":{"serializer":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.auth.AuthSerializer","decorator request":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.users.UserCreateSerializer"},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["AllowAny"],"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-99cd9df4edc44903:POST:login","resourceId":"backend-resource-99cd9df4edc44903","repository":"repositories/teleicu/mansoq-ayushma","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/auth/login","declaredPattern":"/api/{installed_plugin_prefix}/auth/login","action":"login","viewset":"AuthViewSet","classId":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py:41:login"],"schemaIds":{"serializer":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.auth.AuthSerializer"},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["AllowAny"],"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-99cd9df4edc44903:DELETE:logout","resourceId":"backend-resource-99cd9df4edc44903","repository":"repositories/teleicu/mansoq-ayushma","boundary":"optional-plugin/local-service","method":"DELETE","path":"/api/{installed_plugin_prefix}/auth/logout","declaredPattern":"/api/{installed_plugin_prefix}/auth/logout","action":"logout","viewset":"AuthViewSet","classId":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":50,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py:50:logout"],"schemaIds":{"serializer":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.auth.AuthSerializer"},"classPermissionEvidence":[{"kind":"permission_classes","declaration":["AllowAny"],"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/api_router.py","line":31,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py:33:register","name":"register","owner":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":33,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":null,"symbol":"status.HTTP_201_CREATED","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":37,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":["repositories/teleicu/mansoq-ayushma:ayushma.serializers.users.UserCreateSerializer"],"schemaUsages":[{"purpose":"decorator request","schemaId":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.users.UserCreateSerializer","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py:41:login","name":"login","owner":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":41,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py:50:logout","name":"logout","owner":"repositories/teleicu/mansoq-ayushma:ayushma.views.auth.AuthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":50,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"ParseError","message":"No auth token provided","dynamicMessage":false,"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":54,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[{"value":null,"symbol":"status.HTTP_204_NO_CONTENT","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/views/auth.py","line":53,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":true,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.auth.AuthSerializer","name":"AuthSerializer","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/auth.py","line":6,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"email","type":"serializers.EmailField","required":"framework default","hasDefault":false,"constraints":{"write_only":true},"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/auth.py","line":7,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"validation":[{"methodId":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/auth.py:10:validate","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/auth.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"baseTypes":["AuthTokenSerializer"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]},{"id":"repositories/teleicu/mansoq-ayushma:ayushma.serializers.users.UserCreateSerializer","name":"UserCreateSerializer","source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/users.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"full_name","type":"serializers.CharField","required":true,"hasDefault":false,"constraints":{"required":true},"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/users.py","line":24,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"password","type":"serializers.CharField","required":true,"hasDefault":false,"constraints":{"write_only":true,"required":true},"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/users.py","line":25,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"recaptcha","type":"serializers.CharField","required":true,"hasDefault":false,"constraints":{"write_only":true,"required":true},"source":{"path":"repositories/teleicu/mansoq-ayushma/ayushma/serializers/users.py","line":26,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"validation":[],"baseTypes":["serializers.ModelSerializer"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}