MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Facility Users API reference · mansoq-core

Static source contract for Facility Users: 2 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/facility/{facility_external_id}/users/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/users/ list declared/inherited method
GET /api/v1/facility/{facility_external_id}/users/{external_id}/ retrieve declared/inherited method

list · GET

GET /api/v1/facility/{facility_external_id}/users/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

response: UserSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
first_name str true No extra constraint extracted
last_name str true No extra constraint extracted
phone_number str true max_length: 14
prefix str | None false max_length: 10
suffix str | None false max_length: 50
last_login str true No extra constraint extracted
profile_picture_url str true No extra constraint extracted
gender str true No extra constraint extracted
username str true No extra constraint extracted
mfa_enabled bool false No extra constraint extracted
deleted bool false No extra constraint extracted
role_orgs dict true No extra constraint extracted

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.

retrieve · GET

GET /api/v1/facility/{facility_external_id}/users/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true
path external_id router lookup string; semantic ID validation requires handler/schema review true

response: UserRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
first_name str true No extra constraint extracted
last_name str true No extra constraint extracted
phone_number str true max_length: 14
prefix str | None false max_length: 10
suffix str | None false max_length: 50
last_login str true No extra constraint extracted
profile_picture_url str true No extra constraint extracted
gender str true No extra constraint extracted
username str true No extra constraint extracted
mfa_enabled bool false No extra constraint extracted
deleted bool false No extra constraint extracted
role_orgs dict true No extra constraint extracted
geo_organization dict true No extra constraint extracted
created_by dict | None false No extra constraint extracted
email str true No extra constraint extracted
flags list[str] false No extra constraint extracted
is_service_account bool true No extra constraint extracted

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.

Integration review checklist

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.

Pinned source evidence

Links require access to the private source repository.