List allowedMembers
Namespace: microsoft.graph
Get the list of conversationMembers who can access a shared channel.
This method does not return the following conversationMembers from the team:
- Users with
Guest
role - Users who are externally authenticated in the tenant
Note
The membership ID returned by the server must be treated as an opaque string. The client should not try to parse or make any assumptions about this ID.
The membership results can map to users from different tenants, as indicated in the response, in the future. The client should not assume that all members are only from the current tenant.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | ChannelMember.Read.All | ChannelMember.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | ChannelMember.Read.All | ChannelMember.ReadWrite.All |
Note: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of.
HTTP request
GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}/allowedMembers
Optional query parameters
This method supports the $select
and $count
OData query parameters to customize the response.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of conversationMember objects in the response body.
Examples
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/teams/893075dd-2487-5634-925f-022c42e20265/channels/19:[email protected]/sharedWithTeams/893075dd-2487-5634-925f-022c42e20265/allowedMembers
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.conversationMember",
"id": "MmFiOWM3OTYtMjkwMi00NWY4LWI3MTItN2M1YTYzY2Y0MWM0IyNlZWY5Y2IzNi0wNmRlLTQ2OWItODdjZC03MGY0Y2JlMzJkMTQ",
"roles": [
"owner"
],
"displayName": "Eric Solomon",
"userId": "eef9cb36-06de-469b-87cd-70f4cbe32d14",
"email": "[email protected]",
"tenantId": "df81db53-c7e2-418a-8803-0e68d4b88607"
},
{
"@odata.type": "#microsoft.graph.conversationMember",
"id": "MmFiOWMFxTYtMjkwMi00NWY4LWI3MTItN2M1YTYzY2Y0MWM0IyNlZWY5Y2IzNi0wNmRlLTQ2OWItODdjZC03MGY0Y2JlMzJkMTQ",
"roles": [
"user"
],
"displayName": "Caleb Foster",
"userId": "eef9cb36-06de-469b-87cd-70f4cbe32d14",
"email": "[email protected]",
"tenantId": "df81db53-c7e2-418a-8803-0e68d4b88607"
}
]
}