conversationMember resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a user in a team or a channel or a chat.
Base type for the following supported conversation member types:
- aadUserConversationMember
- anonymousGuestConversationMember
- azureCommunicationServicesUserConversationMember
- microsoftAccountUserConversationMember
- skypeForBusinessUserConversationMember
- skypeUserConversationMember
Methods
| Method | Return Type | Description |
|---|---|---|
| List team members | conversationMember collection | Get the list of members in the team. |
| Add team member | conversationMember | Add a new member to the team. |
| Add team members in bulk | actionResultPart collection | Add multiple members to the team in a single request. |
| Get team member | conversationMember collection | Get a member in the team. |
| Update team member's role | conversationMember | Change a member to an owner or back to a regular member. |
| Remove team member | None | Remove an existing member from the team. |
| Remove team members in bulk | actionResultPart collection | Remove multiple members from a team in a single request. |
| List channel members | conversationMember collection | Get the list of all members in a channel. |
| Add channel member | conversationMember | Add a member to a channel. Only supported for channel with membershipType of private. |
| Get channel member | conversationMember collection | Get a member in a channel. |
| Update channel member's role | conversationMember | Update the properties of a member of the channel. Only supported for channel with membershipType of private. |
| Remove channel member | None | Delete a member from a channel. Only supported for channelType of private. |
| List chat members | conversationMember collection | Get the list of all members in a chat. |
| Add chat member | Location header | Add a member to a chat. |
| Get chat member | conversationMember | Get a member in a chat. |
| Remove chat member | None | Remove a member from a chat. |
Properties
| Property | Type | Description |
|---|---|---|
| displayName | string | The display name of the user. |
| id | String | Read-only. Unique ID of the user. |
| roles | string collection | The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role. |
| visibleHistoryStartDateTime | DateTimeOffset | The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.conversationMember",
"displayName": "String",
"id": "String (identifier)",
"roles": ["String"],
"visibleHistoryStartDateTime": "String (timestamp)"
}