> 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/group-roles.md). # Group Roles ## GET /api/users/group\_roles/ > Legacy /api/users/group\_roles/ bridge resource.\ > \ > Mirrors the \`roles\` precedent (companies/custom\_roles) but for group leader roles.\ > \ > Legacy contract (GroupRoleSerializer):\ > id — integer legacy PK (from etl\_id\_registry.source\_id via IdFieldRemap)\ > name — role name\ > active — boolean (maps from Connect is\_active)\ > display\_name — same as name (GroupRole.\_\_str\_\_ returns self.name)\ > \ > Connect endpoints:\ > GET /group-leader-roles → list\ > GET /group-leader-roles/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > POST /group-leader-roles → create\ > DELETE /group-leader-roles/{public\_id} → soft-delete\ > \ > Fan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ > group\_leader\_roles row per (legacy\_role, program). The Connect RPC defaults to\ > p\_canonical\_only=true so only the first canonically-mapped row per legacy role is\ > returned, giving the bridge a flat one-role-one-row list that matches legacy behaviour. ```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"}}},"GroupRoles":{"type":"object","description":"Legacy-shaped users/group_roles record as served by the bridge; translated from Connect /group-leader-roles","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}},"paths":{"/api/users/group_roles/":{"get":{"operationId":"groupRoles_list","tags":["GroupRoles"],"description":"Legacy /api/users/group_roles/ bridge resource.\n\nMirrors the `roles` precedent (companies/custom_roles) but for group leader roles.\n\nLegacy contract (GroupRoleSerializer):\n id — integer legacy PK (from etl_id_registry.source_id via IdFieldRemap)\n name — role name\n active — boolean (maps from Connect is_active)\n display_name — same as name (GroupRole.__str__ returns self.name)\n\nConnect endpoints:\n GET /group-leader-roles → list\n GET /group-leader-roles/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n POST /group-leader-roles → create\n DELETE /group-leader-roles/{public_id} → soft-delete\n\nFan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ngroup_leader_roles row per (legacy_role, program). The Connect RPC defaults to\np_canonical_only=true so only the first canonically-mapped row per legacy role is\nreturned, giving the bridge a flat one-role-one-row list that matches legacy behaviour.","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":"name","in":"query","schema":{"type":"integer"},"description":"maps to Connect name"},{"name":"active","in":"query","schema":{"type":"integer"},"description":"maps to Connect is_active"}],"responses":{"200":{"description":"ListEnvelope","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ListEnvelope"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/GroupRoles"}}}}]}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## POST /api/users/group\_roles/ > Legacy /api/users/group\_roles/ bridge resource.\ > \ > Mirrors the \`roles\` precedent (companies/custom\_roles) but for group leader roles.\ > \ > Legacy contract (GroupRoleSerializer):\ > id — integer legacy PK (from etl\_id\_registry.source\_id via IdFieldRemap)\ > name — role name\ > active — boolean (maps from Connect is\_active)\ > display\_name — same as name (GroupRole.\_\_str\_\_ returns self.name)\ > \ > Connect endpoints:\ > GET /group-leader-roles → list\ > GET /group-leader-roles/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > POST /group-leader-roles → create\ > DELETE /group-leader-roles/{public\_id} → soft-delete\ > \ > Fan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ > group\_leader\_roles row per (legacy\_role, program). The Connect RPC defaults to\ > p\_canonical\_only=true so only the first canonically-mapped row per legacy role is\ > returned, giving the bridge a flat one-role-one-row list that matches legacy behaviour. ```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":{"GroupRoles":{"type":"object","description":"Legacy-shaped users/group_roles record as served by the bridge; translated from Connect /group-leader-roles","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}},"paths":{"/api/users/group_roles/":{"post":{"operationId":"groupRoles_create","tags":["GroupRoles"],"description":"Legacy /api/users/group_roles/ bridge resource.\n\nMirrors the `roles` precedent (companies/custom_roles) but for group leader roles.\n\nLegacy contract (GroupRoleSerializer):\n id — integer legacy PK (from etl_id_registry.source_id via IdFieldRemap)\n name — role name\n active — boolean (maps from Connect is_active)\n display_name — same as name (GroupRole.__str__ returns self.name)\n\nConnect endpoints:\n GET /group-leader-roles → list\n GET /group-leader-roles/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n POST /group-leader-roles → create\n DELETE /group-leader-roles/{public_id} → soft-delete\n\nFan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ngroup_leader_roles row per (legacy_role, program). The Connect RPC defaults to\np_canonical_only=true so only the first canonically-mapped row per legacy role is\nreturned, giving the bridge a flat one-role-one-row list that matches legacy behaviour.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoles"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## GET /api/users/group\_roles/{id}/ > Legacy /api/users/group\_roles/ bridge resource.\ > \ > Mirrors the \`roles\` precedent (companies/custom\_roles) but for group leader roles.\ > \ > Legacy contract (GroupRoleSerializer):\ > id — integer legacy PK (from etl\_id\_registry.source\_id via IdFieldRemap)\ > name — role name\ > active — boolean (maps from Connect is\_active)\ > display\_name — same as name (GroupRole.\_\_str\_\_ returns self.name)\ > \ > Connect endpoints:\ > GET /group-leader-roles → list\ > GET /group-leader-roles/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > POST /group-leader-roles → create\ > DELETE /group-leader-roles/{public\_id} → soft-delete\ > \ > Fan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ > group\_leader\_roles row per (legacy\_role, program). The Connect RPC defaults to\ > p\_canonical\_only=true so only the first canonically-mapped row per legacy role is\ > returned, giving the bridge a flat one-role-one-row list that matches legacy behaviour. ```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":{"GroupRoles":{"type":"object","description":"Legacy-shaped users/group_roles record as served by the bridge; translated from Connect /group-leader-roles","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}},"paths":{"/api/users/group_roles/{id}/":{"get":{"operationId":"groupRoles_retrieve","tags":["GroupRoles"],"description":"Legacy /api/users/group_roles/ bridge resource.\n\nMirrors the `roles` precedent (companies/custom_roles) but for group leader roles.\n\nLegacy contract (GroupRoleSerializer):\n id — integer legacy PK (from etl_id_registry.source_id via IdFieldRemap)\n name — role name\n active — boolean (maps from Connect is_active)\n display_name — same as name (GroupRole.__str__ returns self.name)\n\nConnect endpoints:\n GET /group-leader-roles → list\n GET /group-leader-roles/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n POST /group-leader-roles → create\n DELETE /group-leader-roles/{public_id} → soft-delete\n\nFan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ngroup_leader_roles row per (legacy_role, program). The Connect RPC defaults to\np_canonical_only=true so only the first canonically-mapped row per legacy role is\nreturned, giving the bridge a flat one-role-one-row list that matches legacy behaviour.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoles"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PUT /api/users/group\_roles/{id}/ > Legacy /api/users/group\_roles/ bridge resource.\ > \ > Mirrors the \`roles\` precedent (companies/custom\_roles) but for group leader roles.\ > \ > Legacy contract (GroupRoleSerializer):\ > id — integer legacy PK (from etl\_id\_registry.source\_id via IdFieldRemap)\ > name — role name\ > active — boolean (maps from Connect is\_active)\ > display\_name — same as name (GroupRole.\_\_str\_\_ returns self.name)\ > \ > Connect endpoints:\ > GET /group-leader-roles → list\ > GET /group-leader-roles/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > POST /group-leader-roles → create\ > DELETE /group-leader-roles/{public\_id} → soft-delete\ > \ > Fan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ > group\_leader\_roles row per (legacy\_role, program). The Connect RPC defaults to\ > p\_canonical\_only=true so only the first canonically-mapped row per legacy role is\ > returned, giving the bridge a flat one-role-one-row list that matches legacy behaviour. ```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":{"GroupRoles":{"type":"object","description":"Legacy-shaped users/group_roles record as served by the bridge; translated from Connect /group-leader-roles","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}},"paths":{"/api/users/group_roles/{id}/":{"put":{"operationId":"groupRoles_update","tags":["GroupRoles"],"description":"Legacy /api/users/group_roles/ bridge resource.\n\nMirrors the `roles` precedent (companies/custom_roles) but for group leader roles.\n\nLegacy contract (GroupRoleSerializer):\n id — integer legacy PK (from etl_id_registry.source_id via IdFieldRemap)\n name — role name\n active — boolean (maps from Connect is_active)\n display_name — same as name (GroupRole.__str__ returns self.name)\n\nConnect endpoints:\n GET /group-leader-roles → list\n GET /group-leader-roles/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n POST /group-leader-roles → create\n DELETE /group-leader-roles/{public_id} → soft-delete\n\nFan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ngroup_leader_roles row per (legacy_role, program). The Connect RPC defaults to\np_canonical_only=true so only the first canonically-mapped row per legacy role is\nreturned, giving the bridge a flat one-role-one-row list that matches legacy behaviour.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoles"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## DELETE /api/users/group\_roles/{id}/ > Legacy /api/users/group\_roles/ bridge resource.\ > \ > Mirrors the \`roles\` precedent (companies/custom\_roles) but for group leader roles.\ > \ > Legacy contract (GroupRoleSerializer):\ > id — integer legacy PK (from etl\_id\_registry.source\_id via IdFieldRemap)\ > name — role name\ > active — boolean (maps from Connect is\_active)\ > display\_name — same as name (GroupRole.\_\_str\_\_ returns self.name)\ > \ > Connect endpoints:\ > GET /group-leader-roles → list\ > GET /group-leader-roles/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > POST /group-leader-roles → create\ > DELETE /group-leader-roles/{public\_id} → soft-delete\ > \ > Fan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ > group\_leader\_roles row per (legacy\_role, program). The Connect RPC defaults to\ > p\_canonical\_only=true so only the first canonically-mapped row per legacy role is\ > returned, giving the bridge a flat one-role-one-row list that matches legacy behaviour. ```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":{"GroupRoles":{"type":"object","description":"Legacy-shaped users/group_roles record as served by the bridge; translated from Connect /group-leader-roles","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}},"paths":{"/api/users/group_roles/{id}/":{"delete":{"operationId":"groupRoles_destroy","tags":["GroupRoles"],"description":"Legacy /api/users/group_roles/ bridge resource.\n\nMirrors the `roles` precedent (companies/custom_roles) but for group leader roles.\n\nLegacy contract (GroupRoleSerializer):\n id — integer legacy PK (from etl_id_registry.source_id via IdFieldRemap)\n name — role name\n active — boolean (maps from Connect is_active)\n display_name — same as name (GroupRole.__str__ returns self.name)\n\nConnect endpoints:\n GET /group-leader-roles → list\n GET /group-leader-roles/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n POST /group-leader-roles → create\n DELETE /group-leader-roles/{public_id} → soft-delete\n\nFan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ngroup_leader_roles row per (legacy_role, program). The Connect RPC defaults to\np_canonical_only=true so only the first canonically-mapped row per legacy role is\nreturned, giving the bridge a flat one-role-one-row list that matches legacy behaviour.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoles"}}}},"400":{"description":"validation error"},"401":{"description":"unauthenticated"},"404":{"description":"not found or out of tenant scope"}}}}}} ``` ## PATCH /api/users/group\_roles/{id}/ > Legacy /api/users/group\_roles/ bridge resource.\ > \ > Mirrors the \`roles\` precedent (companies/custom\_roles) but for group leader roles.\ > \ > Legacy contract (GroupRoleSerializer):\ > id — integer legacy PK (from etl\_id\_registry.source\_id via IdFieldRemap)\ > name — role name\ > active — boolean (maps from Connect is\_active)\ > display\_name — same as name (GroupRole.\_\_str\_\_ returns self.name)\ > \ > Connect endpoints:\ > GET /group-leader-roles → list\ > GET /group-leader-roles/{public\_id} → detail (via ?legacy\_id=\\&limit=1 strategy)\ > POST /group-leader-roles → create\ > DELETE /group-leader-roles/{public\_id} → soft-delete\ > \ > Fan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ > group\_leader\_roles row per (legacy\_role, program). The Connect RPC defaults to\ > p\_canonical\_only=true so only the first canonically-mapped row per legacy role is\ > returned, giving the bridge a flat one-role-one-row list that matches legacy behaviour. ```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":{"GroupRoles":{"type":"object","description":"Legacy-shaped users/group_roles record as served by the bridge; translated from Connect /group-leader-roles","properties":{"id":{"type":"integer","description":"legacy id of legacy_id"},"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}},"paths":{"/api/users/group_roles/{id}/":{"patch":{"operationId":"groupRoles_partial_update","tags":["GroupRoles"],"description":"Legacy /api/users/group_roles/ bridge resource.\n\nMirrors the `roles` precedent (companies/custom_roles) but for group leader roles.\n\nLegacy contract (GroupRoleSerializer):\n id — integer legacy PK (from etl_id_registry.source_id via IdFieldRemap)\n name — role name\n active — boolean (maps from Connect is_active)\n display_name — same as name (GroupRole.__str__ returns self.name)\n\nConnect endpoints:\n GET /group-leader-roles → list\n GET /group-leader-roles/{public_id} → detail (via ?legacy_id=&limit=1 strategy)\n POST /group-leader-roles → create\n DELETE /group-leader-roles/{public_id} → soft-delete\n\nFan-out note: legacy GroupRole had no program FK; the ETL creates one Oracle\ngroup_leader_roles row per (legacy_role, program). The Connect RPC defaults to\np_canonical_only=true so only the first canonically-mapped row per legacy role is\nreturned, giving the bridge a flat one-role-one-row list that matches legacy behaviour.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Connect name"},"display_name":{"type":"string","description":"Connect name"},"active":{"type":"string","description":"Connect is_active"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRoles"}}}},"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/group-roles.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.