Skip to content

Fix document for using SystemAssigned managed identity #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 21, 2024
Merged

Fix document for using SystemAssigned managed identity #764

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions msal/managed_identity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def __init__(
self,
managed_identity: Union[
dict,
ManagedIdentity, # Could use Type[ManagedIdentity] but it is deprecatred in Python 3.9+
ManagedIdentity, # Could use Type[ManagedIdentity] but it is deprecated in Python 3.9+
SystemAssignedManagedIdentity,
UserAssignedManagedIdentity,
],
Expand Down Expand Up @@ -206,7 +206,7 @@ def __init__(
you may use an environment variable (such as MY_MANAGED_IDENTITY_CONFIG)
to store a json blob like
``{"ManagedIdentityIdType": "ClientId", "Id": "foo"}`` or
``{"ManagedIdentityIdType": "SystemAssignedManagedIdentity", "Id": null})``.
Copy link
Contributor Author

@jiasli jiasli Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ) symbol is not needed.

``{"ManagedIdentityIdType": "SystemAssigned", "Id": null}``.
Copy link
Contributor Author

@jiasli jiasli Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The detection logic is to compare ManagedIdentityIdType's value with "SystemAssigned":

microsoft-authentication-library-for-python/msal/managed_identity.py

Line 57 in 6e58a3f

and unknown.get(cls.ID_TYPE) == cls.SYSTEM_ASSIGNED)

microsoft-authentication-library-for-python/msal/managed_identity.py

Line 39 in 6e58a3f

SYSTEM_ASSIGNED = "SystemAssigned"

Using "SystemAssignedManagedIdentity" will trigger error:

microsoft-authentication-library-for-python/msal/managed_identity.py

Lines 239 to 240 in 6e58a3f

raise ManagedIdentityError(
f"Incorrect managed_identity: {managed_identity}")

The following app can load managed identity configuration dynamically::

import json, os, msal, requests
Expand Down Expand Up @@ -648,4 +648,3 @@ def _obtain_token_on_arc(http_client, endpoint, resource):
"error": "invalid_request",
"error_description": response.text,
}