Skip to main content

Upstream Azure AD Service Auth Policy

This policy adds a Authorization header to the upstream request that allows using Azure AD to authenticate requests to your origin server. This is a useful means of securing your origin server so that only your Zuplo gateway can make requests against it.

Using this policy allows you to delegate authentication and authorization to your gateway without writing any code on your origin service. For instructions on how to configure Azure AD authentication see Azure's documentation.

Configuration

{
"name": "my-upstream-azure-ad-service-auth-inbound-policy",
"policyType": "upstream-azure-ad-service-auth-inbound",
"handler": {
"export": "UpstreamAzureAdServiceAuthInboundPolicy",
"module": "$import(@zuplo/runtime)",
"options": {
"activeDirectoryTenantId": "$env(AZURE_AD_TENANT_ID)",
"activeDirectoryClientId": "$env(AZURE_AD_CLIENT_ID)",
"activeDirectoryClientSecret": "$env(AZURE_AD_CLIENT_SECRET)"
}
}
}
  • name the name of your policy instance. This is used as a reference in your routes.
  • policyType the identifier of the policy. This is used by the Zuplo UI. Value should be upstream-azure-ad-service-auth-inbound.
  • handler/export The name of the exported type. Value should be UpstreamAzureAdServiceAuthInboundPolicy.
  • handler/module the module containing the policy. Value should be $import(@zuplo/runtime).
  • handler/options The options for this policy:
    • activeDirectoryTenantId

      Azure Active Directory Tenant ID.

    • activeDirectoryClientId

      The Application (client) ID of the Azure AD App Registration.

    • activeDirectoryClientSecret

      The client secret of the Azure AD App Registration.

    • tokenRetries

      The number of times to retry fetching the token in the event of a failure. Defaults to 3.

    • expirationOffsetSeconds

      The number of seconds less than the token expiration to cache the token. Defaults to 300 seconds.

Read more about how policies work