Skip to main content

Authentication

In this section, we'll explore the two authentication methods supported by the MindKey Connector API: API Key authentication and Microsoft Entra ID authentication (formerly known as Microsoft Azure AD authentication). Understanding the differences between these authentication methods will help you choose the most suitable approach for your integration needs.

API Key Authentication​

API Key authentication is a simple and straightforward method for authenticating requests to the MindKey Connector API. With API Key authentication, you obtain a unique API key from the MindKey application, which serves as a credential for accessing the API endpoints. This key is provided in the HTTP Authorization header with the scheme ApiKey-v2.

Use Cases:

  • API Key authentication is suitable for scenarios where you need to authenticate access to the MindKey Connector API without relying on external identity providers.
  • It provides a straightforward authentication mechanism, making it easy to implement and manage within your applications.

Microsoft Entra ID Authentication​

Microsoft Entra ID authentication, formerly known as Microsoft Azure AD authentication, leverages the capabilities of Microsoft Entra ID for user authentication and authorization. With this method, users authenticate themselves using their Microsoft Entra ID credentials, and the MindKey Connector API validates these credentials against the Microsoft Entra ID identity provider.

Use Cases:

  • Microsoft Entra ID authentication is ideal for organizations already using Microsoft Entra ID as their identity provider, as it allows for seamless integration with existing authentication workflows.
  • It offers advanced security features such as multi-factor authentication and conditional access policies, enhancing the overall security posture of your integration.
  • Microsoft Entra ID authentication is necessary when you want to seamlessly integrate the MindKey Connector API into platforms such as Microsoft Power Platform, Microsoft Excel, or Microsoft Power BI. By using Microsoft Entra ID authentication, you can ensure a smooth and secure integration experience with these Microsoft services.

Choosing the Right Authentication Method​

When deciding between API Key authentication and Microsoft Entra ID authentication for your integration with the MindKey Connector API, consider the following factors:

  • Integration Requirements: Evaluate your integration requirements and determine whether you need a simple, self-contained authentication mechanism (API Key) or a more robust, centralized authentication solution (Microsoft Entra ID).
  • Existing Infrastructure: Consider your organization's existing infrastructure and identity management practices. If you already use Microsoft Entra ID for authentication across your systems, leveraging Microsoft Entra ID authentication may streamline your integration efforts.
  • Security Considerations: Assess the security requirements of your integration project. Microsoft Entra ID authentication offers advanced security features, making it the preferred choice for scenarios requiring heightened security measures.

By understanding the differences between API Key authentication and Microsoft Entra ID authentication, you can make an informed decision on the authentication method that best suits your integration needs.