microsoftgraph / microsoftgraph/msgraph-sdk-python

Python SDK Returning None for All Non-ID Value Fields

Open
#945 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Needs: Attention :wave: priority:p1 type:bug
Dominant language
Python
Stars
630
Forks
96
Avg merge
15h 20m
Merged PRs (30d)
3

Description

Describe the bug

In the Graph Explorer API I can run the following get request:

https://graph.microsoft.com/v1.0/me/memberOf?$search="displayName:{display_name}"&$select=displayName,id
Headers: ConsistencyLevel: eventual, Prefer: legacySearch=false

Below is my version in the Python SDK:

request_config = RequestConfiguration(
    options=[ResponseHandlerOption(NativeResponseHandler())]
)
request_config.headers.add("ConsistencyLevel", "eventual")
request_config.headers.add("Prefer", "legacySearch=false")

url = (f'https://graph.microsoft.com/v1.0/me/'
       f'memberOf?$search="displayName:{displayName}"&$select=displayName,id')

groups = await (self
                .user_client
                .me
                .with_url(url)
                .get(request_config))
groups_data = groups.json()
groups_value = groups_data['value']
return groups_value
Expected behavior

In the Graph API Explorer, I get the following result:

  {
      "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects(displayName,id)",
      "value": [
          {
              "@odata.type": "#microsoft.graph.group",
              "displayName": "{display_name}",
              "id": "{group_id}"
          }
      ]
  }

In the Python application, I get the following result:

[{'@odata.type': '#microsoft.graph.group', 'displayName': None, 'id': '{group_id}'}]

So basically, in the Python code, I am only getting the ID field value. All other field values of interest such as displayName are returned as None.

Is there some way to alter this code to make the non-ID field values displayable?

How to reproduce

Running the example code above should be sufficient to reproduce this scenario.

SDK Version

1.11.0

Latest version known to work for scenario above?

No response

Known Workarounds

No response

Debug output
Click to expand log ```
</details>


### Configuration

_No response_

### Other information

_No response_

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.

Research direction

Run the provided memberOf request with Python SDK 1.11.0, including RequestConfiguration, NativeResponseHandler, and the with_url().get call, then compare its JSON with the Graph Explorer result. Start by tracing how the response handler maps non-ID fields. Done means displayName and other selected values are preserved instead of returned as None.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.