REST API Authentication

Mirth® Connect by NextGen Healthcare M3 User Guide

M3 REST API

To access the M3 REST API: Before you begin Locate the M3 API which is documented at http://[m3host]:[m3port]/apibrowser/. A list of endpoints and their operations displays. This list shows each operation's HTTP method type, name, and description of function. Click an endpoint’s Expand Operations action to view the details of all its operations If desired, you can click a specific operation to view only that operation's details. Click the Try it out! button to execute the operation. REST API Authentication

Mirth® Connect by NextGen Healthcare User Guide

Authentication

Mirth® Connect supports both session-based cookie authentication and basic authentication. Basic Authentication: Simply include an Authorization header on all API requests, with basic credentials. Example (for admin/admin): Authorization: Basic YWRtaW46YWRtaW4= Session-Based Authentication: First, invoke the POST /users/_login endpoint, passing in your login credentials. If successful, the server will respond with a cookie (Set-Cookie header) like the following: Set-Cookie: JSESSIONID=uysqrtx9lle36ernybizstps;Path=/api;Secure Invoke the actual API endpoints of your choice, passing in the same cookie as a header: Cookie: JSESSIONID=uysqrtx9lle36ernybizstps;Path=/api;Secure Once you are done, make sure to call the POST /users/_logout endpoint, making sure to pass in the same cookie. Session-based Authentication is preferred since you only need to transmit your login credentials once. Note that the API documentation page invokes the same endpoint automatically when you login at the top: I

Multi-Factor Authentication User Guide

Client API Integrations

If you have built any custom integrations that use the REST API and require automatic, programmatic access, most likely you will want to exclude the user tied with the integration from MFA. No additional development is needed. See Excluding Users from MFA. If your custom integration still interacts with the user, you can elect to handle the multifactor signatures and codes manually. Because of the nature of multifactor authentication, Basic HTTP Auth is not supported when MFA is enabled. Instead invoke the /users/_login and /users/_logout endpoints to perform session-based auth. Using the TOTP API Integration Using the TOTP API integration. Using the Duo API Integration Using the Duo Universal API Integration Using the Duo Universal API integration Parent topic: Limitations of MFA

Mirth® Connect by NextGen Healthcare User Guide

Basic HTTP Authentication

Provides Basic Authentication support for HTTP-based source connectors. Item Name Description A Realm The protection space for this server. B Use Table Use Table: When selected, use the Credentials table (B) to populate credentials. To Use the Table Select New Double-click the Username field and enter a username for the credential. Double-click the Password field and enter a password for the credential. Note: At least one username/password pair is required for the credentials. Use Map: When selected, the Java map specified by the following variable will is used to populate credentials. The map must have String keys and either String or List<String> values. Parent topic: HTTP Authentication Settings

Mirth® Connect by NextGen Healthcare User Guide

Mirth® Connect REST API

The Administrator and Command Line Interface both use a well-defined API to communicate with the Mirth® Connect server. You can also use the same API to create custom integrations of your own. The API is documented at https://localhost:8443/api (change the IP / port as needed), or you can select View Client API in Administrator via Other Tasks: Select the View Client API action to open the API documentation in your default browser. Note: You may see a warning in your browser if your Mirth® Connect instance is still using the auto-generated self-signed certificate. You can select Advanced and allow the browser to continue to the page. To resolve this warning, look at Application Data Directory for instructions on installing your own certificate. Select the arrow button on one of the endpoint group rows to view its operations. This list shows the operation's HTTP method type, request URL, and a description for each endpoint. Select on one of the endpoint rows to view its details. If desi

Mirth® Connect by NextGen Healthcare User Guide

HTTP Authentication Settings

The HTTP Authentication Settings provide automatic user authentication with a variety of supported mechanisms. for HTTP-based source connectors. Choose an Authentication Type Basic HTTP Authentication Digest HTTP Authentication JavaScript HTTP Authentication Custom Java Class HTTP Authentication OAuth 2.0 Token Verification Parent topic: Source Tab

REST API Authentication

Recommendations

M3 REST API

Authentication

Client API Integrations

Basic HTTP Authentication

Mirth® Connect REST API

HTTP Authentication Settings

M3 REST API

Authentication

Client API Integrations

Basic HTTP Authentication

Mirth® Connect REST API

HTTP Authentication Settings