> For the complete documentation index, see [llms.txt](https://docs.mymedtrics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mymedtrics.com/api-reference/medtrics-classic-sis-bridge/users.md). # Users ## GET /api-banner/users/ > Legacy /api-banner/users/ bridge resource.\ > \ > Mirrors the \`\`BannerUserViewset\`\` contract from the legacy Django app:\ > GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\ > GET /api-banner/users/{id}/ → retrieve\ > POST /api-banner/users/ → create (maps to Connect POST /learners)\ > PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\ > PATCH /api-banner/users/{id}/ → partial update\ > DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this) ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"ListEnvelope":{"type":"object","description":"Bridge-wide list envelope. count is always null and page_range always [] (cursor pagination upstream).","properties":{"count":{"type":["integer","null"]},"page_range":{"type":"array"},"per_page":{"type":"integer"},"next":{"type":["string","null"]},"previous":{"type":["string","null"]},"results":{"type":"array"}}},"Users":{"type":"object","description":"Legacy-shaped banner/users record as served by the bridge; translated from Connect /learners","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}},"paths":{"/api-banner/users/":{"get":{"operationId":"users_list","tags":["Users"],"description":"Legacy /api-banner/users/ bridge resource.\n\nMirrors the ``BannerUserViewset`` contract from the legacy Django app:\n GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\n GET /api-banner/users/{id}/ → retrieve\n POST /api-banner/users/ → create (maps to Connect POST /learners)\n PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\n PATCH /api-banner/users/{id}/ → partial update\n DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"page_size","in":"query","schema":{"type":"integer","maximum":100}},{"name":"id","in":"query","schema":{"type":"integer"},"description":"maps to Connect legacy_id"},{"name":"email","in":"query","schema":{"type":"integer"},"description":"maps to Connect email"},{"name":"employee_number","in":"query","schema":{"type":"integer"},"description":"maps to Connect employee_number"}],"responses":{"200":{"description":"ListEnvelope","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Users"}}}}]}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## POST /api-banner/users/ > Legacy /api-banner/users/ bridge resource.\ > \ > Mirrors the \`\`BannerUserViewset\`\` contract from the legacy Django app:\ > GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\ > GET /api-banner/users/{id}/ → retrieve\ > POST /api-banner/users/ → create (maps to Connect POST /learners)\ > PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\ > PATCH /api-banner/users/{id}/ → partial update\ > DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this) ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Users":{"type":"object","description":"Legacy-shaped banner/users record as served by the bridge; translated from Connect /learners","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}},"paths":{"/api-banner/users/":{"post":{"operationId":"users_create","tags":["Users"],"description":"Legacy /api-banner/users/ bridge resource.\n\nMirrors the ``BannerUserViewset`` contract from the legacy Django app:\n GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\n GET /api-banner/users/{id}/ → retrieve\n POST /api-banner/users/ → create (maps to Connect POST /learners)\n PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\n PATCH /api-banner/users/{id}/ → partial update\n DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this)","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["email","role","primary_affiliation","start_date"],"properties":{"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## GET /api-banner/users/{id}/ > Legacy /api-banner/users/ bridge resource.\ > \ > Mirrors the \`\`BannerUserViewset\`\` contract from the legacy Django app:\ > GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\ > GET /api-banner/users/{id}/ → retrieve\ > POST /api-banner/users/ → create (maps to Connect POST /learners)\ > PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\ > PATCH /api-banner/users/{id}/ → partial update\ > DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this) ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Users":{"type":"object","description":"Legacy-shaped banner/users record as served by the bridge; translated from Connect /learners","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}},"paths":{"/api-banner/users/{id}/":{"get":{"operationId":"users_retrieve","tags":["Users"],"description":"Legacy /api-banner/users/ bridge resource.\n\nMirrors the ``BannerUserViewset`` contract from the legacy Django app:\n GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\n GET /api-banner/users/{id}/ → retrieve\n POST /api-banner/users/ → create (maps to Connect POST /learners)\n PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\n PATCH /api-banner/users/{id}/ → partial update\n DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PUT /api-banner/users/{id}/ > Legacy /api-banner/users/ bridge resource.\ > \ > Mirrors the \`\`BannerUserViewset\`\` contract from the legacy Django app:\ > GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\ > GET /api-banner/users/{id}/ → retrieve\ > POST /api-banner/users/ → create (maps to Connect POST /learners)\ > PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\ > PATCH /api-banner/users/{id}/ → partial update\ > DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this) ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Users":{"type":"object","description":"Legacy-shaped banner/users record as served by the bridge; translated from Connect /learners","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}},"paths":{"/api-banner/users/{id}/":{"put":{"operationId":"users_update","tags":["Users"],"description":"Legacy /api-banner/users/ bridge resource.\n\nMirrors the ``BannerUserViewset`` contract from the legacy Django app:\n GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\n GET /api-banner/users/{id}/ → retrieve\n POST /api-banner/users/ → create (maps to Connect POST /learners)\n PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\n PATCH /api-banner/users/{id}/ → partial update\n DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this)","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PATCH /api-banner/users/{id}/ > Legacy /api-banner/users/ bridge resource.\ > \ > Mirrors the \`\`BannerUserViewset\`\` contract from the legacy Django app:\ > GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\ > GET /api-banner/users/{id}/ → retrieve\ > POST /api-banner/users/ → create (maps to Connect POST /learners)\ > PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\ > PATCH /api-banner/users/{id}/ → partial update\ > DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this) ```json {"openapi":"3.1.0","info":{"title":"Medtrics Legacy SIS Bridge (Compatibility API)","version":"draft-2026-10-29"},"servers":[{"url":"https://{client}.mymedtrics.com","description":"Tenant host; Caddy routes /api-banner/* and /api/* to the bridge (internal only)","variables":{"client":{"default":"","description":"Tenant subdomain"}}},{"url":"http://localhost:8090","description":"local dev (see docker/caddy/Caddyfile for deployed hosts)"}],"security":[{"LegacyToken":[]},{"LegacyBasic":[]}],"components":{"securitySchemes":{"LegacyToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token "},"LegacyBasic":{"type":"http","scheme":"basic"}},"schemas":{"Users":{"type":"object","description":"Legacy-shaped banner/users record as served by the bridge; translated from Connect /learners","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}},"paths":{"/api-banner/users/{id}/":{"patch":{"operationId":"users_partial_update","tags":["Users"],"description":"Legacy /api-banner/users/ bridge resource.\n\nMirrors the ``BannerUserViewset`` contract from the legacy Django app:\n GET /api-banner/users/ → list (read-only via LegacyResourceViewSet)\n GET /api-banner/users/{id}/ → retrieve\n POST /api-banner/users/ → create (maps to Connect POST /learners)\n PUT /api-banner/users/{id}/ → full update (maps to Connect PATCH /learners/{id})\n PATCH /api-banner/users/{id}/ → partial update\n DELETE /api-banner/users/{id}/ → 403 (legacy UserPermissions blocks this)","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"primary_affiliation":{"type":"integer","description":"legacy id of primary_program_legacy_id"},"home_institution":{"type":"integer","description":"legacy id of home_site_legacy_id"},"role":{"type":"integer","description":"legacy id of role_legacy_id"},"first_name":{"type":"string","description":"Connect first_name"},"middle_name":{"type":"string","description":"Connect middle_name"},"last_name":{"type":"string","description":"Connect last_name"},"email":{"type":"string","description":"Connect email"},"cc_email":{"type":"string","description":"Connect cc_email"},"phone":{"type":"string","description":"Connect phone"},"work_mobile_phone":{"type":"string","description":"Connect work_mobile_phone"},"cell_phone":{"type":"string","description":"Connect cell_phone"},"home_phone":{"type":"string","description":"Connect home_phone"},"employee_number":{"type":"string","description":"Connect employee_number"},"is_active":{"type":"string","description":"Connect is_active"},"invitation_sent":{"type":"string","description":"Connect invitation_sent"},"start_date":{"type":"string","description":"Connect start_date (date_to_iso)"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.mymedtrics.com/api-reference/medtrics-classic-sis-bridge/users.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.