microsoftgraph / microsoftgraph/msgraph-sdk-python

Add members using patch method does not add users to group

Open
#611 6 comments 0 reactions 1 assignee View on GitHub

@shemogumbe is already working on this.

Since Aug 29, 2024.

bug type:documentation
Dominant language
Python
Stars
630
Forks
96
Avg merge
15h 20m
Merged PRs (30d)
3

Description

Title
Add members using patch method does not add users to group.

Environment
Python Version: 3.10.12
msgraph-sdk version: 1.1.0
OS: Ubuntu 22.04

Stack trace (if available) Screenshot or formatted copy and paste of your stack trace.
N/A

Describe the bug A clear and concise description of what the bug is.

I have the following methods to add a single and multiple users to a group in my AAD B2C tenant. The post method works, and the user is added to the AAD group. The patch method does not work, it returns None and does not raise any exception. I tried the same payload with my user Ids using the MS Graph explorer and users are added successfully. The service principal has full Group, GroupMember and User permissions in the MS Graph API.

async def add_group_member(group_id: str, user_id: str) -> bool:
    """Adds a single user to a group."""
    try:
        if not user_id:
            return False
        
        request_body = ReferenceCreate(odata_id = f'https://graph.microsoft.com/v1.0/directoryObjects/{user_id}')
        await GRAPH_CLIENT.groups.by_group_id(group_id).members.ref.post(request_body)

        return True
    except Exception as e:
        raise e

async def add_group_members(group_id: str, user_ids: List[str]) -> bool:
    """Adds users to a group."""
    try:
        if not user_ids:
            return False
        elif len(user_ids) > 20:
            raise Exception("You can only add 20 users at a time.")
        elif len(user_ids) == 1:
            return await self.add_group_member(group_id, user_ids[0])

        request_body = Group(
            additional_data = {
                "members@odata_bind" : [f'https://graph.microsoft.com/v1.0/directoryObjects/{user_id}' for user_id in user_ids]
            }
        )
        await GRAPH_CLIENT.groups.by_group_id(group_id).patch(request_body)

        return True
    except Exception as e:
        raise e

To Reproduce Steps to reproduce the behavior:
GRAPH_CLIENT = ClientSecretCredentials(...)
add_group_members(group_id, user_ids)

Expected behavior A clear and concise description of what you expected to happen.
Multiple groups added to the group in a single patch request.

Screenshots If applicable, add screenshots to help explain your problem.
N/A

Additional context Add any other context about the problem here.
N/A

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.