Skip to content

Admin API Reference ​

Every route under /admin/, read from the backend's own route table. The same table drives the MCP tools and resources on /mcp and the in-app assistant, so the names below are the names those clients see.

  • Tool: a mutating route, callable as an MCP tool on /mcp.
  • Resource: a GET route, published as an MCP resource and readable through the read_resource tool. The in-app assistant calls it by its get_ tool name, listed in admin-api.json next to this page.

Request and response schemas are in the OpenAPI document the backend serves at /swagger. Naming rules and exposure controls are covered in Backend API Tools and MCP HTTP Server.

This page and docs/public/admin-api.json are generated by bun run docs:generate; bun run docs:check fails when they no longer match the routes.

/admin/app-store ​

MethodPathSummaryMCP
GET/admin/app-store/List App Store Appsresource proxy-smart://admin/app-store/
POST/admin/app-store/:appId/hideHide App from Storetool create_admin_app-store_appId_hide
POST/admin/app-store/:appId/showShow App in Storetool create_admin_app-store_appId_show
POST/admin/app-store/:appId/unpublishUnpublish App from Storetool create_admin_app-store_appId_unpublish
POST/admin/app-store/publishPublish App to Storetool create_admin_app-store_publish

/admin/auth-flows ​

MethodPathSummaryMCP
GET/admin/auth-flows/List Authentication Flowsresource proxy-smart://admin/auth-flows/
GET/admin/auth-flows/:flowAlias/executionsGet Flow Executionsresource proxy-smart://admin/auth-flows/{flowAlias}/executions
POST/admin/auth-flows/:flowAlias/executionsAdd Execution to Flowtool create_admin_auth-flows_flowAlias_executions
PUT/admin/auth-flows/:flowAlias/executionsUpdate Execution Requirementtool update_admin_auth-flows_flowAlias_executions
GET/admin/auth-flows/client-authenticatorsList Client Authenticator Providersresource proxy-smart://admin/auth-flows/client-authenticators
DELETE/admin/auth-flows/executions/:executionIdDelete Executiontool delete_admin_auth-flows_executions_executionId
POST/admin/auth-flows/executions/:executionId/lower-priorityLower Execution Prioritytool create_admin_auth-flows_executions_executionId_lower-priority
POST/admin/auth-flows/executions/:executionId/raise-priorityRaise Execution Prioritytool create_admin_auth-flows_executions_executionId_raise-priority
GET/admin/auth-flows/smart-flow-mappingSMART Flow Mappingresource proxy-smart://admin/auth-flows/smart-flow-mapping

/admin/branding ​

MethodPathSummaryMCP
GET/admin/branding/Get Brand Configurationresource proxy-smart://admin/branding/
PUT/admin/branding/Update Brand Configurationtool update_admin_branding_

/admin/capabilities ​

MethodPathSummaryMCP
GET/admin/capabilities/List All Server Capabilitiesresource proxy-smart://admin/capabilities/
GET/admin/capabilities/:server_idGet Server Capabilitiesresource proxy-smart://admin/capabilities/{server_id}
GET/admin/capabilities/:server_id/:resource_typeGet Resource Type Capabilitiesresource proxy-smart://admin/capabilities/{server_id}/{resource_type}
POST/admin/capabilities/refreshRefresh Capabilities Cachetool create_admin_capabilities_refresh

/admin/client-policies ​

MethodPathSummaryMCP
POST/admin/client-policies/cimd/configureConfigure CIMDtool create_admin_client-policies_cimd_configure
GET/admin/client-policies/cimd/statusGet CIMD Statusresource proxy-smart://admin/client-policies/cimd/status
GET/admin/client-policies/policiesList Client Policiesresource proxy-smart://admin/client-policies/policies
PUT/admin/client-policies/policiesUpdate Client Policiestool update_admin_client-policies_policies
GET/admin/client-policies/profilesList Client Profilesresource proxy-smart://admin/client-policies/profiles
PUT/admin/client-policies/profilesUpdate Client Profilestool update_admin_client-policies_profiles

/admin/client-registration ​

MethodPathSummaryMCP
POST/admin/client-registration/reset-defaultsReset Client Registration Settings to Defaultstool create_admin_client-registration_reset-defaults
GET/admin/client-registration/settingsGet Dynamic Client Registration Settingsresource proxy-smart://admin/client-registration/settings
PUT/admin/client-registration/settingsUpdate Dynamic Client Registration Settingstool update_admin_client-registration_settings
MethodPathSummaryMCP
POST/admin/consent/cache/cleanupCleanup Expired Consent Cache Entriestool create_admin_consent_cache_cleanup
POST/admin/consent/cache/invalidateInvalidate Consent Cachetool create_admin_consent_cache_invalidate
GET/admin/consent/cache/statsGet Consent Cache Statisticsresource proxy-smart://admin/consent/cache/stats
GET/admin/consent/configGet Consent Configurationresource proxy-smart://admin/consent/config
PUT/admin/consent/configUpdate Consent Configurationtool update_admin_consent_config
GET/admin/consent/ialGet IAL Configurationresource proxy-smart://admin/consent/ial
PUT/admin/consent/ialUpdate IAL Configurationtool update_admin_consent_ial
POST/admin/consent/r4-migrationMigrate Consents to the R4 Rule Shapetool create_admin_consent_r4-migration
POST/admin/consent/webhookConsent Update Webhooktool create_admin_consent_webhook

/admin/dicom-servers ​

MethodPathSummaryMCP
GET/admin/dicom-servers/List DICOM Serversresource proxy-smart://admin/dicom-servers/
POST/admin/dicom-servers/Add DICOM Servertool create_admin_dicom-servers_
GET/admin/dicom-servers/:server_idGet DICOM Serverresource proxy-smart://admin/dicom-servers/{server_id}
PUT/admin/dicom-servers/:server_idUpdate DICOM Servertool update_admin_dicom-servers_server_id
DELETE/admin/dicom-servers/:server_idDelete DICOM Servertool delete_admin_dicom-servers_server_id
GET/admin/dicom-servers/:server_id/statusDICOM Server Statusresource proxy-smart://admin/dicom-servers/{server_id}/status
GET/admin/dicom-servers/viewer-appGet DICOM Viewer Appresource proxy-smart://admin/dicom-servers/viewer-app
PUT/admin/dicom-servers/viewer-appSet DICOM Viewer Apptool update_admin_dicom-servers_viewer-app

/admin/fhir-servers ​

MethodPathSummaryMCP
GET/admin/fhir-servers/List FHIR Servers (admin)resource proxy-smart://admin/fhir-servers/
POST/admin/fhir-servers/Add New FHIR Servertool create_admin_fhir-servers_
GET/admin/fhir-servers/:server_idGet FHIR Server (admin)resource proxy-smart://admin/fhir-servers/{server_id}
PUT/admin/fhir-servers/:server_idUpdate FHIR Servertool update_admin_fhir-servers_server_id
DELETE/admin/fhir-servers/:server_idDelete FHIR Servertool delete_admin_fhir-servers_server_id
PATCH/admin/fhir-servers/:server_id/mcpToggle MCP Endpoint (deprecated)tool update_admin_fhir-servers_server_id_mcp
GET/admin/fhir-servers/:server_id/mtlsGet mTLS Configurationresource proxy-smart://admin/fhir-servers/{server_id}/mtls
PUT/admin/fhir-servers/:server_id/mtlsUpdate mTLS Configurationtool update_admin_fhir-servers_server_id_mtls
POST/admin/fhir-servers/:server_id/mtls/certificatesUpload Certificatetool create_admin_fhir-servers_server_id_mtls_certificates
POST/admin/fhir-servers/:server_id/refreshRefresh FHIR Server Metadatatool create_admin_fhir-servers_server_id_refresh
PATCH/admin/fhir-servers/:server_id/strict-capabilitiesToggle Strict Capability Enforcementtool update_admin_fhir-servers_server_id_strict-capabilities

/admin/healthcare-users ​

MethodPathSummaryMCP
GET/admin/healthcare-users/List Healthcare Usersresource proxy-smart://admin/healthcare-users/
POST/admin/healthcare-users/Create Healthcare Usertool create_admin_healthcare-users_
GET/admin/healthcare-users/:userIdGet Healthcare Userresource proxy-smart://admin/healthcare-users/{userId}
PUT/admin/healthcare-users/:userIdUpdate Healthcare Usertool update_admin_healthcare-users_userId
DELETE/admin/healthcare-users/:userIdDelete Healthcare Usertool delete_admin_healthcare-users_userId
POST/admin/healthcare-users/:userId/client-roles/:clientIdAdd Client Roles to Usertool create_admin_healthcare-users_userId_client-roles_clientId
DELETE/admin/healthcare-users/:userId/client-roles/:clientId/:roleNameRemove Client Role from Usertool delete_admin_healthcare-users_client-roles
GET/admin/healthcare-users/:userId/federated-identitiesList Federated Identitiesresource proxy-smart://admin/healthcare-users/{userId}/federated-identities
POST/admin/healthcare-users/:userId/federated-identities/:providerLink Federated Identitytool create_admin_healthcare-users_federated-identities
DELETE/admin/healthcare-users/:userId/federated-identities/:providerUnlink Federated Identitytool delete_admin_healthcare-users_federated-identities
POST/admin/healthcare-users/:userId/realm-rolesAdd Realm Roles to Usertool create_admin_healthcare-users_userId_realm-roles
DELETE/admin/healthcare-users/:userId/realm-roles/:roleNameRemove Realm Role from Usertool delete_admin_healthcare-users_userId_realm-roles_roleName

/admin/idps ​

MethodPathSummaryMCP
GET/admin/idps/List Identity Providersresource proxy-smart://admin/idps/
POST/admin/idps/Create Identity Providertool create_admin_idps_
GET/admin/idps/:aliasGet Identity Providerresource proxy-smart://admin/idps/{alias}
PUT/admin/idps/:aliasUpdate Identity Providertool update_admin_idps_alias
DELETE/admin/idps/:aliasDelete Identity Providertool delete_admin_idps_alias
GET/admin/idps/:alias/mapper-statusGet Mapper Status For Providerresource proxy-smart://admin/idps/{alias}/mapper-status
GET/admin/idps/:alias/mapper-typesList Identity Provider Mapper Typesresource proxy-smart://admin/idps/{alias}/mapper-types
GET/admin/idps/:alias/mappersList Identity Provider Mappersresource proxy-smart://admin/idps/{alias}/mappers
POST/admin/idps/:alias/mappersCreate Identity Provider Mappertool create_admin_idps_alias_mappers
PUT/admin/idps/:alias/mappers/:mapperIdUpdate Identity Provider Mappertool update_admin_idps_alias_mappers_mapperId
DELETE/admin/idps/:alias/mappers/:mapperIdDelete Identity Provider Mappertool delete_admin_idps_alias_mappers_mapperId
POST/admin/idps/:alias/mappers/fixProvision Missing Identity Provider Mapperstool create_admin_idps_alias_mappers_fix
POST/admin/idps/:alias/test-connectionTest Identity Provider Connectiontool create_admin_idps_alias_test-connection
GET/admin/idps/countGet Identity Providers Countresource proxy-smart://admin/idps/count
GET/admin/idps/mapper-statusGet Identity Provider Mapper Statusresource proxy-smart://admin/idps/mapper-status

/admin/keycloak-config ​

MethodPathSummaryMCP
POST/admin/keycloak-config/configureConfigure Keycloak Connectiontool create_admin_keycloak-config_configure
GET/admin/keycloak-config/session-settingsGet Realm Session Lifetimesresource proxy-smart://admin/keycloak-config/session-settings
PUT/admin/keycloak-config/session-settingsUpdate Realm Session Lifetimestool update_admin_keycloak-config_session-settings
GET/admin/keycloak-config/statusGet Keycloak Admin Configurationresource proxy-smart://admin/keycloak-config/status
POST/admin/keycloak-config/testTest Keycloak Connectiontool create_admin_keycloak-config_test

/admin/mcp-endpoint ​

MethodPathSummaryMCP
GET/admin/mcp-endpoint/Get MCP endpoint statusresource proxy-smart://admin/mcp-endpoint/
PATCH/admin/mcp-endpoint/Update MCP endpoint configurationtool update_admin_mcp-endpoint_
PUT/admin/mcp-endpoint/tools/:toolNameToggle a single MCP tooltool update_admin_mcp-endpoint_tools_toolName

/admin/monitoring ​

MethodPathSummaryMCP
GET/admin/monitoring/admin-audit/analyticsGet Admin Audit Analyticsresource proxy-smart://admin/monitoring/admin-audit/analytics
GET/admin/monitoring/admin-audit/eventsGet Admin Audit Eventsresource proxy-smart://admin/monitoring/admin-audit/events
GET/admin/monitoring/auth/analyticsGet Auth Analyticsresource proxy-smart://admin/monitoring/auth/analytics
GET/admin/monitoring/auth/eventsGet Auth Eventsresource proxy-smart://admin/monitoring/auth/events
GET/admin/monitoring/consent/analyticsGet Consent Analyticsresource proxy-smart://admin/monitoring/consent/analytics
GET/admin/monitoring/consent/eventsGet Consent Eventsresource proxy-smart://admin/monitoring/consent/events
GET/admin/monitoring/consent/events/exportExport Consent Eventsresource proxy-smart://admin/monitoring/consent/events/export
GET/admin/monitoring/consent/patients/:patientId/access-logPatient Access Logresource proxy-smart://admin/monitoring/consent/patients/{patientId}/access-log
GET/admin/monitoring/email/analyticsGet Email Analyticsresource proxy-smart://admin/monitoring/email/analytics
GET/admin/monitoring/email/eventsGet Email Eventsresource proxy-smart://admin/monitoring/email/events
GET/admin/monitoring/fhir-proxy/analyticsGet FHIR Proxy Analyticsresource proxy-smart://admin/monitoring/fhir-proxy/analytics
GET/admin/monitoring/fhir-proxy/eventsGet FHIR Proxy Eventsresource proxy-smart://admin/monitoring/fhir-proxy/events
GET/admin/monitoring/fhir/checksGet FHIR Health Checksresource proxy-smart://admin/monitoring/fhir/checks
GET/admin/monitoring/fhir/summariesGet FHIR Uptime Summariesresource proxy-smart://admin/monitoring/fhir/summaries
GET/admin/monitoring/oauth/analyticsGet OAuth Analyticsresource proxy-smart://admin/monitoring/oauth/analytics
GET/admin/monitoring/oauth/analytics/exportExport Analytics Dataresource proxy-smart://admin/monitoring/oauth/analytics/export
GET/admin/monitoring/oauth/eventsGet OAuth Eventsresource proxy-smart://admin/monitoring/oauth/events
GET/admin/monitoring/oauth/events/exportExport Events Dataresource proxy-smart://admin/monitoring/oauth/events/export
GET/admin/monitoring/oauth/healthGet System Healthresource proxy-smart://admin/monitoring/oauth/health

/admin/organizations ​

MethodPathSummaryMCP
GET/admin/organizations/List Organizationsresource proxy-smart://admin/organizations/
POST/admin/organizations/Create Organizationtool create_admin_organizations_
GET/admin/organizations/:orgIdGet Organizationresource proxy-smart://admin/organizations/{orgId}
PUT/admin/organizations/:orgIdUpdate Organizationtool update_admin_organizations_orgId
DELETE/admin/organizations/:orgIdDelete Organizationtool delete_admin_organizations_orgId
GET/admin/organizations/:orgId/brandingGet Organization Brandingresource proxy-smart://admin/organizations/{orgId}/branding
PUT/admin/organizations/:orgId/brandingUpdate Organization Brandingtool update_admin_organizations_orgId_branding
GET/admin/organizations/:orgId/membersList Organization Membersresource proxy-smart://admin/organizations/{orgId}/members
POST/admin/organizations/:orgId/membersAdd Membertool create_admin_organizations_orgId_members
DELETE/admin/organizations/:orgId/members/:userIdRemove Membertool delete_admin_organizations_orgId_members_userId
GET/admin/organizations/countCount Organizationsresource proxy-smart://admin/organizations/count

/admin/profile ​

MethodPathSummaryMCP
GET/admin/profile/Get my profileresource proxy-smart://admin/profile/
PUT/admin/profile/Update my profiletool update_admin_profile_
PUT/admin/profile/passwordChange my passwordtool update_admin_profile_password

/admin/restart ​

MethodPathSummaryMCP
POST/admin/restartRestart Servertool create_admin_restart

/admin/roles ​

MethodPathSummaryMCP
GET/admin/roles/List All Rolesresource proxy-smart://admin/roles/
POST/admin/roles/Create Healthcare Roletool create_admin_roles_
GET/admin/roles/:roleNameGet Healthcare Roleresource proxy-smart://admin/roles/{roleName}
PUT/admin/roles/:roleNameUpdate Healthcare Roletool update_admin_roles_roleName
DELETE/admin/roles/:roleNameDelete Healthcare Roletool delete_admin_roles_roleName
GET/admin/roles/:roleName/compositesList Realm Roles Granted By A Compositeresource proxy-smart://admin/roles/{roleName}/composites
POST/admin/roles/:roleName/compositesGrant Realm Roles Through A Compositetool create_admin_roles_roleName_composites
DELETE/admin/roles/:roleName/composites/:compositeNameRevoke A Realm Role From A Compositetool delete_admin_roles_roleName_composites_compositeName
GET/admin/roles/clients/:clientIdList Client Rolesresource proxy-smart://admin/roles/clients/{clientId}
POST/admin/roles/clients/:clientIdCreate Client Roletool create_admin_roles_clients_clientId
GET/admin/roles/clients/:clientId/:roleNameGet Client Roleresource proxy-smart://admin/roles/clients/{clientId}/{roleName}
PUT/admin/roles/clients/:clientId/:roleNameUpdate Client Roletool update_admin_roles_clients_clientId_roleName
DELETE/admin/roles/clients/:clientId/:roleNameDelete Client Roletool delete_admin_roles_clients_clientId_roleName

/admin/scope-mappers ​

MethodPathSummaryMCP
GET/admin/scope-mappers/Get SMART Scope Mapper Statusresource proxy-smart://admin/scope-mappers/
DELETE/admin/scope-mappers/:scopeId/:mapperIdDelete Protocol Mappertool delete_admin_scope-mappers_scopeId_mapperId
POST/admin/scope-mappers/fixFix Missing SMART Protocol Mapperstool create_admin_scope-mappers_fix

/admin/scope-sets ​

MethodPathSummaryMCP
GET/admin/scope-sets/List scope setsresource proxy-smart://admin/scope-sets/
POST/admin/scope-sets/Create scope settool create_admin_scope-sets_
GET/admin/scope-sets/:idGet scope set by IDresource proxy-smart://admin/scope-sets/{id}
PUT/admin/scope-sets/:idUpdate scope settool update_admin_scope-sets_id
DELETE/admin/scope-sets/:idDelete scope settool delete_admin_scope-sets_id

/admin/shutdown ​

MethodPathSummaryMCP
POST/admin/shutdownShutdown Servertool create_admin_shutdown

/admin/smart-access-control ​

MethodPathSummaryMCP
GET/admin/smart-access-control/configGet SMART Access Control Configurationresource proxy-smart://admin/smart-access-control/config
PUT/admin/smart-access-control/configUpdate SMART Access Control Configurationtool update_admin_smart-access-control_config

/admin/smart-apps ​

MethodPathSummaryMCP
GET/admin/smart-apps/List SMART on FHIR Applicationsresource proxy-smart://admin/smart-apps/
POST/admin/smart-apps/Create SMART on FHIR Applicationtool create_admin_smart-apps_
GET/admin/smart-apps/:clientIdGet SMART on FHIR Applicationresource proxy-smart://admin/smart-apps/{clientId}
PUT/admin/smart-apps/:clientIdUpdate SMART on FHIR Applicationtool update_admin_smart-apps_clientId
DELETE/admin/smart-apps/:clientIdDelete SMART on FHIR Applicationtool delete_admin_smart-apps_clientId
GET/admin/smart-apps/:clientId/mappersList Client Protocol Mappersresource proxy-smart://admin/smart-apps/{clientId}/mappers
POST/admin/smart-apps/:clientId/mappersCreate Client Protocol Mappertool create_admin_smart-apps_clientId_mappers
PUT/admin/smart-apps/:clientId/mappers/:mapperIdUpdate Client Protocol Mappertool update_admin_smart-apps_clientId_mappers_mapperId
DELETE/admin/smart-apps/:clientId/mappers/:mapperIdDelete Client Protocol Mappertool delete_admin_smart-apps_clientId_mappers_mapperId
POST/admin/smart-apps/:clientId/mappers/audienceAdd Audience Mappertool create_admin_smart-apps_clientId_mappers_audience

/admin/smart-config ​

MethodPathSummaryMCP
POST/admin/smart-config/reconcile-client-home-urlsReconcile client home URLstool create_admin_smart-config_reconcile-client-home-urls
POST/admin/smart-config/reconcile-resource-indicatorsReconcile RFC 8707 resource indicatorstool create_admin_smart-config_reconcile-resource-indicators
POST/admin/smart-config/refreshRefresh SMART Configuration Cachetool create_admin_smart-config_refresh

/admin/smart-scopes ​

MethodPathSummaryMCP
GET/admin/smart-scopes/List SMART Scopesresource proxy-smart://admin/smart-scopes/
POST/admin/smart-scopes/Create SMART Scopetool create_admin_smart-scopes_
DELETE/admin/smart-scopes/:scopeIdDelete SMART Scopetool delete_admin_smart-scopes_scopeId
POST/admin/smart-scopes/batchBatch Create SMART Scopestool create_admin_smart-scopes_batch

/admin/status ​

MethodPathSummaryMCP
GET/admin/statusAdmin System Statusresource proxy-smart://admin/status

/admin/user-federation ​

MethodPathSummaryMCP
GET/admin/user-federation/List LDAP Federationsresource proxy-smart://admin/user-federation/
POST/admin/user-federation/Create LDAP Federationtool create_admin_user-federation_
GET/admin/user-federation/:idGet LDAP Federationresource proxy-smart://admin/user-federation/{id}
PUT/admin/user-federation/:idUpdate LDAP Federationtool update_admin_user-federation_id
DELETE/admin/user-federation/:idDelete LDAP Federationtool delete_admin_user-federation_id
GET/admin/user-federation/:id/mapper-typesList LDAP Mapper Typesresource proxy-smart://admin/user-federation/{id}/mapper-types
GET/admin/user-federation/:id/mappersList LDAP Mappersresource proxy-smart://admin/user-federation/{id}/mappers
POST/admin/user-federation/:id/mappersCreate LDAP Mappertool create_admin_user-federation_id_mappers
PUT/admin/user-federation/:id/mappers/:mapperIdUpdate LDAP Mappertool update_admin_user-federation_id_mappers_mapperId
DELETE/admin/user-federation/:id/mappers/:mapperIdDelete LDAP Mappertool delete_admin_user-federation_id_mappers_mapperId
POST/admin/user-federation/:id/remove-importedRemove Imported Userstool create_admin_user-federation_id_remove-imported
POST/admin/user-federation/:id/syncSync LDAP Userstool create_admin_user-federation_id_sync
POST/admin/user-federation/:id/unlinkUnlink Federated Userstool create_admin_user-federation_id_unlink
GET/admin/user-federation/countGet User Federation Countresource proxy-smart://admin/user-federation/count
POST/admin/user-federation/test-authenticationTest LDAP Authenticationtool create_admin_user-federation_test-authentication
POST/admin/user-federation/test-connectionTest LDAP Connectiontool create_admin_user-federation_test-connection

Proxy Smart — Healthcare Interoperability Platform