API Authentication

OAuth 2.0 client credentials and API keys, and how to choose between the two tenant setups.

Authentication schemes

Following authentication schemes is supported:

1. Oauth 2.0 token (client credentials flow​)
2. API Key

Oauth 2.0 client credentials flow​

This type of authentication is commonly used for server-to-server interactions. Lobyco implements OAuth 2.0 client credentials flow using Microsoft identity platform.

Sequence diagram

Configuration options

1. Lobyco tenant setup

   Lobyco creates an Azure App registration and share credentials with customer.

   This setup is recommended for scenarios where customers don’t operate their own Azure AD tenants.

2. Multi-tenant setup

   Customer imports Lobyco multi-tenant Azure AD app into their local tenant, and creates Azure App registration which enables full control over the secrets.

   This setup is recommended for scenarios where customers operate their own Azure AD tenants.

API key

While an API key alone isn’t the most robust form of authentication, it can still be useful in specific scenarios. For instance, in POS systems, where implementing efficient token management - such as caching and renewing tokens before expiration can be challenging, an API key might offer a practical solution.

As additional security measure, only specific IP addresses can be whitelisted to access Lobyco APIs.