Intel® Endpoint Management Assistant (Intel® EMA) Application Programming Interface (API) Guide

The Intel® EMA API Guide provides an outline for IT administrators and developers about the Intel® Endpoint Management Assistant (Intel® EMA) Application Programming Interface (API).

Note: PDF files require Adobe Acrobat Reader*.

Size: 207 KB
Date: August 2024

The PDF document provides general information for developers about the Intel® EMA Application Programming Interface (API). Detailed information about individual API URIs (such as descriptions and parameters) is contained in the following two HTML files. Latestswagger.html contains the API paths that always point to the latest released API version. In addition, the version 9 API URI details file, V9swagger.html, is provided as well. To view this detailed API URI information, download the desired HTML file and open it in a browser (Chrome works best).

Additional Intel EMA API Details:
The Intel® Endpoint Management Assistant (Intel® EMA) API is a set of programmatic interfaces designed to allow developers and IT administrators to interact with Intel® EMA. This API facilitates the management and monitoring of endpoint devices, automates administrative tasks, and integrates Intel® EMA capabilities into other software solutions.

Required Environment:
Intel® EMA server must be installed and running. 
Appropriate API access permissions and credentials are required.

Key Features and Capabilities:

Device Management: 
Manage and monitor endpoint devices remotely.
Automation: Automate administrative tasks such as software updates, device reboots, and configuration changes.
Integration: Integrate Intel® EMA functionalities into other software solutions and workflows.
Security: Securely manage devices with authentication and authorization mechanisms.

Use Cases:
Automated Device Provisioning: Automatically provision and configure new devices.
Remote Troubleshooting: Remotely diagnose and resolve issues on endpoint devices.
Software Deployment: Automate the deployment of software updates and patches.
Compliance Monitoring: Ensure devices comply with organizational policies and standards.

Getting Started:

Software Requirements: 
Intel® EMA server must be installed and running.
Access Permissions: Appropriate API access permissions and credentials are required. These permissions are outlined in detail in the Swagger JSON file.
API Key Generation: Generate an API key from the Intel® EMA console.
Configuration: Configure network settings and ensure the Intel® EMA server is accessible.

Authentication and Security:

Token Authentication: 
Uses a username and associated password for an EMA server account.
Active Directory Authentication: Uses credentials from Active Directory. It can only be used when Intel® EMA is installed with Windows* Domain Authentication mode, and the Intel® EMA server is joined to an Active Directory domain.
Client Credentials Authentication: Designed for API access to the EMA server. You need to create a client credentials account and client secret on the EMA server.
Microsoft* Entra Authentication: Introduced in Intel® EMA 1.9.0, this allows authentication for the Intel® EMA web interface using Azure Active Directory, known as Microsoft Entra.

Security Best Practices:
Use HTTPS: Always use HTTPS to encrypt data in transit.
Least Privilege: Grant the minimum necessary permissions to API users.
Password Hashing: Do not store passwords in clear text files.
Error Handling and Troubleshooting:

Common Error Codes:
400 Bad Request: Invalid input parameters.
401 Unauthorized: Invalid or missing authentication credentials.
404 Not Found: Resource not found.
500 Internal Server Error: The server encountered an unexpected condition.

Troubleshooting Tips:
Check API Key: Ensure the API key is valid and has the necessary permissions.
Validate Input: Verify that input parameters are correct and properly formatted.
Network Issues: Ensure there are no network connectivity issues between the client and the Intel® EMA server.