[FEATURE REQ] Managed Identity support for Backends

Open
#725 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
azure, csharp

Research direction

Start by tracing how backend artifacts are extracted and how backendInformation.json serializes credentials; no source files or tests are identified in the issue. Compare the Azure managed identity fields shown in the portal with the artifact schema, then agree with maintainers on resourceId versus scope and verify the chosen configuration is included in extracted artifacts.

Written by the indexing model from the issue text.

Description

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.

Dominant language
C#
Stars
448
Forks
247
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/apiops

All issues in Azure/apiops

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.