apiops icon indicating copy to clipboard operation
apiops copied to clipboard

[FEATURE REQ] Managed Identity support for Backends

Open Jeroen-VdB opened this issue 11 months ago • 3 comments

Please describe the feature.

In the Azure Portal I configured my backend credentials using a Managed Identity like this:

backend_screenshot

When I extract the artifacts, the managed identity configuration is not included in the backendInformation.json file:

{
  "properties": {
    "credentials": {
      "header": {},
      "query": {}
    },
    "protocol": "http",
    "tls": {
      "validateCertificateChain": true,
      "validateCertificateName": true
    },
    "url": "https://test.com"
  }
}

Would credentials be the place to store the managed identity properties? For example:

{
  "properties": {
    "credentials": {
      "managedIdentity": {
         "clientId":"my-managed-identity-client-id",
         "resourceId":"api://example-scope", // I used the name from the portal as a property name, which makes sense for Azure resource backends (e.g. Service Bus, Key Vault, etc), but from an app reg OAuth perspective the name "scope" would be better suited in my opinion
      },
    },
    "protocol": "http",
    "tls": {
      "validateCertificateChain": true,
      "validateCertificateName": true
    },
    "url": "https://test.com"
  }
}

I am open to contributing it myself if the maintainers find it a good idea and we can agree on the implementation details before I start developing.

Jeroen-VdB avatar Jan 31 '25 12:01 Jeroen-VdB

  Thank you for opening this issue! Please be patient while we will look into it and get back to you as this is an open source project. In the meantime make sure you take a look at the [closed issues](https://github.com/Azure/apiops/issues?q=is%3Aissue+is%3Aclosed) in case your question has already been answered. Don't forget to provide any additional information if needed (e.g. scrubbed logs, detailed feature requests,etc.).
  Whenever it's feasible, please don't hesitate to send a Pull Request (PR) our way. We'd greatly appreciate it, and we'll gladly assess and incorporate your changes.

github-actions[bot] avatar Jan 31 '25 12:01 github-actions[bot]

+1 for this, I was surprised this wasn't already here!

chrisbuttacavoliadec avatar Mar 24 '25 16:03 chrisbuttacavoliadec

+1 noticed my extraction pipeline isn't picking up the MI backend settings either.

riosengineer avatar Apr 10 '25 09:04 riosengineer