OnlineMeetingArtifact.Read.Chat
Merill's Note
For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the
OnlineMeetingArtifact.Read.Chatpermission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReportcommand. See How To: Run a quick OAuth app audit of your tenant
| Category | Application | Delegated |
|---|---|---|
| Identifier | - | - |
| DisplayText | - | - |
| Description | - | - |
| AdminConsentRequired | - | - |
Graph Methods
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods | |
|---|---|
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods | |
|---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- attendanceRecord
- meetingAttendanceReport
- onlineMeeting
- virtualEvent
- virtualEventSession
- virtualEventTownhall
- virtualEventWebinar
Graph reference: attendanceRecord
| Property | Type | Description |
|---|---|---|
| attendanceIntervals | attendanceInterval collection | List of time periods between joining and leaving a meeting. |
| emailAddress | String | Email address of the user associated with this attendance record. |
| externalRegistrationInformation | virtualEventExternalRegistrationInformation | The external information for a virtualEventRegistration. |
| identity | identity | The identity of the user associated with this attendance record. The specific type is one of the following derived types of identity, depending on the user type: communicationsUserIdentity, azureCommunicationServicesUserIdentity. |
| registrationId | String | Unique identifier of a virtualEventRegistration that is available to all participants registered for the virtualEventWebinar. |
| role | String | Role of the attendee. Possible values are: None, Attendee, Presenter, and Organizer. |
| totalAttendanceInSeconds | Int32 | Total duration of the attendances in seconds. |
Graph reference: meetingAttendanceReport
| Property | Type | Description |
|---|---|---|
| externalEventInformation | virtualEventExternalInformation collection | The external information of a virtual event. Returned only for event organizers or coorganizers. Read-only. |
| id | String | Unique identifier for the attendance report. Read-only. |
| meetingEndDateTime | DateTimeOffset | UTC time when the meeting ended. Read-only. |
| meetingStartDateTime | DateTimeOffset | UTC time when the meeting started. Read-only. |
| totalParticipantCount | Int32 | Total number of participants. Read-only. |
Graph reference: onlineMeeting
| Property | Type | Description |
|---|---|---|
| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from onlineMeetingBase. |
| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from onlineMeetingBase. |
| allowBreakoutRooms | Boolean | Indicates whether breakout rooms are enabled for the meeting. Inherited from onlineMeetingBase. |
| allowCopyingAndSharingMeetingContent | Boolean | Indicates whether the ability to copy and share meeting content is enabled for the meeting. Inherited from onlineMeetingBase. |
| allowedLobbyAdmitters | allowedLobbyAdmitterRoles | Specifies the users who can admit from the lobby. Possible values are: organizerAndCoOrganizersAndPresenters, organizerAndCoOrganizers, unknownFutureValue. Inherited from onlineMeetingBase. |
| allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. Possible values are listed in the following table. Inherited from onlineMeetingBase. |
| allowLiveShare | meetingLiveShareOptions | Indicates whether live share is enabled for the meeting. Possible values are: enabled, disabled, unknownFutureValue. Inherited from onlineMeetingBase. |
| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. Inherited from onlineMeetingBase. |
| allowParticipantsToChangeName | Boolean | Specifies if participants are allowed to rename themselves in an instance of the meeting. Inherited from onlineMeetingBase. |
| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the meeting. Inherited from onlineMeetingBase. |
| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. Inherited from onlineMeetingBase. |
| allowRecording | Boolean | Indicates whether recording is enabled for the meeting. Inherited from onlineMeetingBase. |
| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. Inherited from onlineMeetingBase. |
| allowTranscription | Boolean | Indicates whether transcription is enabled for the meeting. Inherited from onlineMeetingBase. |
| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the meeting. Inherited from onlineMeetingBase. |
| audioConferencing | audioConferencing | The phone access (dial-in) information for an online meeting. Read-only. Inherited from onlineMeetingBase. |
| chatInfo | chatInfo | The chat information associated with this online meeting. Inherited from onlineMeetingBase. |
| chatRestrictions | chatRestrictions | Specifies the configuration settings for meeting chat restrictions. Inherited from onlineMeetingBase. |
| creationDateTime | DateTime | The meeting creation time in UTC. Read-only. |
| endDateTime | DateTime | The meeting end time in UTC. Required when you create an online meeting. |
| externalId | String | The external ID that is a custom identifier. Optional. |
| joinWebUrl | String | The join URL of the online meeting. The format of the URL may change; therefore, users shouldn't rely on any information extracted from parsing the URL. Read-only. Inherited from onlineMeetingBase. |
| participants | meetingParticipants | The participants associated with the online meeting, including the organizer and the attendees. |
| subject | String | The subject of the online meeting. Required when you create an online meeting. |
| id | String | The default ID associated with the online meeting. Read-only. Inherited from onlineMeetingBase. |
| isEndToEndEncryptionEnabled | Boolean | Indicates whether end-to-end encryption (E2EE) is enabled for the online meeting. Inherited from onlineMeetingBase. |
| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from onlineMeetingBase. |
| joinInformation | itemBody | The join information in the language and locale variant specified in the Accept-Language request HTTP header. Read-only. Inherited from onlineMeetingBase. |
| joinMeetingIdSettings | joinMeetingIdSettings | Specifies the joinMeetingId, the meeting passcode, and the requirement for the passcode. Once an onlineMeeting is created, the joinMeetingIdSettings can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from onlineMeetingBase. |
| lobbyBypassSettings | lobbyBypassSettings | Specifies which participants can bypass the meeting lobby. Inherited from onlineMeetingBase. |
| meetingTemplateId | String | The ID of the meeting template. |
| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. Inherited from onlineMeetingBase. |
| shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode | Specifies whether meeting chat history is shared with participants. Possible values are: all, none, unknownFutureValue. Inherited from onlineMeetingBase. |
| startDateTime | DateTime | The meeting start time in UTC. |
| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from onlineMeetingBase. |
| watermarkProtection | watermarkProtectionValues | Specifies whether the client application should apply a watermark a content type. Inherited from onlineMeetingBase. |
| attendeeReport (deprecated) | Stream | The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| broadcastSettings (deprecated) | broadcastMeetingSettings | Settings related to a live event. |
| isBroadcast (deprecated) | Boolean | Indicates whether this meeting is a Teams live event. |
Graph reference: virtualEvent
| Property | Type | Description |
|---|---|---|
| createdBy | communicationsIdentitySet | The identity information for the creator of the virtual event. Inherited from virtualEvent. |
| description | itemBody | A description of the virtual event. |
| displayName | String | The display name of the virtual event. |
| endDateTime | dateTimeTimeZone | The end time of the virtual event. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. |
| externalEventInformation | virtualEventExternalInformation collection | The external information of a virtual event. Returned only for event organizers or coorganizers; otherwise, null. |
| id | String | The unique identifier of the virtual event. Inherited from entity. |
| settings | virtualEventSettings | The virtual event settings. |
| startDateTime | dateTimeTimeZone | Start time of the virtual event. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. |
| status | virtualEventStatus | The status of the virtual event. The possible values are: draft, published, canceled, and unknownFutureValue. |
Graph reference: virtualEventSession
| Property | Type | Description |
|---|---|---|
| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from onlineMeetingBase. |
| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from onlineMeetingBase. |
| allowBreakoutRooms | Boolean | Indicates whether breakout rooms are enabled for the virtual event session. Inherited from onlineMeetingBase. |
| allowCopyingAndSharingMeetingContent | Boolean | Indicates whether the ability to copy and share meeting content is enabled for the virtual event session. Inherited from onlineMeetingBase. |
| allowedLobbyAdmitters | allowedLobbyAdmitterRoles | Specifies the users who can admit from the lobby. Possible values are: organizerAndCoOrganizersAndPresenters, organizerAndCoOrganizers, unknownFutureValue. Inherited from onlineMeetingBase. |
| allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a virtual event session. Inherited from onlineMeetingBase. |
| allowLiveShare | meetingLiveShareOptions | Indicates whether live share is enabled for the virtual event session. Possible values are: enabled, disabled, unknownFutureValue. Inherited from onlineMeetingBase. |
| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. Inherited from onlineMeetingBase. |
| allowParticipantsToChangeName | Boolean | Specifies whether participants are allowed to rename themselves in an instance of the meeting. Inherited from onlineMeetingBase. |
| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the virtual event session. Inherited from onlineMeetingBase. |
| allowRecording | Boolean | Indicates whether recording is enabled for the virtual event session. Inherited from onlineMeetingBase. |
| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the virtual event session. Inherited from onlineMeetingBase. |
| allowTranscription | Boolean | Indicates whether transcription is enabled for the virtual event session. Inherited from onlineMeetingBase. |
| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the virtual event session. Inherited from onlineMeetingBase. |
| anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity is anonymized in the virtual event session. Possible values are: attendee. The attendee value can't be removed through a PATCH operation once added. Inherited from onlineMeetingBase. |
| audioConferencing | audioConferencing | The phone access (dial-in) information for the virtual event session. Read-only. Inherited from onlineMeetingBase. |
| chatRestrictions | chatRestrictions | Specifies the configuration settings for meeting chat restrictions. Inherited from onlineMeetingBase. |
| chatInfo | chatInfo | The chat information associated with the virtual event session. Inherited from onlineMeetingBase. |
| endDateTime | DateTimeTimeZone | The virtual event session end time. |
| id | String | The unique identifier of the virtual event session. Read-only. Inherited from onlineMeetingBase. |
| isEndToEndEncryptionEnabled | Boolean | Indicates whether end-to-end encryption (E2EE) is enabled for the virtual event session. Inherited from onlineMeetingBase. |
| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from onlineMeetingBase. |
| joinInformation | itemBody | The join information of the virtual event session. Read-only. Inherited from onlineMeetingBase. |
| joinMeetingIdSettings | joinMeetingIdSettings | Specifies the joinMeetingId, the meeting passcode, and the requirement for the passcode. Inherited from onlineMeetingBase. |
| joinWebUrl | String | The join URL of the virtual event session. Read-only. Inherited from onlineMeetingBase. |
| lobbyBypassSettings | lobbyBypassSettings | Specifies which participants can bypass the meeting lobby. Inherited from onlineMeetingBase. |
| recordAutomatically | Boolean | Indicates whether to record the virtual event session automatically. Inherited from onlineMeetingBase. |
| startDateTime | DateTimeTimeZone | The virtual event session start time. |
| subject | String | The subject of the virtual event session. Inherited from onlineMeetingBase. |
| videoOnDemandWebUrl | String | The URL of the video on demand (VOD) for Microsoft Teams events that allows webinar and town hall organizers to quickly publish and share event recordings. |
| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from onlineMeetingBase. |
| watermarkProtection | watermarkProtectionValues | Specifies whether the client application should apply a watermark to a content type. Inherited from onlineMeetingBase. |
Graph reference: virtualEventTownhall
| Property | Type | Description |
|---|---|---|
| audience | meetingAudience | The audience to whom the town hall is visible. Possible values are: everyone, organization, and unknownFutureValue. |
| coOrganizers | communicationsUserIdentity collection | Identity information of the coorganizers of the town hall. |
| createdBy | communicationsIdentitySet | Identity information of the creator of the town hall. Inherited from virtualEvent. Read-only. |
| description | itemBody | Description of the town hall. Inherited from virtualEvent. |
| displayName | String | Display name of the town hall. Inherited from virtualEvent. |
| endDateTime | dateTimeTimeZone | Date and time when the town hall ends. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. Inherited from virtualEvent. |
| externalEventInformation | virtualEventExternalInformation collection | The external information of a town hall. Returned only for event organizers or coorganizers; otherwise, null. |
| id | String | Unique identifier of the town hall. Inherited from entity. Read-only. |
| invitedAttendees | identity collection | The attendees invited to the town hall. The supported identities are: communicationsUserIdentity and communicationsGuestIdentity. |
| isInviteOnly | Boolean | Indicates whether the town hall is only open to invited people and groups within your organization. The isInviteOnly property can only be true if the value of the audience property is set to organization. |
| settings | virtualEventSettings | The virtual event settings. |
| startDateTime | dateTimeTimeZone | Date and time when the town hall starts. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. Inherited from virtualEvent. |
| status | virtualEventStatus | Status of the town hall. Possible values are: draft, published, canceled, and unknownFutureValue. Inherited from virtualEvent. |
Graph reference: virtualEventWebinar
| Property | Type | Description |
|---|---|---|
| audience | meetingAudience | To whom the webinar is visible. Possible values are: everyone, organization, and unknownFutureValue. |
| coOrganizers | communicationsUserIdentity collection | Identity information of coorganizers of the webinar. |
| createdBy | communicationsIdentitySet | Identity information for the creator of the webinar. Inherited from virtualEvent. |
| description | itemBody | Description of the webinar. Inherited from virtualEvent. |
| displayName | String | Display name of the webinar. Inherited from virtualEvent. |
| endDateTime | dateTimeTimeZone | End time of the webinar. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. |
| externalEventInformation | virtualEventExternalInformation collection | The external information of a webinar. Returned only for event organizers or coorganizers; otherwise, null. |
| startDateTime | dateTimeTimeZone | Start time of the webinar. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. |
| id | String | Unique identifier of the webinar. Inherited from entity. |
| settings | virtualEventSettings | The webinar settings. Inherited from virtualEvent. |
| status | virtualEventStatus | Status of the webinar. Possible values are: draft, published, canceled, and unknownFutureValue. Inherited from virtualEvent. |