This product is not supported for your selected
Datadog site. (
).
이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우
언제든지 연락주시기 바랍니다.azure_ad_user
about_me
Type: STRING
Provider name: aboutMe
Description: A freeform text entry field for the user to describe themselves. Returned only on $select.
account_enabled
Type: BOOLEAN
Provider name: accountEnabled
Description: true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on $select. Supports $filter (eq, ne, not, and in).
activities
Type: UNORDERED_LIST_STRUCT
Provider name: activities
Description: The user’s activities across devices. Read-only. Nullable.
activation_url
Type: STRING
Provider name: activationUrl
Description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
activity_source_host
Type: STRING
Provider name: activitySourceHost
Description: Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.
app_activity_id
Type: STRING
Provider name: appActivityId
Description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
app_display_name
Type: STRING
Provider name: appDisplayName
Description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
content_url
Type: STRING
Provider name: contentUrl
Description: Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Set by the server. DateTime in UTC when the object was created on the server.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: Set by the server. DateTime in UTC when the object expired on the server.
fallback_url
Type: STRING
Provider name: fallbackUrl
Description: Optional. URL used to launch the activity in a web-based app, if available.
history_items
Type: UNORDERED_LIST_STRUCT
Provider name: historyItems
Description: Optional. NavigationProperty/Containment; navigation property to the activity’s historyItems.
active_duration_seconds
Type: INT32
Provider name: activeDurationSeconds
Description: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.
activity
Type: STRUCT
Provider name: activity
activation_url
Type: STRING
Provider name: activationUrl
Description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
activity_source_host
Type: STRING
Provider name: activitySourceHost
Description: Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.
app_activity_id
Type: STRING
Provider name: appActivityId
Description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
app_display_name
Type: STRING
Provider name: appDisplayName
Description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
content_url
Type: STRING
Provider name: contentUrl
Description: Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Set by the server. DateTime in UTC when the object was created on the server.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: Set by the server. DateTime in UTC when the object expired on the server.
fallback_url
Type: STRING
Provider name: fallbackUrl
Description: Optional. URL used to launch the activity in a web-based app, if available.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Set by the server. DateTime in UTC when the object was modified on the server.
status
Type: STRING
Provider name: status
Description: Set by the server. A status code used to identify valid objects. Values: active, updated, deleted, ignored.
user_timezone
Type: STRING
Provider name: userTimezone
Description: Optional. The timezone in which the user’s device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
visual_elements
Type: STRUCT
Provider name: visualElements
attribution
Type: STRUCT
Provider name: attribution
Description: Optional. JSON object used to represent an icon which represents the application used to generate the activity
add_image_query
Type: BOOLEAN
Provider name: addImageQuery
Description: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example – a high contrast image
alternate_text
Type: STRING
Provider name: alternateText
Description: Optional; alt-text accessible content for the image
alternative_text
Type: STRING
Provider name: alternativeText
icon_url
Type: STRING
Provider name: iconUrl
Description: Optional; URI that points to an icon which represents the application used to generate the activity
background_color
Type: STRING
Provider name: backgroundColor
Description: Optional. Background color used to render the activity in the UI - brand color for the application source of the activity. Must be a valid hex color
description
Type: STRING
Provider name: description
Description: Optional. Longer text description of the user’s unique activity (example: document name, first sentence, and/or metadata)
display_text
Type: STRING
Provider name: displayText
Description: Required. Short text description of the user’s unique activity (for example, document name in cases where an activity refers to document creation)
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Set by the server. DateTime in UTC when the object was created on the server.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.
last_active_date_time
Type: STRING
Provider name: lastActiveDateTime
Description: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Set by the server. DateTime in UTC when the object was modified on the server.
name
Type: STRING
Provider name: name
started_date_time
Type: STRING
Provider name: startedDateTime
Description: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.
status
Type: STRING
Provider name: status
Description: Set by the server. A status code used to identify valid objects. Values: active, updated, deleted, ignored.
user_timezone
Type: STRING
Provider name: userTimezone
Description: Optional. The timezone in which the user’s device used to generate the activity was located at activity creation time. Values supplied as Olson IDs in order to support cross-platform representation.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Set by the server. DateTime in UTC when the object was modified on the server.
name
Type: STRING
Provider name: name
status
Type: STRING
Provider name: status
Description: Set by the server. A status code used to identify valid objects. Values: active, updated, deleted, ignored.
user_timezone
Type: STRING
Provider name: userTimezone
Description: Optional. The timezone in which the user’s device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
visual_elements
Type: STRUCT
Provider name: visualElements
attribution
Type: STRUCT
Provider name: attribution
Description: Optional. JSON object used to represent an icon which represents the application used to generate the activity
add_image_query
Type: BOOLEAN
Provider name: addImageQuery
Description: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example – a high contrast image
alternate_text
Type: STRING
Provider name: alternateText
Description: Optional; alt-text accessible content for the image
alternative_text
Type: STRING
Provider name: alternativeText
icon_url
Type: STRING
Provider name: iconUrl
Description: Optional; URI that points to an icon which represents the application used to generate the activity
background_color
Type: STRING
Provider name: backgroundColor
Description: Optional. Background color used to render the activity in the UI - brand color for the application source of the activity. Must be a valid hex color
description
Type: STRING
Provider name: description
Description: Optional. Longer text description of the user’s unique activity (example: document name, first sentence, and/or metadata)
display_text
Type: STRING
Provider name: displayText
Description: Required. Short text description of the user’s unique activity (for example, document name in cases where an activity refers to document creation)
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
age_group
Type: STRING
Provider name: ageGroup
Description: Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select. Supports $filter (eq, ne, not, and in).
agreement_acceptances
Type: UNORDERED_LIST_STRUCT
Provider name: agreementAcceptances
Description: The user’s terms of use acceptance statuses. Read-only. Nullable.
agreement_file_id
Type: STRING
Provider name: agreementFileId
Description: The identifier of the agreement file accepted by the user.
agreement_id
Type: STRING
Provider name: agreementId
Description: The identifier of the agreement.
device_display_name
Type: STRING
Provider name: deviceDisplayName
Description: The display name of the device used for accepting the agreement.
device_id
Type: STRING
Provider name: deviceId
Description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
device_os_type
Type: STRING
Provider name: deviceOSType
Description: The operating system used to accept the agreement.
device_os_version
Type: STRING
Provider name: deviceOSVersion
Description: The operating system version of the device used to accept the agreement.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ge, le) and eq for null values.
name
Type: STRING
Provider name: name
recorded_date_time
Type: STRING
Provider name: recordedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
state
Type: STRING
Provider name: state
Description: The state of the agreement acceptance. Possible values are: accepted, declined. Supports $filter (eq).
user_display_name
Type: STRING
Provider name: userDisplayName
Description: Display name of the user when the acceptance was recorded.
user_email
Type: STRING
Provider name: userEmail
Description: Email of the user when the acceptance was recorded.
user_id
Type: STRING
Provider name: userId
Description: The identifier of the user who accepted the agreement. Supports $filter (eq).
user_principal_name
Type: STRING
Provider name: userPrincipalName
Description: UPN of the user when the acceptance was recorded.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
app_role_assignments
Type: UNORDERED_LIST_STRUCT
Provider name: appRoleAssignments
Description: Represents the app roles a user is granted for an application. Supports $expand.
app_role_id
Type: STRING
Provider name: appRoleId
Description: The identifier (id) for the app role that’s assigned to the principal. This app role must be exposed in the appRoles property on the resource application’s service principal (resourceId). If the resource application hasn’t declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
principal_display_name
Type: STRING
Provider name: principalDisplayName
Description: The display name of the user, group, or service principal that was granted the app role assignment. Maximum length is 256 characters. Read-only. Supports $filter (eq and startswith).
principal_id
Type: STRING
Provider name: principalId
Description: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.
principal_type
Type: STRING
Provider name: principalType
Description: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.
resource_display_name
Type: STRING
Provider name: resourceDisplayName
Description: The display name of the resource app’s service principal to which the assignment is made. Maximum length is 256 characters.
resource_id
Type: STRING
Provider name: resourceId
Description: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
assigned_licenses
Type: UNORDERED_LIST_STRUCT
Provider name: assignedLicenses
Description: The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn’t differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).
disabled_plans
Type: UNORDERED_LIST_STRING
Provider name: disabledPlans
Description: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant’s subscribedSkus or serviceStatus > servicePlanId in the tenant’s companySubscription.
sku_id
Type: STRING
Provider name: skuId
Description: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
assigned_plans
Type: UNORDERED_LIST_STRUCT
Provider name: assignedPlans
Description: The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not).
assigned_date_time
Type: STRING
Provider name: assignedDateTime
Description: The date and time at which the plan was assigned. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
capability_status
Type: STRING
Provider name: capabilityStatus
Description: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.
service
Type: STRING
Provider name: service
Description: The name of the service; for example, exchange.
service_plan_id
Type: STRING
Provider name: servicePlanId
Description: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
authentication
Type: STRUCT
Provider name: authentication
Description: The authentication methods that are supported for the user.
email_methods
Type: UNORDERED_LIST_STRUCT
Provider name: emailMethods
Description: The email address registered to a user for authentication.
email_address
Type: STRING
Provider name: emailAddress
Description: The email address registered to this user.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
fido2_methods
Type: UNORDERED_LIST_STRUCT
Provider name: fido2Methods
Description: Represents the FIDO2 security keys registered to a user for authentication.
aa_guid
Type: STRING
Provider name: aaGuid
Description: Authenticator Attestation GUID, an identifier that indicates the type (e.g. make and model) of the authenticator.
attestation_certificates
Type: UNORDERED_LIST_STRING
Provider name: attestationCertificates
Description: The attestation certificate(s) attached to this security key.
attestation_level
Type: STRING
Provider name: attestationLevel
Description: The attestation level of this FIDO2 security key. Possible values are: attested, or notAttested.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp when this key was registered to the user.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the key as given by the user.
model
Type: STRING
Provider name: model
Description: The manufacturer-assigned model of the FIDO2 security key.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
methods
Type: UNORDERED_LIST_STRUCT
Provider name: methods
Description: Represents all authentication methods registered to a user.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
microsoft_authenticator_methods
Type: UNORDERED_LIST_STRUCT
Provider name: microsoftAuthenticatorMethods
Description: The details of the Microsoft Authenticator app registered to a user for authentication.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time that this app was registered. This property is null if the device isn’t registered for passwordless Phone Sign-In.
device
Type: STRUCT
Provider name: device
Description: The registered device on which Microsoft Authenticator resides. This property is null if the device isn’t registered for passwordless Phone Sign-In.
account_enabled
Type: BOOLEAN
Provider name: accountEnabled
Description: true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.
alternative_security_ids
Type: UNORDERED_LIST_STRUCT
Provider name: alternativeSecurityIds
Description: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).
identity_provider
Type: STRING
Provider name: identityProvider
Description: For internal use only.
key
Type: STRING
Provider name: key
Description: For internal use only.
type
Type: INT32
Provider name: type
Description: For internal use only.
approximate_last_sign_in_date_time
Type: STRING
Provider name: approximateLastSignInDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.
compliance_expiration_date_time
Type: STRING
Provider name: complianceExpirationDateTime
Description: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
device_category
Type: STRING
Provider name: deviceCategory
Description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
device_id
Type: STRING
Provider name: deviceId
Description: Unique identifier set by Azure Device Registration Service at the time of registration. This alternate key can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).
device_metadata
Type: STRING
Provider name: deviceMetadata
Description: For internal use only. Set to null.
device_ownership
Type: STRING
Provider name: deviceOwnership
Description: Ownership of the device. Intune sets this property. Possible values are: unknown, company, personal.
device_version
Type: INT32
Provider name: deviceVersion
Description: For internal use only.
display_name
Type: STRING
Provider name: displayName
Description: The display name for the device. Maximum length is 256 characters. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
enrollment_profile_name
Type: STRING
Provider name: enrollmentProfileName
Description: Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.
enrollment_type
Type: STRING
Provider name: enrollmentType
Description: Enrollment type of the device. Intune sets this property. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the device. Read-only. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
is_compliant
Type: BOOLEAN
Provider name: isCompliant
Description: true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
is_managed
Type: BOOLEAN
Provider name: isManaged
Description: true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
is_management_restricted
Type: BOOLEAN
Provider name: isManagementRestricted
Description: Indicates whether the device is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a device that’s a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.
is_rooted
Type: BOOLEAN
Provider name: isRooted
Description: true if the device is rooted or jail-broken. This property can only be updated by Intune.
management_type
Type: STRING
Provider name: managementType
Description: The management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.
manufacturer
Type: STRING
Provider name: manufacturer
Description: Manufacturer of the device. Read-only.
mdm_app_id
Type: STRING
Provider name: mdmAppId
Description: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).
member_of
Type: UNORDERED_LIST_STRUCT
Provider name: memberOf
Description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
model
Type: STRING
Provider name: model
Description: Model of the device. Read-only.
name
Type: STRING
Provider name: name
on_premises_last_sync_date_time
Type: STRING
Provider name: onPremisesLastSyncDateTime
Description: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).
on_premises_security_identifier
Type: STRING
Provider name: onPremisesSecurityIdentifier
Description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).
on_premises_sync_enabled
Type: BOOLEAN
Provider name: onPremisesSyncEnabled
Description: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
operating_system
Type: STRING
Provider name: operatingSystem
Description: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
operating_system_version
Type: STRING
Provider name: operatingSystemVersion
Description: The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
physical_ids
Type: UNORDERED_LIST_STRING
Provider name: physicalIds
Description: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).
profile_type
Type: STRING
Provider name: profileType
Description: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
registered_owners
Type: UNORDERED_LIST_STRUCT
Provider name: registeredOwners
Description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
registered_users
Type: UNORDERED_LIST_STRUCT
Provider name: registeredUsers
Description: Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
registration_date_time
Type: STRING
Provider name: registrationDateTime
Description: Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
system_labels
Type: UNORDERED_LIST_STRING
Provider name: systemLabels
Description: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).
transitive_member_of
Type: UNORDERED_LIST_STRUCT
Provider name: transitiveMemberOf
Description: Groups and administrative units that the device is a member of. This operation is transitive. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
trust_type
Type: STRING
Provider name: trustType
Description: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud-only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID. Supports $filter (eq, ne, not, in).
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
device_tag
Type: STRING
Provider name: deviceTag
Description: Tags containing app metadata.
display_name
Type: STRING
Provider name: displayName
Description: The name of the device on which this app is registered.
name
Type: STRING
Provider name: name
phone_app_version
Type: STRING
Provider name: phoneAppVersion
Description: Numerical version of this instance of the Authenticator app.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
operations
Type: UNORDERED_LIST_STRUCT
Provider name: operations
Description: Represents the status of a long-running operation, such as a password reset operation.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
last_action_date_time
Type: STRING
Provider name: lastActionDateTime
Description: The time of the last action in the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
name
Type: STRING
Provider name: name
resource_location
Type: STRING
Provider name: resourceLocation
Description: URI of the resource that the operation is performed on.
status
Type: STRING
Provider name: status
Description: The status of the operation. The possible values are: notStarted, running, succeeded, failed, unknownFutureValue.
status_detail
Type: STRING
Provider name: statusDetail
Description: Details about the status of the operation.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
password_methods
Type: UNORDERED_LIST_STRUCT
Provider name: passwordMethods
Description: Represents the password registered to a user for authentication. For security, the password itself is never returned in the object, but action can be taken to reset a password.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when this password was last updated. This property is currently not populated. Read-only. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
name
Type: STRING
Provider name: name
password
Type: STRING
Provider name: password
Description: For security, the password is always returned as null from a LIST or GET operation.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
phone_methods
Type: UNORDERED_LIST_STRUCT
Provider name: phoneMethods
Description: The phone numbers registered to a user for authentication.
name
Type: STRING
Provider name: name
phone_number
Type: STRING
Provider name: phoneNumber
Description: The phone number to text or call for authentication. Phone numbers use the format +{country code} {number}x{extension}, with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating or updating if they don’t match the required format.
phone_type
Type: STRING
Provider name: phoneType
Description: The type of this phone. Possible values are: mobile, alternateMobile, or office.
sms_sign_in_state
Type: STRING
Provider name: smsSignInState
Description: Whether a phone is ready to be used for SMS sign-in or not. Possible values are: notSupported, notAllowedByPolicy, notEnabled, phoneNumberNotUnique, ready, or notConfigured, unknownFutureValue.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
platform_credential_methods
Type: UNORDERED_LIST_STRUCT
Provider name: platformCredentialMethods
Description: Represents a platform credential instance registered to a user on Mac OS.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time that this Platform Credential Key was registered.
device
Type: STRUCT
Provider name: device
Description: The registered device on which this Platform Credential resides. Supports $expand. When you get a user’s Platform Credential registration information, this property is returned only on a single GET and when you specify ?$expand. For example, GET /users/admin@contoso.com/authentication/platformCredentialAuthenticationMethod/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.
account_enabled
Type: BOOLEAN
Provider name: accountEnabled
Description: true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.
alternative_security_ids
Type: UNORDERED_LIST_STRUCT
Provider name: alternativeSecurityIds
Description: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).
identity_provider
Type: STRING
Provider name: identityProvider
Description: For internal use only.
key
Type: STRING
Provider name: key
Description: For internal use only.
type
Type: INT32
Provider name: type
Description: For internal use only.
approximate_last_sign_in_date_time
Type: STRING
Provider name: approximateLastSignInDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.
compliance_expiration_date_time
Type: STRING
Provider name: complianceExpirationDateTime
Description: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
device_category
Type: STRING
Provider name: deviceCategory
Description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
device_id
Type: STRING
Provider name: deviceId
Description: Unique identifier set by Azure Device Registration Service at the time of registration. This alternate key can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).
device_metadata
Type: STRING
Provider name: deviceMetadata
Description: For internal use only. Set to null.
device_ownership
Type: STRING
Provider name: deviceOwnership
Description: Ownership of the device. Intune sets this property. Possible values are: unknown, company, personal.
device_version
Type: INT32
Provider name: deviceVersion
Description: For internal use only.
display_name
Type: STRING
Provider name: displayName
Description: The display name for the device. Maximum length is 256 characters. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
enrollment_profile_name
Type: STRING
Provider name: enrollmentProfileName
Description: Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.
enrollment_type
Type: STRING
Provider name: enrollmentType
Description: Enrollment type of the device. Intune sets this property. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the device. Read-only. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
is_compliant
Type: BOOLEAN
Provider name: isCompliant
Description: true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
is_managed
Type: BOOLEAN
Provider name: isManaged
Description: true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
is_management_restricted
Type: BOOLEAN
Provider name: isManagementRestricted
Description: Indicates whether the device is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a device that’s a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.
is_rooted
Type: BOOLEAN
Provider name: isRooted
Description: true if the device is rooted or jail-broken. This property can only be updated by Intune.
management_type
Type: STRING
Provider name: managementType
Description: The management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.
manufacturer
Type: STRING
Provider name: manufacturer
Description: Manufacturer of the device. Read-only.
mdm_app_id
Type: STRING
Provider name: mdmAppId
Description: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).
member_of
Type: UNORDERED_LIST_STRUCT
Provider name: memberOf
Description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
model
Type: STRING
Provider name: model
Description: Model of the device. Read-only.
name
Type: STRING
Provider name: name
on_premises_last_sync_date_time
Type: STRING
Provider name: onPremisesLastSyncDateTime
Description: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).
on_premises_security_identifier
Type: STRING
Provider name: onPremisesSecurityIdentifier
Description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).
on_premises_sync_enabled
Type: BOOLEAN
Provider name: onPremisesSyncEnabled
Description: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
operating_system
Type: STRING
Provider name: operatingSystem
Description: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
operating_system_version
Type: STRING
Provider name: operatingSystemVersion
Description: The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
physical_ids
Type: UNORDERED_LIST_STRING
Provider name: physicalIds
Description: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).
profile_type
Type: STRING
Provider name: profileType
Description: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
registered_owners
Type: UNORDERED_LIST_STRUCT
Provider name: registeredOwners
Description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
registered_users
Type: UNORDERED_LIST_STRUCT
Provider name: registeredUsers
Description: Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
registration_date_time
Type: STRING
Provider name: registrationDateTime
Description: Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
system_labels
Type: UNORDERED_LIST_STRING
Provider name: systemLabels
Description: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).
transitive_member_of
Type: UNORDERED_LIST_STRUCT
Provider name: transitiveMemberOf
Description: Groups and administrative units that the device is a member of. This operation is transitive. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
trust_type
Type: STRING
Provider name: trustType
Description: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud-only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID. Supports $filter (eq, ne, not, in).
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The name of the device on which Platform Credential is registered.
key_strength
Type: STRING
Provider name: keyStrength
Description: Key strength of this Platform Credential key. Possible values are: normal, weak, unknown.
name
Type: STRING
Provider name: name
platform
Type: STRING
Provider name: platform
Description: Platform on which this Platform Credential key is present. Possible values are: unknown, windows, macOS,iOS, android, linux.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
software_oath_methods
Type: UNORDERED_LIST_STRUCT
Provider name: softwareOathMethods
Description: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
name
Type: STRING
Provider name: name
secret_key
Type: STRING
Provider name: secretKey
Description: The secret key of the method. Always returns null.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
temporary_access_pass_methods
Type: UNORDERED_LIST_STRUCT
Provider name: temporaryAccessPassMethods
Description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the Temporary Access Pass was created.
is_usable
Type: BOOLEAN
Provider name: isUsable
Description: The state of the authentication method that indicates whether it’s currently usable by the user.
is_usable_once
Type: BOOLEAN
Provider name: isUsableOnce
Description: Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime.
lifetime_in_minutes
Type: INT32
Provider name: lifetimeInMinutes
Description: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
method_usability_reason
Type: STRING
Provider name: methodUsabilityReason
Description: Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.
name
Type: STRING
Provider name: name
start_date_time
Type: STRING
Provider name: startDateTime
Description: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
temporary_access_pass
Type: STRING
Provider name: temporaryAccessPass
Description: The Temporary Access Pass used to authenticate. Returned only on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden in subsequent read operations and returned as null with GET.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
windows_hello_for_business_methods
Type: UNORDERED_LIST_STRUCT
Provider name: windowsHelloForBusinessMethods
Description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time that this Windows Hello for Business key was registered.
device
Type: STRUCT
Provider name: device
Description: The registered device on which this Windows Hello for Business key resides. Supports $expand. When you get a user’s Windows Hello for Business registration information, this property is returned only on a single GET and when you specify ?$expand. For example, GET /users/admin@contoso.com/authentication/windowsHelloForBusinessMethods/_jpuR-TGZtk6aQCLF3BQjA2?$expand=device.
account_enabled
Type: BOOLEAN
Provider name: accountEnabled
Description: true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.
alternative_security_ids
Type: UNORDERED_LIST_STRUCT
Provider name: alternativeSecurityIds
Description: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).
identity_provider
Type: STRING
Provider name: identityProvider
Description: For internal use only.
key
Type: STRING
Provider name: key
Description: For internal use only.
type
Type: INT32
Provider name: type
Description: For internal use only.
approximate_last_sign_in_date_time
Type: STRING
Provider name: approximateLastSignInDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.
compliance_expiration_date_time
Type: STRING
Provider name: complianceExpirationDateTime
Description: The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
device_category
Type: STRING
Provider name: deviceCategory
Description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
device_id
Type: STRING
Provider name: deviceId
Description: Unique identifier set by Azure Device Registration Service at the time of registration. This alternate key can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).
device_metadata
Type: STRING
Provider name: deviceMetadata
Description: For internal use only. Set to null.
device_ownership
Type: STRING
Provider name: deviceOwnership
Description: Ownership of the device. Intune sets this property. Possible values are: unknown, company, personal.
device_version
Type: INT32
Provider name: deviceVersion
Description: For internal use only.
display_name
Type: STRING
Provider name: displayName
Description: The display name for the device. Maximum length is 256 characters. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
enrollment_profile_name
Type: STRING
Provider name: enrollmentProfileName
Description: Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.
enrollment_type
Type: STRING
Provider name: enrollmentType
Description: Enrollment type of the device. Intune sets this property. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the device. Read-only. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
is_compliant
Type: BOOLEAN
Provider name: isCompliant
Description: true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
is_managed
Type: BOOLEAN
Provider name: isManaged
Description: true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
is_management_restricted
Type: BOOLEAN
Provider name: isManagementRestricted
Description: Indicates whether the device is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a device that’s a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.
is_rooted
Type: BOOLEAN
Provider name: isRooted
Description: true if the device is rooted or jail-broken. This property can only be updated by Intune.
management_type
Type: STRING
Provider name: managementType
Description: The management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.
manufacturer
Type: STRING
Provider name: manufacturer
Description: Manufacturer of the device. Read-only.
mdm_app_id
Type: STRING
Provider name: mdmAppId
Description: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).
member_of
Type: UNORDERED_LIST_STRUCT
Provider name: memberOf
Description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
model
Type: STRING
Provider name: model
Description: Model of the device. Read-only.
name
Type: STRING
Provider name: name
on_premises_last_sync_date_time
Type: STRING
Provider name: onPremisesLastSyncDateTime
Description: The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).
on_premises_security_identifier
Type: STRING
Provider name: onPremisesSecurityIdentifier
Description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).
on_premises_sync_enabled
Type: BOOLEAN
Provider name: onPremisesSyncEnabled
Description: true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
operating_system
Type: STRING
Provider name: operatingSystem
Description: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
operating_system_version
Type: STRING
Provider name: operatingSystemVersion
Description: The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
physical_ids
Type: UNORDERED_LIST_STRING
Provider name: physicalIds
Description: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).
profile_type
Type: STRING
Provider name: profileType
Description: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
registered_owners
Type: UNORDERED_LIST_STRUCT
Provider name: registeredOwners
Description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
registered_users
Type: UNORDERED_LIST_STRUCT
Provider name: registeredUsers
Description: Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
registration_date_time
Type: STRING
Provider name: registrationDateTime
Description: Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
system_labels
Type: UNORDERED_LIST_STRING
Provider name: systemLabels
Description: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).
transitive_member_of
Type: UNORDERED_LIST_STRUCT
Provider name: transitiveMemberOf
Description: Groups and administrative units that the device is a member of. This operation is transitive. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
trust_type
Type: STRING
Provider name: trustType
Description: Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud-only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more information, see Introduction to device management in Microsoft Entra ID. Supports $filter (eq, ne, not, in).
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The name of the device on which Windows Hello for Business is registered
key_strength
Type: STRING
Provider name: keyStrength
Description: Key strength of this Windows Hello for Business key. Possible values are: normal, weak, unknown.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
authorization_info
Type: STRUCT
Provider name: authorizationInfo
certificate_user_ids
Type: UNORDERED_LIST_STRING
Provider name: certificateUserIds
birthday
Type: STRING
Provider name: birthday
Description: The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select.
business_phones
Type: UNORDERED_LIST_STRING
Provider name: businessPhones
Description: The telephone numbers for the user. NOTE: Although it’s a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith).
chats
Type: UNORDERED_LIST_STRUCT
Provider name: chats
chat_type
Type: STRING
Provider name: chatType
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Date and time at which the chat was created. Read-only.
installed_apps
Type: UNORDERED_LIST_STRUCT
Provider name: installedApps
Description: A collection of all the apps in the chat. Nullable.
consented_permission_set
Type: STRUCT
Provider name: consentedPermissionSet
Description: The set of resource-specific permissions consented to while installing or upgrading the teamsApp.
resource_specific_permissions
Type: UNORDERED_LIST_STRUCT
Provider name: resourceSpecificPermissions
Description: A collection of resource-specific permissions.
permission_type
Type: STRING
Provider name: permissionType
Description: The type of resource-specific permission.
permission_value
Type: STRING
Provider name: permissionValue
Description: The name of the resource-specific permission.
name
Type: STRING
Provider name: name
teams_app
Type: STRUCT
Provider name: teamsApp
Description: The app that is installed.
app_definitions
Type: UNORDERED_LIST_STRUCT
Provider name: appDefinitions
Description: The details for each version of the app.
authorization
Type: STRUCT
Provider name: authorization
Description: Authorization requirements specified in the Teams app manifest.
client_app_id
Type: STRING
Provider name: clientAppId
Description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
required_permission_set
Type: STRUCT
Provider name: requiredPermissionSet
Description: Set of permissions required by the teamsApp.
resource_specific_permissions
Type: UNORDERED_LIST_STRUCT
Provider name: resourceSpecificPermissions
Description: A collection of resource-specific permissions.
permission_type
Type: STRING
Provider name: permissionType
Description: The type of resource-specific permission.
permission_value
Type: STRING
Provider name: permissionValue
Description: The name of the resource-specific permission.
bot
Type: STRUCT
Provider name: bot
Description: The details of the bot specified in the Teams app manifest.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
description
Type: STRING
Provider name: description
Description: Verbose description of the application.
display_name
Type: STRING
Provider name: displayName
Description: The name of the app provided by the app developer.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
name
Type: STRING
Provider name: name
publishing_state
Type: STRING
Provider name: publishingState
Description: The published status of a specific version of a Teams app. Possible values are:submitted—The specific version of the Teams app was submitted and is under review.published—The request to publish the specific version of the Teams app was approved by the admin and the app is published.rejected—The admin rejected the request to publish the specific version of the Teams app.
short_description
Type: STRING
Provider name: shortDescription
Description: Short description of the application.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID from the Teams app manifest.
version
Type: STRING
Provider name: version
Description: The version number of the application.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
distribution_method
Type: STRING
Provider name: distributionMethod
Description: The method of distribution for the app. Read-only.
external_id
Type: STRING
Provider name: externalId
Description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
teams_app_definition
Type: STRUCT
Provider name: teamsAppDefinition
Description: The details of this version of the app.
authorization
Type: STRUCT
Provider name: authorization
Description: Authorization requirements specified in the Teams app manifest.
client_app_id
Type: STRING
Provider name: clientAppId
Description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
required_permission_set
Type: STRUCT
Provider name: requiredPermissionSet
Description: Set of permissions required by the teamsApp.
resource_specific_permissions
Type: UNORDERED_LIST_STRUCT
Provider name: resourceSpecificPermissions
Description: A collection of resource-specific permissions.
permission_type
Type: STRING
Provider name: permissionType
Description: The type of resource-specific permission.
permission_value
Type: STRING
Provider name: permissionValue
Description: The name of the resource-specific permission.
bot
Type: STRUCT
Provider name: bot
Description: The details of the bot specified in the Teams app manifest.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
description
Type: STRING
Provider name: description
Description: Verbose description of the application.
display_name
Type: STRING
Provider name: displayName
Description: The name of the app provided by the app developer.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
name
Type: STRING
Provider name: name
publishing_state
Type: STRING
Provider name: publishingState
Description: The published status of a specific version of a Teams app. Possible values are:submitted—The specific version of the Teams app was submitted and is under review.published—The request to publish the specific version of the Teams app was approved by the admin and the app is published.rejected—The admin rejected the request to publish the specific version of the Teams app.
short_description
Type: STRING
Provider name: shortDescription
Description: Short description of the application.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID from the Teams app manifest.
version
Type: STRING
Provider name: version
Description: The version number of the application.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
is_hidden_for_all_members
Type: BOOLEAN
Provider name: isHiddenForAllMembers
Description: Indicates whether the chat is hidden for all its members. Read-only.
last_message_preview
Type: STRUCT
Provider name: lastMessagePreview
Description: Preview of the last message sent in the chat. Null if no messages were sent in the chat. Currently, only the list chats operation supports this property.
body
Type: STRUCT
Provider name: body
Description: Body of the chatMessage. This will still contain markers for @mentions and attachments even though the object doesn’t return @mentions and attachments.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Date time object representing the time at which message was created.
event_detail
Type: STRUCT
Provider name: eventDetail
Description: Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, members were added, and so on. For event messages, the messageType property is set to systemEventMessage.
from
Type: STRUCT
Provider name: from
Description: Information about the sender of the message.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
is_deleted
Type: BOOLEAN
Provider name: isDeleted
Description: If set to true, the original message has been deleted.
message_type
Type: STRING
Provider name: messageType
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
last_updated_date_time
Type: STRING
Provider name: lastUpdatedDateTime
Description: Date and time at which the chat was renamed or the list of members was last changed. Read-only.
members
Type: UNORDERED_LIST_STRUCT
Provider name: members
Description: A collection of all the members in the chat. Nullable.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the user.
name
Type: STRING
Provider name: name
roles
Type: UNORDERED_LIST_STRING
Provider name: roles
Description: The roles for that user. This property contains more 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 shouldn’t have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.
visible_history_start_date_time
Type: STRING
Provider name: visibleHistoryStartDateTime
Description: 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.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
messages
Type: UNORDERED_LIST_STRUCT
Provider name: messages
Description: A collection of all the messages in the chat. Nullable.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: References to attached objects like files, tabs, meetings etc.
content
Type: STRING
Provider name: content
Description: The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.
content_type
Type: STRING
Provider name: contentType
Description: The media type of the content attachment. The possible values are: reference: The attachment is a link to another file. Populate the contentURL with the link to the object.forwardedMessageReference: The attachment is a reference to a forwarded message. Populate the content with the original message context.Any contentType that is supported by the Bot Framework’s Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the content of the attachment.
id
Type: STRING
Provider name: id
Description: Read-only. The unique ID of the attachment.
name
Type: STRING
Provider name: name
Description: The name of the attachment.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.
thumbnail_url
Type: STRING
Provider name: thumbnailUrl
Description: The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.
body
Type: STRUCT
Provider name: body
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
channel_identity
Type: STRUCT
Provider name: channelIdentity
Description: If the message was sent in a channel, represents identity of the channel.
channel_id
Type: STRING
Provider name: channelId
Description: The identity of the channel in which the message was posted.
team_id
Type: STRING
Provider name: teamId
Description: The identity of the team in which the message was posted.
chat_id
Type: STRING
Provider name: chatId
Description: If the message was sent in a chat, represents the identity of the chat.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Timestamp of when the chat message was created.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Read only. Timestamp at which the chat message was deleted, or null if not deleted.
etag
Type: STRING
Provider name: etag
Description: Read-only. Version number of the chat message.
event_detail
Type: STRUCT
Provider name: eventDetail
Description: Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to systemEventMessage.
from
Type: STRUCT
Provider name: from
Description: Details of the sender of the chat message. Can only be set during migration.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
hosted_contents
Type: UNORDERED_LIST_STRUCT
Provider name: hostedContents
Description: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
name
Type: STRING
Provider name: name
content_bytes
Type: STRING
Provider name: contentBytes
Description: Write only. Bytes for the hosted content (such as images).
content_type
Type: STRING
Provider name: contentType
Description: Write only. Content type. such as image/png, image/jpg.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
importance
Type: STRING
Provider name: importance
last_edited_date_time
Type: STRING
Provider name: lastEditedDateTime
Description: Read only. Timestamp when edits to the chat message were made. Triggers an ‘Edited’ flag in the Teams UI. If no edits are made the value is null.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
locale
Type: STRING
Provider name: locale
Description: Locale of the chat message set by the client. Always set to en-us.
mentions
Type: UNORDERED_LIST_STRUCT
Provider name: mentions
Description: List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.
id
Type: INT32
Provider name: id
Description: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.
mention_text
Type: STRING
Provider name: mentionText
Description: String used to represent the mention. For example, a user’s display name, a team name.
mentioned
Type: STRUCT
Provider name: mentioned
Description: The entity (user, application, team, channel, or chat) that was @mentioned.
conversation
Type: STRUCT
Provider name: conversation
Description: If present, represents a conversation (for example, team, channel, or chat) @mentioned in a message.
conversation_identity_type
Type: STRING
Provider name: conversationIdentityType
Description: Type of conversation. Possible values are: team, channel, chat, and unknownFutureValue.
name
Type: STRING
Provider name: name
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_history
Type: UNORDERED_LIST_STRUCT
Provider name: messageHistory
Description: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
actions
Type: STRING
Provider name: actions
modified_date_time
Type: STRING
Provider name: modifiedDateTime
Description: The date and time when the message was modified.
reaction
Type: STRUCT
Provider name: reaction
Description: The reaction in the modified message.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_type
Type: STRING
Provider name: messageType
name
Type: STRING
Provider name: name
policy_violation
Type: STRUCT
Provider name: policyViolation
Description: Defines the properties of a policy violation set by a data loss prevention (DLP) application.
dlp_action
Type: STRING
Provider name: dlpAction
Description: The action taken by the DLP provider on the message with sensitive content. Supported values are: NoneNotifySender – Inform the sender of the violation but allow readers to read the message.BlockAccess – Block readers from reading the message.BlockAccessExternal – Block users outside the organization from reading the message, while allowing users within the organization to read the message.
justification_text
Type: STRING
Provider name: justificationText
Description: Justification text provided by the sender of the message when overriding a policy violation.
policy_tip
Type: STRUCT
Provider name: policyTip
Description: Information to display to the message sender about why the message was flagged as a violation.
compliance_url
Type: STRING
Provider name: complianceUrl
Description: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn’t say in chats)
general_text
Type: STRING
Provider name: generalText
Description: Explanatory text shown to the sender of the message.
matched_condition_descriptions
Type: UNORDERED_LIST_STRING
Provider name: matchedConditionDescriptions
Description: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include ‘Credit Card Number’ and ‘Social Security Number’.
user_action
Type: STRING
Provider name: userAction
Description: Indicates the action taken by the user on a message blocked by the DLP provider. Supported values are: NoneOverrideReportFalsePositiveWhen the DLP provider is updating the message for blocking sensitive content, userAction isn’t required.
verdict_details
Type: STRING
Provider name: verdictDetails
Description: Indicates what actions the sender may take in response to the policy violation. Supported values are: NoneAllowFalsePositiveOverride – Allows the sender to declare the policyViolation to be an error in the DLP app and its rules, and allow readers to see the message again if the dlpAction hides it.AllowOverrideWithoutJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, without needing to provide an explanation for doing so. AllowOverrideWithJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, after providing an explanation for doing so.AllowOverrideWithoutJustification and AllowOverrideWithJustification are mutually exclusive.
reactions
Type: UNORDERED_LIST_STRUCT
Provider name: reactions
Description: Reactions for this chat message (for example, Like).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
replies
Type: UNORDERED_LIST_STRUCT
Provider name: replies
Description: Replies for a specified message. Supports $expand for channel messages.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: References to attached objects like files, tabs, meetings etc.
content
Type: STRING
Provider name: content
Description: The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.
content_type
Type: STRING
Provider name: contentType
Description: The media type of the content attachment. The possible values are: reference: The attachment is a link to another file. Populate the contentURL with the link to the object.forwardedMessageReference: The attachment is a reference to a forwarded message. Populate the content with the original message context.Any contentType that is supported by the Bot Framework’s Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the content of the attachment.
id
Type: STRING
Provider name: id
Description: Read-only. The unique ID of the attachment.
name
Type: STRING
Provider name: name
Description: The name of the attachment.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.
thumbnail_url
Type: STRING
Provider name: thumbnailUrl
Description: The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.
body
Type: STRUCT
Provider name: body
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
channel_identity
Type: STRUCT
Provider name: channelIdentity
Description: If the message was sent in a channel, represents identity of the channel.
channel_id
Type: STRING
Provider name: channelId
Description: The identity of the channel in which the message was posted.
team_id
Type: STRING
Provider name: teamId
Description: The identity of the team in which the message was posted.
chat_id
Type: STRING
Provider name: chatId
Description: If the message was sent in a chat, represents the identity of the chat.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Timestamp of when the chat message was created.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Read only. Timestamp at which the chat message was deleted, or null if not deleted.
etag
Type: STRING
Provider name: etag
Description: Read-only. Version number of the chat message.
event_detail
Type: STRUCT
Provider name: eventDetail
Description: Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to systemEventMessage.
from
Type: STRUCT
Provider name: from
Description: Details of the sender of the chat message. Can only be set during migration.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
hosted_contents
Type: UNORDERED_LIST_STRUCT
Provider name: hostedContents
Description: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
name
Type: STRING
Provider name: name
content_bytes
Type: STRING
Provider name: contentBytes
Description: Write only. Bytes for the hosted content (such as images).
content_type
Type: STRING
Provider name: contentType
Description: Write only. Content type. such as image/png, image/jpg.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
importance
Type: STRING
Provider name: importance
last_edited_date_time
Type: STRING
Provider name: lastEditedDateTime
Description: Read only. Timestamp when edits to the chat message were made. Triggers an ‘Edited’ flag in the Teams UI. If no edits are made the value is null.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
locale
Type: STRING
Provider name: locale
Description: Locale of the chat message set by the client. Always set to en-us.
mentions
Type: UNORDERED_LIST_STRUCT
Provider name: mentions
Description: List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.
id
Type: INT32
Provider name: id
Description: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.
mention_text
Type: STRING
Provider name: mentionText
Description: String used to represent the mention. For example, a user’s display name, a team name.
mentioned
Type: STRUCT
Provider name: mentioned
Description: The entity (user, application, team, channel, or chat) that was @mentioned.
conversation
Type: STRUCT
Provider name: conversation
Description: If present, represents a conversation (for example, team, channel, or chat) @mentioned in a message.
conversation_identity_type
Type: STRING
Provider name: conversationIdentityType
Description: Type of conversation. Possible values are: team, channel, chat, and unknownFutureValue.
name
Type: STRING
Provider name: name
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_history
Type: UNORDERED_LIST_STRUCT
Provider name: messageHistory
Description: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
actions
Type: STRING
Provider name: actions
modified_date_time
Type: STRING
Provider name: modifiedDateTime
Description: The date and time when the message was modified.
reaction
Type: STRUCT
Provider name: reaction
Description: The reaction in the modified message.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_type
Type: STRING
Provider name: messageType
policy_violation
Type: STRUCT
Provider name: policyViolation
Description: Defines the properties of a policy violation set by a data loss prevention (DLP) application.
dlp_action
Type: STRING
Provider name: dlpAction
Description: The action taken by the DLP provider on the message with sensitive content. Supported values are: NoneNotifySender – Inform the sender of the violation but allow readers to read the message.BlockAccess – Block readers from reading the message.BlockAccessExternal – Block users outside the organization from reading the message, while allowing users within the organization to read the message.
justification_text
Type: STRING
Provider name: justificationText
Description: Justification text provided by the sender of the message when overriding a policy violation.
policy_tip
Type: STRUCT
Provider name: policyTip
Description: Information to display to the message sender about why the message was flagged as a violation.
compliance_url
Type: STRING
Provider name: complianceUrl
Description: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn’t say in chats)
general_text
Type: STRING
Provider name: generalText
Description: Explanatory text shown to the sender of the message.
matched_condition_descriptions
Type: UNORDERED_LIST_STRING
Provider name: matchedConditionDescriptions
Description: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include ‘Credit Card Number’ and ‘Social Security Number’.
user_action
Type: STRING
Provider name: userAction
Description: Indicates the action taken by the user on a message blocked by the DLP provider. Supported values are: NoneOverrideReportFalsePositiveWhen the DLP provider is updating the message for blocking sensitive content, userAction isn’t required.
verdict_details
Type: STRING
Provider name: verdictDetails
Description: Indicates what actions the sender may take in response to the policy violation. Supported values are: NoneAllowFalsePositiveOverride – Allows the sender to declare the policyViolation to be an error in the DLP app and its rules, and allow readers to see the message again if the dlpAction hides it.AllowOverrideWithoutJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, without needing to provide an explanation for doing so. AllowOverrideWithJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, after providing an explanation for doing so.AllowOverrideWithoutJustification and AllowOverrideWithJustification are mutually exclusive.
reactions
Type: UNORDERED_LIST_STRUCT
Provider name: reactions
Description: Reactions for this chat message (for example, Like).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
reply_to_id
Type: STRING
Provider name: replyToId
Description: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
subject
Type: STRING
Provider name: subject
Description: The subject of the chat message, in plaintext.
summary
Type: STRING
Provider name: summary
Description: Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
web_url
Type: STRING
Provider name: webUrl
Description: Read-only. Link to the message in Microsoft Teams.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
reply_to_id
Type: STRING
Provider name: replyToId
Description: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
subject
Type: STRING
Provider name: subject
Description: The subject of the chat message, in plaintext.
summary
Type: STRING
Provider name: summary
Description: Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
web_url
Type: STRING
Provider name: webUrl
Description: Read-only. Link to the message in Microsoft Teams.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
online_meeting_info
Type: STRUCT
Provider name: onlineMeetingInfo
Description: Represents details about an online meeting. If the chat isn’t associated with an online meeting, the property is empty. Read-only.
calendar_event_id
Type: STRING
Provider name: calendarEventId
Description: The identifier of the calendar event associated with the meeting.
join_web_url
Type: STRING
Provider name: joinWebUrl
Description: The URL that users click to join or uniquely identify the meeting.
organizer
Type: STRUCT
Provider name: organizer
Description: The organizer of the meeting.
name
Type: STRING
Provider name: name
user_identity_type
Type: STRING
Provider name: userIdentityType
Description: Type of user. Possible values are: aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser, unknownFutureValue and emailUser.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
permission_grants
Type: UNORDERED_LIST_STRUCT
Provider name: permissionGrants
Description: A collection of permissions granted to apps for the chat.
client_app_id
Type: STRING
Provider name: clientAppId
Description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
client_id
Type: STRING
Provider name: clientId
Description: ID of the Microsoft Entra app that has been granted access. Read-only.
name
Type: STRING
Provider name: name
permission
Type: STRING
Provider name: permission
Description: The name of the resource-specific permission. Read-only.
permission_type
Type: STRING
Provider name: permissionType
Description: The type of permission. Possible values are: Application, Delegated. Read-only.
resource_app_id
Type: STRING
Provider name: resourceAppId
Description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
pinned_messages
Type: UNORDERED_LIST_STRUCT
Provider name: pinnedMessages
Description: A collection of all the pinned messages in the chat. Nullable.
message
Type: STRUCT
Provider name: message
Description: Represents details about the chat message that is pinned.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: References to attached objects like files, tabs, meetings etc.
content
Type: STRING
Provider name: content
Description: The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.
content_type
Type: STRING
Provider name: contentType
Description: The media type of the content attachment. The possible values are: reference: The attachment is a link to another file. Populate the contentURL with the link to the object.forwardedMessageReference: The attachment is a reference to a forwarded message. Populate the content with the original message context.Any contentType that is supported by the Bot Framework’s Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the content of the attachment.
id
Type: STRING
Provider name: id
Description: Read-only. The unique ID of the attachment.
name
Type: STRING
Provider name: name
Description: The name of the attachment.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.
thumbnail_url
Type: STRING
Provider name: thumbnailUrl
Description: The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.
body
Type: STRUCT
Provider name: body
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
channel_identity
Type: STRUCT
Provider name: channelIdentity
Description: If the message was sent in a channel, represents identity of the channel.
channel_id
Type: STRING
Provider name: channelId
Description: The identity of the channel in which the message was posted.
team_id
Type: STRING
Provider name: teamId
Description: The identity of the team in which the message was posted.
chat_id
Type: STRING
Provider name: chatId
Description: If the message was sent in a chat, represents the identity of the chat.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Timestamp of when the chat message was created.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Read only. Timestamp at which the chat message was deleted, or null if not deleted.
etag
Type: STRING
Provider name: etag
Description: Read-only. Version number of the chat message.
event_detail
Type: STRUCT
Provider name: eventDetail
Description: Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to systemEventMessage.
from
Type: STRUCT
Provider name: from
Description: Details of the sender of the chat message. Can only be set during migration.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
hosted_contents
Type: UNORDERED_LIST_STRUCT
Provider name: hostedContents
Description: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
name
Type: STRING
Provider name: name
content_bytes
Type: STRING
Provider name: contentBytes
Description: Write only. Bytes for the hosted content (such as images).
content_type
Type: STRING
Provider name: contentType
Description: Write only. Content type. such as image/png, image/jpg.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
importance
Type: STRING
Provider name: importance
last_edited_date_time
Type: STRING
Provider name: lastEditedDateTime
Description: Read only. Timestamp when edits to the chat message were made. Triggers an ‘Edited’ flag in the Teams UI. If no edits are made the value is null.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
locale
Type: STRING
Provider name: locale
Description: Locale of the chat message set by the client. Always set to en-us.
mentions
Type: UNORDERED_LIST_STRUCT
Provider name: mentions
Description: List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.
id
Type: INT32
Provider name: id
Description: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.
mention_text
Type: STRING
Provider name: mentionText
Description: String used to represent the mention. For example, a user’s display name, a team name.
mentioned
Type: STRUCT
Provider name: mentioned
Description: The entity (user, application, team, channel, or chat) that was @mentioned.
conversation
Type: STRUCT
Provider name: conversation
Description: If present, represents a conversation (for example, team, channel, or chat) @mentioned in a message.
conversation_identity_type
Type: STRING
Provider name: conversationIdentityType
Description: Type of conversation. Possible values are: team, channel, chat, and unknownFutureValue.
name
Type: STRING
Provider name: name
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_history
Type: UNORDERED_LIST_STRUCT
Provider name: messageHistory
Description: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
actions
Type: STRING
Provider name: actions
modified_date_time
Type: STRING
Provider name: modifiedDateTime
Description: The date and time when the message was modified.
reaction
Type: STRUCT
Provider name: reaction
Description: The reaction in the modified message.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_type
Type: STRING
Provider name: messageType
name
Type: STRING
Provider name: name
policy_violation
Type: STRUCT
Provider name: policyViolation
Description: Defines the properties of a policy violation set by a data loss prevention (DLP) application.
dlp_action
Type: STRING
Provider name: dlpAction
Description: The action taken by the DLP provider on the message with sensitive content. Supported values are: NoneNotifySender – Inform the sender of the violation but allow readers to read the message.BlockAccess – Block readers from reading the message.BlockAccessExternal – Block users outside the organization from reading the message, while allowing users within the organization to read the message.
justification_text
Type: STRING
Provider name: justificationText
Description: Justification text provided by the sender of the message when overriding a policy violation.
policy_tip
Type: STRUCT
Provider name: policyTip
Description: Information to display to the message sender about why the message was flagged as a violation.
compliance_url
Type: STRING
Provider name: complianceUrl
Description: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn’t say in chats)
general_text
Type: STRING
Provider name: generalText
Description: Explanatory text shown to the sender of the message.
matched_condition_descriptions
Type: UNORDERED_LIST_STRING
Provider name: matchedConditionDescriptions
Description: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include ‘Credit Card Number’ and ‘Social Security Number’.
user_action
Type: STRING
Provider name: userAction
Description: Indicates the action taken by the user on a message blocked by the DLP provider. Supported values are: NoneOverrideReportFalsePositiveWhen the DLP provider is updating the message for blocking sensitive content, userAction isn’t required.
verdict_details
Type: STRING
Provider name: verdictDetails
Description: Indicates what actions the sender may take in response to the policy violation. Supported values are: NoneAllowFalsePositiveOverride – Allows the sender to declare the policyViolation to be an error in the DLP app and its rules, and allow readers to see the message again if the dlpAction hides it.AllowOverrideWithoutJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, without needing to provide an explanation for doing so. AllowOverrideWithJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, after providing an explanation for doing so.AllowOverrideWithoutJustification and AllowOverrideWithJustification are mutually exclusive.
reactions
Type: UNORDERED_LIST_STRUCT
Provider name: reactions
Description: Reactions for this chat message (for example, Like).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
replies
Type: UNORDERED_LIST_STRUCT
Provider name: replies
Description: Replies for a specified message. Supports $expand for channel messages.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: References to attached objects like files, tabs, meetings etc.
content
Type: STRING
Provider name: content
Description: The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.
content_type
Type: STRING
Provider name: contentType
Description: The media type of the content attachment. The possible values are: reference: The attachment is a link to another file. Populate the contentURL with the link to the object.forwardedMessageReference: The attachment is a reference to a forwarded message. Populate the content with the original message context.Any contentType that is supported by the Bot Framework’s Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the content of the attachment.
id
Type: STRING
Provider name: id
Description: Read-only. The unique ID of the attachment.
name
Type: STRING
Provider name: name
Description: The name of the attachment.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.
thumbnail_url
Type: STRING
Provider name: thumbnailUrl
Description: The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.
body
Type: STRUCT
Provider name: body
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
channel_identity
Type: STRUCT
Provider name: channelIdentity
Description: If the message was sent in a channel, represents identity of the channel.
channel_id
Type: STRING
Provider name: channelId
Description: The identity of the channel in which the message was posted.
team_id
Type: STRING
Provider name: teamId
Description: The identity of the team in which the message was posted.
chat_id
Type: STRING
Provider name: chatId
Description: If the message was sent in a chat, represents the identity of the chat.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Timestamp of when the chat message was created.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Read only. Timestamp at which the chat message was deleted, or null if not deleted.
etag
Type: STRING
Provider name: etag
Description: Read-only. Version number of the chat message.
event_detail
Type: STRUCT
Provider name: eventDetail
Description: Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to systemEventMessage.
from
Type: STRUCT
Provider name: from
Description: Details of the sender of the chat message. Can only be set during migration.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
hosted_contents
Type: UNORDERED_LIST_STRUCT
Provider name: hostedContents
Description: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
name
Type: STRING
Provider name: name
content_bytes
Type: STRING
Provider name: contentBytes
Description: Write only. Bytes for the hosted content (such as images).
content_type
Type: STRING
Provider name: contentType
Description: Write only. Content type. such as image/png, image/jpg.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
importance
Type: STRING
Provider name: importance
last_edited_date_time
Type: STRING
Provider name: lastEditedDateTime
Description: Read only. Timestamp when edits to the chat message were made. Triggers an ‘Edited’ flag in the Teams UI. If no edits are made the value is null.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
locale
Type: STRING
Provider name: locale
Description: Locale of the chat message set by the client. Always set to en-us.
mentions
Type: UNORDERED_LIST_STRUCT
Provider name: mentions
Description: List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.
id
Type: INT32
Provider name: id
Description: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.
mention_text
Type: STRING
Provider name: mentionText
Description: String used to represent the mention. For example, a user’s display name, a team name.
mentioned
Type: STRUCT
Provider name: mentioned
Description: The entity (user, application, team, channel, or chat) that was @mentioned.
conversation
Type: STRUCT
Provider name: conversation
Description: If present, represents a conversation (for example, team, channel, or chat) @mentioned in a message.
conversation_identity_type
Type: STRING
Provider name: conversationIdentityType
Description: Type of conversation. Possible values are: team, channel, chat, and unknownFutureValue.
name
Type: STRING
Provider name: name
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_history
Type: UNORDERED_LIST_STRUCT
Provider name: messageHistory
Description: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
actions
Type: STRING
Provider name: actions
modified_date_time
Type: STRING
Provider name: modifiedDateTime
Description: The date and time when the message was modified.
reaction
Type: STRUCT
Provider name: reaction
Description: The reaction in the modified message.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
message_type
Type: STRING
Provider name: messageType
policy_violation
Type: STRUCT
Provider name: policyViolation
Description: Defines the properties of a policy violation set by a data loss prevention (DLP) application.
dlp_action
Type: STRING
Provider name: dlpAction
Description: The action taken by the DLP provider on the message with sensitive content. Supported values are: NoneNotifySender – Inform the sender of the violation but allow readers to read the message.BlockAccess – Block readers from reading the message.BlockAccessExternal – Block users outside the organization from reading the message, while allowing users within the organization to read the message.
justification_text
Type: STRING
Provider name: justificationText
Description: Justification text provided by the sender of the message when overriding a policy violation.
policy_tip
Type: STRUCT
Provider name: policyTip
Description: Information to display to the message sender about why the message was flagged as a violation.
compliance_url
Type: STRING
Provider name: complianceUrl
Description: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn’t say in chats)
general_text
Type: STRING
Provider name: generalText
Description: Explanatory text shown to the sender of the message.
matched_condition_descriptions
Type: UNORDERED_LIST_STRING
Provider name: matchedConditionDescriptions
Description: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include ‘Credit Card Number’ and ‘Social Security Number’.
user_action
Type: STRING
Provider name: userAction
Description: Indicates the action taken by the user on a message blocked by the DLP provider. Supported values are: NoneOverrideReportFalsePositiveWhen the DLP provider is updating the message for blocking sensitive content, userAction isn’t required.
verdict_details
Type: STRING
Provider name: verdictDetails
Description: Indicates what actions the sender may take in response to the policy violation. Supported values are: NoneAllowFalsePositiveOverride – Allows the sender to declare the policyViolation to be an error in the DLP app and its rules, and allow readers to see the message again if the dlpAction hides it.AllowOverrideWithoutJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, without needing to provide an explanation for doing so. AllowOverrideWithJustification – Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, after providing an explanation for doing so.AllowOverrideWithoutJustification and AllowOverrideWithJustification are mutually exclusive.
reactions
Type: UNORDERED_LIST_STRUCT
Provider name: reactions
Description: Reactions for this chat message (for example, Like).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
display_name
Type: STRING
Provider name: displayName
Description: The name of the reaction.
reaction_content_url
Type: STRING
Provider name: reactionContentUrl
Description: The hosted content URL for the custom reaction type.
reaction_type
Type: STRING
Provider name: reactionType
Description: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
user
Type: STRUCT
Provider name: user
name
Type: STRING
Provider name: name
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
reply_to_id
Type: STRING
Provider name: replyToId
Description: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
subject
Type: STRING
Provider name: subject
Description: The subject of the chat message, in plaintext.
summary
Type: STRING
Provider name: summary
Description: Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
web_url
Type: STRING
Provider name: webUrl
Description: Read-only. Link to the message in Microsoft Teams.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
reply_to_id
Type: STRING
Provider name: replyToId
Description: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
subject
Type: STRING
Provider name: subject
Description: The subject of the chat message, in plaintext.
summary
Type: STRING
Provider name: summary
Description: Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
web_url
Type: STRING
Provider name: webUrl
Description: Read-only. Link to the message in Microsoft Teams.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
tabs
Type: UNORDERED_LIST_STRUCT
Provider name: tabs
Description: A collection of all the tabs in the chat. Nullable.
configuration
Type: STRUCT
Provider name: configuration
Description: Container for custom settings applied to a tab. The tab is considered configured only once this property is set.
content_url
Type: STRING
Provider name: contentUrl
Description: Url used for rendering tab contents in Teams. Required.
entity_id
Type: STRING
Provider name: entityId
Description: Identifier for the entity hosted by the tab provider.
remove_url
Type: STRING
Provider name: removeUrl
Description: Url called by Teams client when a Tab is removed using the Teams Client.
website_url
Type: STRING
Provider name: websiteUrl
Description: Url for showing tab contents outside of Teams.
display_name
Type: STRING
Provider name: displayName
Description: Name of the tab.
name
Type: STRING
Provider name: name
teams_app
Type: STRUCT
Provider name: teamsApp
Description: The application that is linked to the tab. This can’t be changed after tab creation.
app_definitions
Type: UNORDERED_LIST_STRUCT
Provider name: appDefinitions
Description: The details for each version of the app.
authorization
Type: STRUCT
Provider name: authorization
Description: Authorization requirements specified in the Teams app manifest.
client_app_id
Type: STRING
Provider name: clientAppId
Description: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
required_permission_set
Type: STRUCT
Provider name: requiredPermissionSet
Description: Set of permissions required by the teamsApp.
resource_specific_permissions
Type: UNORDERED_LIST_STRUCT
Provider name: resourceSpecificPermissions
Description: A collection of resource-specific permissions.
permission_type
Type: STRING
Provider name: permissionType
Description: The type of resource-specific permission.
permission_value
Type: STRING
Provider name: permissionValue
Description: The name of the resource-specific permission.
bot
Type: STRUCT
Provider name: bot
Description: The details of the bot specified in the Teams app manifest.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
description
Type: STRING
Provider name: description
Description: Verbose description of the application.
display_name
Type: STRING
Provider name: displayName
Description: The name of the app provided by the app developer.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
name
Type: STRING
Provider name: name
publishing_state
Type: STRING
Provider name: publishingState
Description: The published status of a specific version of a Teams app. Possible values are:submitted—The specific version of the Teams app was submitted and is under review.published—The request to publish the specific version of the Teams app was approved by the admin and the app is published.rejected—The admin rejected the request to publish the specific version of the Teams app.
short_description
Type: STRING
Provider name: shortDescription
Description: Short description of the application.
teams_app_id
Type: STRING
Provider name: teamsAppId
Description: The ID from the Teams app manifest.
version
Type: STRING
Provider name: version
Description: The version number of the application.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
distribution_method
Type: STRING
Provider name: distributionMethod
Description: The method of distribution for the app. Read-only.
external_id
Type: STRING
Provider name: externalId
Description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
web_url
Type: STRING
Provider name: webUrl
Description: Deep link URL of the tab instance. Read only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
tenant_id
Type: STRING
Provider name: tenantId
Description: The identifier of the tenant in which the chat was created. Read-only.
topic
Type: STRING
Provider name: topic
Description: (Optional) Subject or topic for the chat. Only available for group chats.
viewpoint
Type: STRUCT
Provider name: viewpoint
Description: Represents caller-specific information about the chat, such as the last message read date and time. This property is populated only when the request is made in a delegated context.
is_hidden
Type: BOOLEAN
Provider name: isHidden
Description: Indicates whether the chat is hidden for the current user.
last_message_read_date_time
Type: STRING
Provider name: lastMessageReadDateTime
Description: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
web_url
Type: STRING
Provider name: webUrl
Description: The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
city
Type: STRING
Provider name: city
Description: The city where the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
cloud_clipboard
Type: STRUCT
Provider name: cloudClipboard
items
Type: UNORDERED_LIST_STRUCT
Provider name: items
Description: Represents a collection of Cloud Clipboard items.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Set by the server. DateTime in UTC when the object was created on the server.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: Set by the server. DateTime in UTC when the object expires and after that the object is no longer available. The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Set by the server if not provided in the client’s request. DateTime in UTC when the object was modified by the client.
name
Type: STRING
Provider name: name
payloads
Type: UNORDERED_LIST_STRUCT
Provider name: payloads
Description: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads. A window can place more than one clipboard object on the clipboard. Each one represents the same information in a different clipboard format.
content
Type: STRING
Provider name: content
Description: The formatName version of the value of a cloud clipboard encoded in base64.
format_name
Type: STRING
Provider name: formatName
Description: For a list of possible values see formatName values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
company_name
Type: STRING
Provider name: companyName
Description: The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
consent_provided_for_minor
Type: STRING
Provider name: consentProvidedForMinor
Description: Sets whether consent was obtained for minors. Allowed values: null, Granted, Denied, and NotRequired. For more information, see legal age group property definitions. Returned only on $select. Supports $filter (eq, ne, not, and in).
Type: UNORDERED_LIST_STRUCT
Provider name: contactFolders
Description: The user’s contacts folders. Read-only. Nullable.
child_folders
Type: UNORDERED_LIST_STRUCT
Provider name: childFolders
Description: The collection of child folders in the folder. Navigation property. Read-only. Nullable.
display_name
Type: STRING
Provider name: displayName
Description: The folder’s display name.
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The ID of the folder’s parent folder.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
contacts
Type: UNORDERED_LIST_STRUCT
Provider name: contacts
Description: The contacts in the folder. Navigation property. Read-only. Nullable.
assistant_name
Type: STRING
Provider name: assistantName
Description: The name of the contact’s assistant.
birthday
Type: STRING
Provider name: birthday
Description: The contact’s birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
business_address
Type: STRUCT
Provider name: businessAddress
Description: The contact’s business address.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
business_home_page
Type: STRING
Provider name: businessHomePage
Description: The business home page of the contact.
business_phones
Type: UNORDERED_LIST_STRING
Provider name: businessPhones
Description: The contact’s business phone numbers.
children
Type: UNORDERED_LIST_STRING
Provider name: children
Description: The names of the contact’s children.
company_name
Type: STRING
Provider name: companyName
Description: The name of the contact’s company.
department
Type: STRING
Provider name: department
Description: The contact’s department.
display_name
Type: STRING
Provider name: displayName
Description: The contact’s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.
email_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: emailAddresses
Description: The contact’s email addresses.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the contact. Read-only. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
file_as
Type: STRING
Provider name: fileAs
Description: The name the contact is filed under.
generation
Type: STRING
Provider name: generation
Description: The contact’s suffix.
given_name
Type: STRING
Provider name: givenName
Description: The contact’s given name.
home_address
Type: STRUCT
Provider name: homeAddress
Description: The contact’s home address.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
home_phones
Type: UNORDERED_LIST_STRING
Provider name: homePhones
Description: The contact’s home phone numbers.
im_addresses
Type: UNORDERED_LIST_STRING
Provider name: imAddresses
Description: The contact’s instant messaging (IM) addresses.
initials
Type: STRING
Provider name: initials
Description: The contact’s initials.
job_title
Type: STRING
Provider name: jobTitle
Description: The contact’s job title.
manager
Type: STRING
Provider name: manager
Description: The name of the contact’s manager.
middle_name
Type: STRING
Provider name: middleName
Description: The contact’s middle name.
mobile_phone
Type: STRING
Provider name: mobilePhone
Description: The contact’s mobile phone number.
multi_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: multiValueExtendedProperties
Description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: UNORDERED_LIST_STRING
Provider name: value
Description: A collection of property values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
nick_name
Type: STRING
Provider name: nickName
Description: The contact’s nickname.
office_location
Type: STRING
Provider name: officeLocation
Description: The location of the contact’s office.
other_address
Type: STRUCT
Provider name: otherAddress
Description: Other addresses for the contact.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The ID of the contact’s parent folder.
personal_notes
Type: STRING
Provider name: personalNotes
Description: The user’s notes about the contact.
photo
Type: STRUCT
Provider name: photo
Description: Optional contact picture. You can get or set a photo for a contact.
height
Type: INT32
Provider name: height
Description: The height of the photo. Read-only.
name
Type: STRING
Provider name: name
width
Type: INT32
Provider name: width
Description: The width of the photo. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
profession
Type: STRING
Provider name: profession
Description: The contact’s profession.
single_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: singleValueExtendedProperties
Description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: STRING
Provider name: value
Description: A property value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
spouse_name
Type: STRING
Provider name: spouseName
Description: The name of the contact’s spouse/partner.
surname
Type: STRING
Provider name: surname
Description: The contact’s surname.
title
Type: STRING
Provider name: title
Description: The contact’s title.
yomi_company_name
Type: STRING
Provider name: yomiCompanyName
Description: The phonetic Japanese company name of the contact.
yomi_given_name
Type: STRING
Provider name: yomiGivenName
Description: The phonetic Japanese given name (first name) of the contact.
yomi_surname
Type: STRING
Provider name: yomiSurname
Description: The phonetic Japanese surname (last name) of the contact.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: The categories associated with the item
change_key
Type: STRING
Provider name: changeKey
Description: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The folder’s display name.
multi_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: multiValueExtendedProperties
Description: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: UNORDERED_LIST_STRING
Provider name: value
Description: A collection of property values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The ID of the folder’s parent folder.
single_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: singleValueExtendedProperties
Description: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: STRING
Provider name: value
Description: A property value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
Type: UNORDERED_LIST_STRUCT
Provider name: contacts
Description: The user’s contacts. Read-only. Nullable.
assistant_name
Type: STRING
Provider name: assistantName
Description: The name of the contact’s assistant.
birthday
Type: STRING
Provider name: birthday
Description: The contact’s birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
business_address
Type: STRUCT
Provider name: businessAddress
Description: The contact’s business address.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
business_home_page
Type: STRING
Provider name: businessHomePage
Description: The business home page of the contact.
business_phones
Type: UNORDERED_LIST_STRING
Provider name: businessPhones
Description: The contact’s business phone numbers.
children
Type: UNORDERED_LIST_STRING
Provider name: children
Description: The names of the contact’s children.
company_name
Type: STRING
Provider name: companyName
Description: The name of the contact’s company.
department
Type: STRING
Provider name: department
Description: The contact’s department.
display_name
Type: STRING
Provider name: displayName
Description: The contact’s display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation.
email_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: emailAddresses
Description: The contact’s email addresses.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the contact. Read-only. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
file_as
Type: STRING
Provider name: fileAs
Description: The name the contact is filed under.
generation
Type: STRING
Provider name: generation
Description: The contact’s suffix.
given_name
Type: STRING
Provider name: givenName
Description: The contact’s given name.
home_address
Type: STRUCT
Provider name: homeAddress
Description: The contact’s home address.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
home_phones
Type: UNORDERED_LIST_STRING
Provider name: homePhones
Description: The contact’s home phone numbers.
im_addresses
Type: UNORDERED_LIST_STRING
Provider name: imAddresses
Description: The contact’s instant messaging (IM) addresses.
initials
Type: STRING
Provider name: initials
Description: The contact’s initials.
job_title
Type: STRING
Provider name: jobTitle
Description: The contact’s job title.
manager
Type: STRING
Provider name: manager
Description: The name of the contact’s manager.
middle_name
Type: STRING
Provider name: middleName
Description: The contact’s middle name.
mobile_phone
Type: STRING
Provider name: mobilePhone
Description: The contact’s mobile phone number.
multi_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: multiValueExtendedProperties
Description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: UNORDERED_LIST_STRING
Provider name: value
Description: A collection of property values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
nick_name
Type: STRING
Provider name: nickName
Description: The contact’s nickname.
office_location
Type: STRING
Provider name: officeLocation
Description: The location of the contact’s office.
other_address
Type: STRUCT
Provider name: otherAddress
Description: Other addresses for the contact.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The ID of the contact’s parent folder.
personal_notes
Type: STRING
Provider name: personalNotes
Description: The user’s notes about the contact.
photo
Type: STRUCT
Provider name: photo
Description: Optional contact picture. You can get or set a photo for a contact.
height
Type: INT32
Provider name: height
Description: The height of the photo. Read-only.
name
Type: STRING
Provider name: name
width
Type: INT32
Provider name: width
Description: The width of the photo. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
profession
Type: STRING
Provider name: profession
Description: The contact’s profession.
single_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: singleValueExtendedProperties
Description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: STRING
Provider name: value
Description: A property value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
spouse_name
Type: STRING
Provider name: spouseName
Description: The name of the contact’s spouse/partner.
surname
Type: STRING
Provider name: surname
Description: The contact’s surname.
title
Type: STRING
Provider name: title
Description: The contact’s title.
yomi_company_name
Type: STRING
Provider name: yomiCompanyName
Description: The phonetic Japanese company name of the contact.
yomi_given_name
Type: STRING
Provider name: yomiGivenName
Description: The phonetic Japanese given name (first name) of the contact.
yomi_surname
Type: STRING
Provider name: yomiSurname
Description: The phonetic Japanese surname (last name) of the contact.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: The categories associated with the item
change_key
Type: STRING
Provider name: changeKey
Description: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
country
Type: STRING
Provider name: country
Description: The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time the user was created, in ISO 8601 format and UTC. The value can’t be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
created_objects
Type: UNORDERED_LIST_STRUCT
Provider name: createdObjects
Description: Directory objects that the user created. Read-only. Nullable.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
creation_type
Type: STRING
Provider name: creationType
Description: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by a guest signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, not, in).
custom_security_attributes
Type: STRUCT
Provider name: customSecurityAttributes
Description: An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select. Supports $filter (eq, ne, not, startsWith). The filter value is case-sensitive. To read this property, the calling app must be assigned the CustomSecAttributeAssignment.Read.All permission. To write this property, the calling app must be assigned the CustomSecAttributeAssignment.ReadWrite.All permissions. To read or write this property in delegated scenarios, the admin must be assigned the Attribute Assignment Administrator role.
data_security_and_governance
Type: STRUCT
Provider name: dataSecurityAndGovernance
Description: The data security and governance settings for the user. Read-only. Nullable.
activities
Type: STRUCT
Provider name: activities
Description: Container for activity logs (content processing and audit) related to this user. ContainsTarget: true.
content_activities
Type: UNORDERED_LIST_STRUCT
Provider name: contentActivities
Description: Collection of activity logs related to content processing.
content_metadata
Type: STRUCT
Provider name: contentMetadata
activity_metadata
Type: STRUCT
Provider name: activityMetadata
activity
Type: STRING
Provider name: activity
content_entries
Type: UNORDERED_LIST_STRUCT
Provider name: contentEntries
Description: A collection of content entries to be processed. Each entry contains the content itself and its metadata. Use conversation metadata for content like prompts and responses and file metadata for files. Required.
content
Type: STRUCT
Provider name: content
Description: Represents the actual content, either as text (textContent) or binary data (binaryContent). Optional if metadata alone is sufficient for policy evaluation. Do not use for contentActivities.
correlation_id
Type: STRING
Provider name: correlationId
Description: An identifier used to group multiple related content entries (for example, different parts of the same file upload, messages in a conversation).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Required. Timestamp indicating when the original content was created (for example, file creation time, message sent time).
identifier
Type: STRING
Provider name: identifier
Description: Required. A unique identifier for this specific content entry within the context of the calling application or enforcement plane (for example, message ID, file path/URL).
is_truncated
Type: BOOLEAN
Provider name: isTruncated
Description: Required. Indicates if the provided content has been truncated from its original form (for example, due to size limits).
length
Type: INT64
Provider name: length
Description: The length of the original content in bytes.
modified_date_time
Type: STRING
Provider name: modifiedDateTime
Description: Required. Timestamp indicating when the original content was last modified. For ephemeral content like messages, this might be the same as createdDateTime.
name
Type: STRING
Provider name: name
Description: Required. A descriptive name for the content (for example, file name, web page title, ‘Chat Message’).
sequence_number
Type: INT64
Provider name: sequenceNumber
Description: A sequence number indicating the order in which content was generated or should be processed, required when correlationId is used.
device_metadata
Type: STRUCT
Provider name: deviceMetadata
device_type
Type: STRING
Provider name: deviceType
Description: Optional. The general type of the device (for example, ‘Managed’, ‘Unmanaged’).
ip_address
Type: STRING
Provider name: ipAddress
Description: The Internet Protocol (IP) address of the device.
operating_system_specifications
Type: STRUCT
Provider name: operatingSystemSpecifications
Description: Details about the operating system platform and version.
operating_system_platform
Type: STRING
Provider name: operatingSystemPlatform
Description: The platform of the operating system (for example, ‘Windows’).
operating_system_version
Type: STRING
Provider name: operatingSystemVersion
Description: The version string of the operating system.
integrated_app_metadata
Type: STRUCT
Provider name: integratedAppMetadata
name
Type: STRING
Provider name: name
Description: The name of the integrated application.
version
Type: STRING
Provider name: version
Description: The version number of the integrated application.
protected_app_metadata
Type: STRUCT
Provider name: protectedAppMetadata
Description: Metadata about the protected application making the request. Required.
application_location
Type: STRUCT
Provider name: applicationLocation
Description: The client (application) ID of the Microsoft Entra application. Required.
value
Type: STRING
Provider name: value
Description: The actual value representing the location. Location value is specific for concretetype of the policyLocation - policyLocationDomain, policyLocationUrl, or policyLocationApplication (for example, ‘contoso.com’, ‘https://partner.contoso.com/upload', ‘83ef198a-0396-4893-9d4f-d36efbffcaaa’).
name
Type: STRING
Provider name: name
Description: The name of the integrated application.
version
Type: STRING
Provider name: version
Description: The version number of the integrated application.
name
Type: STRING
Provider name: name
scope_identifier
Type: STRING
Provider name: scopeIdentifier
Description: The scope identified from computed protection scopes.
user_id
Type: STRING
Provider name: userId
Description: ID of the user.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
protection_scopes
Type: STRUCT
Provider name: protectionScopes
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
sensitivity_labels
Type: UNORDERED_LIST_STRUCT
Provider name: sensitivityLabels
action_source
Type: STRING
Provider name: actionSource
auto_tooltip
Type: STRING
Provider name: autoTooltip
description
Type: STRING
Provider name: description
display_name
Type: STRING
Provider name: displayName
is_default
Type: BOOLEAN
Provider name: isDefault
is_endpoint_protection_enabled
Type: BOOLEAN
Provider name: isEndpointProtectionEnabled
is_scoped_to_user
Type: BOOLEAN
Provider name: isScopedToUser
locale
Type: STRING
Provider name: locale
name
Type: STRING
Provider name: name
priority
Type: INT32
Provider name: priority
rights
Type: STRUCT
Provider name: rights
name
Type: STRING
Provider name: name
owner_email
Type: STRING
Provider name: ownerEmail
Description: The email of owner label rights.
user_email
Type: STRING
Provider name: userEmail
Description: The email of user with label user rights.
value
Type: STRING
Provider name: value
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
sublabels
Type: UNORDERED_LIST_STRUCT
Provider name: sublabels
action_source
Type: STRING
Provider name: actionSource
auto_tooltip
Type: STRING
Provider name: autoTooltip
description
Type: STRING
Provider name: description
display_name
Type: STRING
Provider name: displayName
is_default
Type: BOOLEAN
Provider name: isDefault
is_endpoint_protection_enabled
Type: BOOLEAN
Provider name: isEndpointProtectionEnabled
is_scoped_to_user
Type: BOOLEAN
Provider name: isScopedToUser
locale
Type: STRING
Provider name: locale
name
Type: STRING
Provider name: name
priority
Type: INT32
Provider name: priority
rights
Type: STRUCT
Provider name: rights
name
Type: STRING
Provider name: name
owner_email
Type: STRING
Provider name: ownerEmail
Description: The email of owner label rights.
user_email
Type: STRING
Provider name: userEmail
Description: The email of user with label user rights.
value
Type: STRING
Provider name: value
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
tool_tip
Type: STRING
Provider name: toolTip
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
tool_tip
Type: STRING
Provider name: toolTip
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
department
Type: STRING
Provider name: department
Description: The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).
device_enrollment_limit
Type: INT32
Provider name: deviceEnrollmentLimit
Description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
device_management_troubleshooting_events
Type: UNORDERED_LIST_STRUCT
Provider name: deviceManagementTroubleshootingEvents
Description: The list of troubleshooting events for this user.
correlation_id
Type: STRING
Provider name: correlationId
Description: Id used for tracing the failure in the service.
event_date_time
Type: STRING
Provider name: eventDateTime
Description: Time when the event occurred .
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
direct_reports
Type: UNORDERED_LIST_STRUCT
Provider name: directReports
Description: The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The name displayed in the address book for the user. This value is usually the combination of the user’s first name, middle initial, and family name. This property is required when a user is created and it can’t be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search.
employee_experience
Type: STRUCT
Provider name: employeeExperience
learning_course_activities
Type: UNORDERED_LIST_STRUCT
Provider name: learningCourseActivities
completed_date_time
Type: STRING
Provider name: completedDateTime
Description: Date and time when the assignment was completed. Optional.
completion_percentage
Type: INT32
Provider name: completionPercentage
Description: The percentage completion value of the course activity. Optional.
externalcourse_activity_id
Type: STRING
Provider name: externalcourseActivityId
learner_user_id
Type: STRING
Provider name: learnerUserId
Description: The user ID of the learner to whom the activity is assigned. Required.
learning_content_id
Type: STRING
Provider name: learningContentId
Description: The ID of the learning content created in Viva Learning. Required.
learning_provider_id
Type: STRING
Provider name: learningProviderId
Description: The registration ID of the provider. Required.
name
Type: STRING
Provider name: name
status
Type: STRING
Provider name: status
Description: The status of the course activity. Possible values are: notStarted, inProgress, completed. Required.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
employee_hire_date
Type: STRING
Provider name: employeeHireDate
Description: The date and time when the user was hired or will start work in a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
employee_id
Type: STRING
Provider name: employeeId
Description: The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
employee_leave_date_time
Type: STRING
Provider name: employeeLeaveDateTime
Description: The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator (least privilege), Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.
employee_org_data
Type: STRUCT
Provider name: employeeOrgData
Description: Represents organization data (for example, division and costCenter) associated with a user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
cost_center
Type: STRING
Provider name: costCenter
Description: The cost center associated with the user. Returned only on $select. Supports $filter.
division
Type: STRING
Provider name: division
Description: The name of the division in which the user works. Returned only on $select. Supports $filter.
employee_type
Type: STRING
Provider name: employeeType
Description: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
external_user_state
Type: STRING
Provider name: externalUserState
Description: For a guest invited to the tenant using the invitation API, this property represents the invited user’s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in).
external_user_state_change_date_time
Type: STRING
Provider name: externalUserStateChangeDateTime
Description: Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in).
fax_number
Type: STRING
Provider name: faxNumber
Description: The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
given_name
Type: STRING
Provider name: givenName
Description: The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
hire_date
Type: STRING
Provider name: hireDate
Description: The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
identities
Type: UNORDERED_LIST_STRUCT
Provider name: identities
Description: Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) with limitations.
issuer
Type: STRING
Provider name: issuer
Description: Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn’t federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
issuer_assigned_id
Type: STRING
Provider name: issuerAssignedId
Description: Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress (or a custom string that starts with emailAddress like emailAddress1), issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _ For more information about filtering behavior for this property, see Filtering on the identities property of a user.
sign_in_type
Type: STRING
Provider name: signInType
Description: Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity updates the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, are performed when setting or updating a userPrincipalName identity. Extra validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
im_addresses
Type: UNORDERED_LIST_STRING
Provider name: imAddresses
Description: The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).
inference_classification
Type: STRUCT
Provider name: inferenceClassification
Description: Relevance classification of the user’s messages based on explicit designations that override inferred relevance or importance.
name
Type: STRING
Provider name: name
overrides
Type: UNORDERED_LIST_STRUCT
Provider name: overrides
Description: A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.
classify_as
Type: STRING
Provider name: classifyAs
Description: Specifies how incoming messages from a specific sender should always be classified as. The possible values are: focused, other.
name
Type: STRING
Provider name: name
sender_email_address
Type: STRUCT
Provider name: senderEmailAddress
Description: The email address information of the sender for whom the override is created.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
insights
Type: STRUCT
Provider name: insights
Description: Represents relationships between a user and items such as OneDrive for work or school documents, calculated using advanced analytics and machine learning techniques. Read-only. Nullable.
name
Type: STRING
Provider name: name
shared
Type: UNORDERED_LIST_STRUCT
Provider name: shared
Description: Calculated relationship that identifies documents shared with or by the user. This includes URLs, file attachments, and reference attachments to OneDrive for work or school and SharePoint files found in Outlook messages and meetings. This also includes URLs and reference attachments to Teams conversations. Ordered by recency of share.
last_shared
Type: STRUCT
Provider name: lastShared
Description: Details about the shared item. Read only.
shared_by
Type: STRUCT
Provider name: sharedBy
Description: The user who shared the document.
address
Type: STRING
Provider name: address
Description: The email address of the user who shared the item.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the user who shared the item.
id
Type: STRING
Provider name: id
Description: The ID of the user who shared the item.
shared_date_time
Type: STRING
Provider name: sharedDateTime
Description: The date and time the file was last shared. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
sharing_reference
Type: STRUCT
Provider name: sharingReference
Description: Reference properties of the document, such as the URL and type of the document. Read-only
id
Type: STRING
Provider name: id
Description: The item’s unique identifier.
type
Type: STRING
Provider name: type
Description: A string value that can be used to classify the item, such as ‘microsoft.graph.driveItem’
web_url
Type: STRING
Provider name: webUrl
Description: A URL leading to the referenced item.
sharing_subject
Type: STRING
Provider name: sharingSubject
Description: The subject with which the document was shared.
sharing_type
Type: STRING
Provider name: sharingType
Description: Determines the way the document was shared. Can be by a 1Link1, 1Attachment1, 1Group1, 1Site1.
last_shared_method
Type: STRUCT
Provider name: lastSharedMethod
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
resource
Type: STRUCT
Provider name: resource
Description: Used for navigating to the item that was shared. For file attachments, the type is fileAttachment. For linked attachments, the type is driveItem.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
resource_reference
Type: STRUCT
Provider name: resourceReference
Description: Reference properties of the shared document, such as the url and type of the document. Read-only
id
Type: STRING
Provider name: id
Description: The item’s unique identifier.
type
Type: STRING
Provider name: type
Description: A string value that can be used to classify the item, such as ‘microsoft.graph.driveItem’
web_url
Type: STRING
Provider name: webUrl
Description: A URL leading to the referenced item.
resource_visualization
Type: STRUCT
Provider name: resourceVisualization
Description: Properties that you can use to visualize the document in your experience. Read-only
container_display_name
Type: STRING
Provider name: containerDisplayName
Description: A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item.
container_type
Type: STRING
Provider name: containerType
Description: Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness.
container_web_url
Type: STRING
Provider name: containerWebUrl
Description: A path leading to the folder in which the item is stored.
media_type
Type: STRING
Provider name: mediaType
Description: The item’s media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Not all Media Mime Types are supported.
preview_image_url
Type: STRING
Provider name: previewImageUrl
Description: A URL leading to the preview image for the item.
preview_text
Type: STRING
Provider name: previewText
Description: A preview text for the item.
title
Type: STRING
Provider name: title
Description: The item’s title text.
type
Type: STRING
Provider name: type
Description: The item’s media type. Can be used for filtering for a specific file based on a specific type. See the section Type property values for supported types.
sharing_history
Type: UNORDERED_LIST_STRUCT
Provider name: sharingHistory
shared_by
Type: STRUCT
Provider name: sharedBy
Description: The user who shared the document.
address
Type: STRING
Provider name: address
Description: The email address of the user who shared the item.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the user who shared the item.
id
Type: STRING
Provider name: id
Description: The ID of the user who shared the item.
shared_date_time
Type: STRING
Provider name: sharedDateTime
Description: The date and time the file was last shared. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
sharing_reference
Type: STRUCT
Provider name: sharingReference
Description: Reference properties of the document, such as the URL and type of the document. Read-only
id
Type: STRING
Provider name: id
Description: The item’s unique identifier.
type
Type: STRING
Provider name: type
Description: A string value that can be used to classify the item, such as ‘microsoft.graph.driveItem’
web_url
Type: STRING
Provider name: webUrl
Description: A URL leading to the referenced item.
sharing_subject
Type: STRING
Provider name: sharingSubject
Description: The subject with which the document was shared.
sharing_type
Type: STRING
Provider name: sharingType
Description: Determines the way the document was shared. Can be by a 1Link1, 1Attachment1, 1Group1, 1Site1.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
trending
Type: UNORDERED_LIST_STRUCT
Provider name: trending
Description: Calculated relationship that identifies documents trending around a user. Trending documents are calculated based on activity of the user’s closest network of people and include files stored in OneDrive for work or school and SharePoint. Trending insights help the user to discover potentially useful content that the user has access to, but has never viewed before.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
name
Type: STRING
Provider name: name
resource
Type: STRUCT
Provider name: resource
Description: Used for navigating to the trending document.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
resource_reference
Type: STRUCT
Provider name: resourceReference
Description: Reference properties of the trending document, such as the url and type of the document.
id
Type: STRING
Provider name: id
Description: The item’s unique identifier.
type
Type: STRING
Provider name: type
Description: A string value that can be used to classify the item, such as ‘microsoft.graph.driveItem’
web_url
Type: STRING
Provider name: webUrl
Description: A URL leading to the referenced item.
resource_visualization
Type: STRUCT
Provider name: resourceVisualization
Description: Properties that you can use to visualize the document in your experience.
container_display_name
Type: STRING
Provider name: containerDisplayName
Description: A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item.
container_type
Type: STRING
Provider name: containerType
Description: Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness.
container_web_url
Type: STRING
Provider name: containerWebUrl
Description: A path leading to the folder in which the item is stored.
media_type
Type: STRING
Provider name: mediaType
Description: The item’s media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Not all Media Mime Types are supported.
preview_image_url
Type: STRING
Provider name: previewImageUrl
Description: A URL leading to the preview image for the item.
preview_text
Type: STRING
Provider name: previewText
Description: A preview text for the item.
title
Type: STRING
Provider name: title
Description: The item’s title text.
type
Type: STRING
Provider name: type
Description: The item’s media type. Can be used for filtering for a specific file based on a specific type. See the section Type property values for supported types.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
used
Type: UNORDERED_LIST_STRUCT
Provider name: used
Description: Calculated relationship that identifies the latest documents viewed or modified by a user, including OneDrive for work or school and SharePoint documents, ranked by recency of use.
last_used
Type: STRUCT
Provider name: lastUsed
Description: Information about when the item was last viewed or modified by the user. Read only.
last_accessed_date_time
Type: STRING
Provider name: lastAccessedDateTime
Description: The date and time the resource was last accessed by the user. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time the resource was last modified by the user. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
resource
Type: STRUCT
Provider name: resource
Description: Used for navigating to the item that was used. For file attachments, the type is fileAttachment. For linked attachments, the type is driveItem.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
resource_reference
Type: STRUCT
Provider name: resourceReference
Description: Reference properties of the used document, such as the url and type of the document. Read-only
id
Type: STRING
Provider name: id
Description: The item’s unique identifier.
type
Type: STRING
Provider name: type
Description: A string value that can be used to classify the item, such as ‘microsoft.graph.driveItem’
web_url
Type: STRING
Provider name: webUrl
Description: A URL leading to the referenced item.
resource_visualization
Type: STRUCT
Provider name: resourceVisualization
Description: Properties that you can use to visualize the document in your experience. Read-only
container_display_name
Type: STRING
Provider name: containerDisplayName
Description: A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item.
container_type
Type: STRING
Provider name: containerType
Description: Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness.
container_web_url
Type: STRING
Provider name: containerWebUrl
Description: A path leading to the folder in which the item is stored.
media_type
Type: STRING
Provider name: mediaType
Description: The item’s media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Not all Media Mime Types are supported.
preview_image_url
Type: STRING
Provider name: previewImageUrl
Description: A URL leading to the preview image for the item.
preview_text
Type: STRING
Provider name: previewText
Description: A preview text for the item.
title
Type: STRING
Provider name: title
Description: The item’s title text.
type
Type: STRING
Provider name: type
Description: The item’s media type. Can be used for filtering for a specific file based on a specific type. See the section Type property values for supported types.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
interests
Type: UNORDERED_LIST_STRING
Provider name: interests
Description: A list for the user to describe their interests. Returned only on $select.
is_management_restricted
Type: BOOLEAN
Provider name: isManagementRestricted
Description: true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.
is_resource_account
Type: BOOLEAN
Provider name: isResourceAccount
Description: Don’t use – reserved for future use.
job_title
Type: STRING
Provider name: jobTitle
Description: The user’s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
last_password_change_date_time
Type: STRING
Provider name: lastPasswordChangeDateTime
Description: The time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.
legal_age_group_classification
Type: STRING
Provider name: legalAgeGroupClassification
Description: Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, Undefined, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select.
license_assignment_states
Type: UNORDERED_LIST_STRUCT
Provider name: licenseAssignmentStates
Description: State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select.
assigned_by_group
Type: STRING
Provider name: assignedByGroup
disabled_plans
Type: UNORDERED_LIST_STRING
Provider name: disabledPlans
error
Type: STRING
Provider name: error
last_updated_date_time
Type: STRING
Provider name: lastUpdatedDateTime
sku_id
Type: STRING
Provider name: skuId
state
Type: STRING
Provider name: state
license_details
Type: UNORDERED_LIST_STRUCT
Provider name: licenseDetails
Description: A collection of this user’s license details. Read-only.
name
Type: STRING
Provider name: name
service_plans
Type: UNORDERED_LIST_STRUCT
Provider name: servicePlans
Description: Information about the service plans assigned with the license. Read-only. Not nullable.
applies_to
Type: STRING
Provider name: appliesTo
Description: The object the service plan can be assigned to. The possible values are:User - service plan can be assigned to individual users.Company - service plan can be assigned to the entire tenant.
provisioning_status
Type: STRING
Provider name: provisioningStatus
Description: The provisioning status of the service plan. The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn’t provisioned and is in an error state.PendingInput - The service isn’t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn’t activated in the tenant.
service_plan_id
Type: STRING
Provider name: servicePlanId
Description: The unique identifier of the service plan.
service_plan_name
Type: STRING
Provider name: servicePlanName
Description: The name of the service plan.
sku_id
Type: STRING
Provider name: skuId
Description: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.
sku_part_number
Type: STRING
Provider name: skuPartNumber
Description: Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
location
Type: STRING
mail
Type: STRING
Provider name: mail
Description: The SMTP address for the user, for example, jeff@contoso.com. Changes to this property update the user’s proxyAddresses collection to include the value as an SMTP address. This property can’t contain accent characters. NOTE: We don’t recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).
mail_folders
Type: UNORDERED_LIST_STRUCT
Provider name: mailFolders
Description: The user’s mail folders. Read-only. Nullable.
child_folder_count
Type: INT32
Provider name: childFolderCount
Description: The number of immediate child mailFolders in the current mailFolder.
child_folders
Type: UNORDERED_LIST_STRUCT
Provider name: childFolders
Description: The collection of child folders in the mailFolder.
child_folder_count
Type: INT32
Provider name: childFolderCount
Description: The number of immediate child mailFolders in the current mailFolder.
display_name
Type: STRING
Provider name: displayName
Description: The mailFolder’s display name.
is_hidden
Type: BOOLEAN
Provider name: isHidden
Description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The unique identifier for the mailFolder’s parent mailFolder.
total_item_count
Type: INT32
Provider name: totalItemCount
Description: The number of items in the mailFolder.
unread_item_count
Type: INT32
Provider name: unreadItemCount
Description: The number of items in the mailFolder marked as unread.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
display_name
Type: STRING
Provider name: displayName
Description: The mailFolder’s display name.
is_hidden
Type: BOOLEAN
Provider name: isHidden
Description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
message_rules
Type: UNORDERED_LIST_STRUCT
Provider name: messageRules
Description: The collection of rules that apply to the user’s Inbox folder.
actions
Type: STRUCT
Provider name: actions
Description: Actions to be taken on a message when the corresponding conditions are fulfilled.
assign_categories
Type: UNORDERED_LIST_STRING
Provider name: assignCategories
Description: A list of categories to be assigned to a message.
copy_to_folder
Type: STRING
Provider name: copyToFolder
Description: The ID of a folder that a message is to be copied to.
delete
Type: BOOLEAN
Provider name: delete
Description: Indicates whether a message should be moved to the Deleted Items folder.
forward_as_attachment_to
Type: UNORDERED_LIST_STRUCT
Provider name: forwardAsAttachmentTo
Description: The email addresses of the recipients to which a message should be forwarded as an attachment.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
forward_to
Type: UNORDERED_LIST_STRUCT
Provider name: forwardTo
Description: The email addresses of the recipients to which a message should be forwarded.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
mark_as_read
Type: BOOLEAN
Provider name: markAsRead
Description: Indicates whether a message should be marked as read.
mark_importance
Type: STRING
Provider name: markImportance
Description: Sets the importance of the message, which can be: low, normal, high.
move_to_folder
Type: STRING
Provider name: moveToFolder
Description: The ID of the folder that a message will be moved to.
permanent_delete
Type: BOOLEAN
Provider name: permanentDelete
Description: Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder.
redirect_to
Type: UNORDERED_LIST_STRUCT
Provider name: redirectTo
Description: The email addresses to which a message should be redirected.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
stop_processing_rules
Type: BOOLEAN
Provider name: stopProcessingRules
Description: Indicates whether subsequent rules should be evaluated.
conditions
Type: STRUCT
Provider name: conditions
Description: Conditions that when fulfilled trigger the corresponding actions for that rule.
body_contains
Type: UNORDERED_LIST_STRING
Provider name: bodyContains
Description: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.
body_or_subject_contains
Type: UNORDERED_LIST_STRING
Provider name: bodyOrSubjectContains
Description: Represents the strings that should appear in the body or subject of an incoming message in order for the condition or exception to apply.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.
from_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: fromAddresses
Description: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
has_attachments
Type: BOOLEAN
Provider name: hasAttachments
Description: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.
header_contains
Type: UNORDERED_LIST_STRING
Provider name: headerContains
Description: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.
importance
Type: STRING
Provider name: importance
Description: The importance that is stamped on an incoming message in order for the condition or exception to apply: low, normal, high.
is_approval_request
Type: BOOLEAN
Provider name: isApprovalRequest
Description: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.
is_automatic_forward
Type: BOOLEAN
Provider name: isAutomaticForward
Description: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.
is_automatic_reply
Type: BOOLEAN
Provider name: isAutomaticReply
Description: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.
is_encrypted
Type: BOOLEAN
Provider name: isEncrypted
Description: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.
is_meeting_request
Type: BOOLEAN
Provider name: isMeetingRequest
Description: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.
is_meeting_response
Type: BOOLEAN
Provider name: isMeetingResponse
Description: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.
is_non_delivery_report
Type: BOOLEAN
Provider name: isNonDeliveryReport
Description: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.
is_permission_controlled
Type: BOOLEAN
Provider name: isPermissionControlled
Description: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.
is_read_receipt
Type: BOOLEAN
Provider name: isReadReceipt
Description: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.
is_signed
Type: BOOLEAN
Provider name: isSigned
Description: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.
is_voicemail
Type: BOOLEAN
Provider name: isVoicemail
Description: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.
message_action_flag
Type: STRING
Provider name: messageActionFlag
Description: Represents the flag-for-action value that appears on an incoming message in order for the condition or exception to apply. The possible values are: any, call, doNotForward, followUp, fyi, forward, noResponseNecessary, read, reply, replyToAll, review.
not_sent_to_me
Type: BOOLEAN
Provider name: notSentToMe
Description: Indicates whether the owner of the mailbox must not be a recipient of an incoming message in order for the condition or exception to apply.
recipient_contains
Type: UNORDERED_LIST_STRING
Provider name: recipientContains
Description: Represents the strings that appear in either the toRecipients or ccRecipients properties of an incoming message in order for the condition or exception to apply.
sender_contains
Type: UNORDERED_LIST_STRING
Provider name: senderContains
Description: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.
sensitivity
Type: STRING
Provider name: sensitivity
Description: Represents the sensitivity level that must be stamped on an incoming message in order for the condition or exception to apply. The possible values are: normal, personal, private, confidential.
sent_cc_me
Type: BOOLEAN
Provider name: sentCcMe
Description: Indicates whether the owner of the mailbox must be in the ccRecipients property of an incoming message in order for the condition or exception to apply.
sent_only_to_me
Type: BOOLEAN
Provider name: sentOnlyToMe
Description: Indicates whether the owner of the mailbox must be the only recipient in an incoming message in order for the condition or exception to apply.
sent_to_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: sentToAddresses
Description: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
sent_to_me
Type: BOOLEAN
Provider name: sentToMe
Description: Indicates whether the owner of the mailbox must be in the toRecipients property of an incoming message in order for the condition or exception to apply.
sent_to_or_cc_me
Type: BOOLEAN
Provider name: sentToOrCcMe
Description: Indicates whether the owner of the mailbox must be in either a toRecipients or ccRecipients property of an incoming message in order for the condition or exception to apply.
subject_contains
Type: UNORDERED_LIST_STRING
Provider name: subjectContains
Description: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.
within_size_range
Type: STRUCT
Provider name: withinSizeRange
Description: Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply.
maximum_size
Type: INT32
Provider name: maximumSize
Description: The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
minimum_size
Type: INT32
Provider name: minimumSize
Description: The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the rule.
exceptions
Type: STRUCT
Provider name: exceptions
Description: Exception conditions for the rule.
body_contains
Type: UNORDERED_LIST_STRING
Provider name: bodyContains
Description: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.
body_or_subject_contains
Type: UNORDERED_LIST_STRING
Provider name: bodyOrSubjectContains
Description: Represents the strings that should appear in the body or subject of an incoming message in order for the condition or exception to apply.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.
from_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: fromAddresses
Description: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
has_attachments
Type: BOOLEAN
Provider name: hasAttachments
Description: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.
header_contains
Type: UNORDERED_LIST_STRING
Provider name: headerContains
Description: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.
importance
Type: STRING
Provider name: importance
Description: The importance that is stamped on an incoming message in order for the condition or exception to apply: low, normal, high.
is_approval_request
Type: BOOLEAN
Provider name: isApprovalRequest
Description: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.
is_automatic_forward
Type: BOOLEAN
Provider name: isAutomaticForward
Description: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.
is_automatic_reply
Type: BOOLEAN
Provider name: isAutomaticReply
Description: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.
is_encrypted
Type: BOOLEAN
Provider name: isEncrypted
Description: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.
is_meeting_request
Type: BOOLEAN
Provider name: isMeetingRequest
Description: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.
is_meeting_response
Type: BOOLEAN
Provider name: isMeetingResponse
Description: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.
is_non_delivery_report
Type: BOOLEAN
Provider name: isNonDeliveryReport
Description: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.
is_permission_controlled
Type: BOOLEAN
Provider name: isPermissionControlled
Description: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.
is_read_receipt
Type: BOOLEAN
Provider name: isReadReceipt
Description: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.
is_signed
Type: BOOLEAN
Provider name: isSigned
Description: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.
is_voicemail
Type: BOOLEAN
Provider name: isVoicemail
Description: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.
message_action_flag
Type: STRING
Provider name: messageActionFlag
Description: Represents the flag-for-action value that appears on an incoming message in order for the condition or exception to apply. The possible values are: any, call, doNotForward, followUp, fyi, forward, noResponseNecessary, read, reply, replyToAll, review.
not_sent_to_me
Type: BOOLEAN
Provider name: notSentToMe
Description: Indicates whether the owner of the mailbox must not be a recipient of an incoming message in order for the condition or exception to apply.
recipient_contains
Type: UNORDERED_LIST_STRING
Provider name: recipientContains
Description: Represents the strings that appear in either the toRecipients or ccRecipients properties of an incoming message in order for the condition or exception to apply.
sender_contains
Type: UNORDERED_LIST_STRING
Provider name: senderContains
Description: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.
sensitivity
Type: STRING
Provider name: sensitivity
Description: Represents the sensitivity level that must be stamped on an incoming message in order for the condition or exception to apply. The possible values are: normal, personal, private, confidential.
sent_cc_me
Type: BOOLEAN
Provider name: sentCcMe
Description: Indicates whether the owner of the mailbox must be in the ccRecipients property of an incoming message in order for the condition or exception to apply.
sent_only_to_me
Type: BOOLEAN
Provider name: sentOnlyToMe
Description: Indicates whether the owner of the mailbox must be the only recipient in an incoming message in order for the condition or exception to apply.
sent_to_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: sentToAddresses
Description: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
sent_to_me
Type: BOOLEAN
Provider name: sentToMe
Description: Indicates whether the owner of the mailbox must be in the toRecipients property of an incoming message in order for the condition or exception to apply.
sent_to_or_cc_me
Type: BOOLEAN
Provider name: sentToOrCcMe
Description: Indicates whether the owner of the mailbox must be in either a toRecipients or ccRecipients property of an incoming message in order for the condition or exception to apply.
subject_contains
Type: UNORDERED_LIST_STRING
Provider name: subjectContains
Description: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.
within_size_range
Type: STRUCT
Provider name: withinSizeRange
Description: Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply.
maximum_size
Type: INT32
Provider name: maximumSize
Description: The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
minimum_size
Type: INT32
Provider name: minimumSize
Description: The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
has_error
Type: BOOLEAN
Provider name: hasError
Description: Indicates whether the rule is in an error condition. Read-only.
is_enabled
Type: BOOLEAN
Provider name: isEnabled
Description: Indicates whether the rule is enabled to be applied to messages.
is_read_only
Type: BOOLEAN
Provider name: isReadOnly
Description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
name
Type: STRING
Provider name: name
sequence
Type: INT32
Provider name: sequence
Description: Indicates the order in which the rule is executed, among other rules.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
messages
Type: UNORDERED_LIST_STRUCT
Provider name: messages
Description: The collection of messages in the mailFolder.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: The fileAttachment and itemAttachment attachments for the message.
content_type
Type: STRING
Provider name: contentType
Description: The MIME type.
is_inline
Type: BOOLEAN
Provider name: isInline
Description: true if the attachment is an inline attachment; otherwise, false.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
name
Type: STRING
Provider name: name
Description: The attachment’s file name.
size
Type: INT32
Provider name: size
Description: The length of the attachment in bytes.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
bcc_recipients
Type: UNORDERED_LIST_STRUCT
Provider name: bccRecipients
Description: The Bcc: recipients for the message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
body
Type: STRUCT
Provider name: body
Description: The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
body_preview
Type: STRING
Provider name: bodyPreview
Description: The first 255 characters of the message body. It is in text format.
cc_recipients
Type: UNORDERED_LIST_STRUCT
Provider name: ccRecipients
Description: The Cc: recipients for the message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
conversation_id
Type: STRING
Provider name: conversationId
Description: The ID of the conversation the email belongs to.
conversation_index
Type: STRING
Provider name: conversationIndex
Description: Indicates the position of the message within the conversation.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the message. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
flag
Type: STRUCT
Provider name: flag
Description: Indicates the status, start date, due date, or completion date for the message.
completed_date_time
Type: STRUCT
Provider name: completedDateTime
Description: The date and time that the follow-up was finished.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
due_date_time
Type: STRUCT
Provider name: dueDateTime
Description: The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
flag_status
Type: STRING
Provider name: flagStatus
Description: The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.
start_date_time
Type: STRUCT
Provider name: startDateTime
Description: The date and time that the follow-up is to begin.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
from
Type: STRUCT
Provider name: from
Description: The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
has_attachments
Type: BOOLEAN
Provider name: hasAttachments
Description: Indicates whether the message has attachments. This property doesn’t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as 
.
importance
Type: STRING
Provider name: importance
Description: The importance of the message. The possible values are: low, normal, and high.
inference_classification
Type: STRING
Provider name: inferenceClassification
Description: The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.
internet_message_headers
Type: UNORDERED_LIST_STRUCT
Provider name: internetMessageHeaders
Description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
name
Type: STRING
Provider name: name
Description: Represents the key in a key-value pair.
value
Type: STRING
Provider name: value
Description: The value in a key-value pair.
internet_message_id
Type: STRING
Provider name: internetMessageId
Description: The message ID in the format specified by RFC2822.
is_delivery_receipt_requested
Type: BOOLEAN
Provider name: isDeliveryReceiptRequested
Description: Indicates whether a read receipt is requested for the message.
is_draft
Type: BOOLEAN
Provider name: isDraft
Description: Indicates whether the message is a draft. A message is a draft if it hasn’t been sent yet.
is_read
Type: BOOLEAN
Provider name: isRead
Description: Indicates whether the message has been read.
is_read_receipt_requested
Type: BOOLEAN
Provider name: isReadReceiptRequested
Description: Indicates whether a read receipt is requested for the message.
multi_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: multiValueExtendedProperties
Description: The collection of multi-value extended properties defined for the message. Nullable.
name
Type: STRING
Provider name: name
value
Type: UNORDERED_LIST_STRING
Provider name: value
Description: A collection of property values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The unique identifier for the message’s parent mailFolder.
received_date_time
Type: STRING
Provider name: receivedDateTime
Description: The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
reply_to
Type: UNORDERED_LIST_STRUCT
Provider name: replyTo
Description: The email addresses to use when replying.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
sender
Type: STRUCT
Provider name: sender
Description: The account that is used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
sent_date_time
Type: STRING
Provider name: sentDateTime
Description: The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
single_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: singleValueExtendedProperties
Description: The collection of single-value extended properties defined for the message. Nullable.
name
Type: STRING
Provider name: name
value
Type: STRING
Provider name: value
Description: A property value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
subject
Type: STRING
Provider name: subject
Description: The subject of the message.
to_recipients
Type: UNORDERED_LIST_STRUCT
Provider name: toRecipients
Description: The To: recipients for the message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
unique_body
Type: STRUCT
Provider name: uniqueBody
Description: The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
web_link
Type: STRING
Provider name: webLink
Description: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: The categories associated with the item
change_key
Type: STRING
Provider name: changeKey
Description: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
multi_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: multiValueExtendedProperties
Description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: UNORDERED_LIST_STRING
Provider name: value
Description: A collection of property values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The unique identifier for the mailFolder’s parent mailFolder.
single_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: singleValueExtendedProperties
Description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
name
Type: STRING
Provider name: name
value
Type: STRING
Provider name: value
Description: A property value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
total_item_count
Type: INT32
Provider name: totalItemCount
Description: The number of items in the mailFolder.
unread_item_count
Type: INT32
Provider name: unreadItemCount
Description: The number of items in the mailFolder marked as unread.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
mail_nickname
Type: STRING
Provider name: mailNickname
Description: The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mailbox_settings
Type: STRUCT
Provider name: mailboxSettings
Description: Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select.
archive_folder
Type: STRING
Provider name: archiveFolder
Description: Folder ID of an archive folder for the user.
automatic_replies_setting
Type: STRUCT
Provider name: automaticRepliesSetting
Description: Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user.
external_audience
Type: STRING
Provider name: externalAudience
Description: The set of audience external to the signed-in user’s organization who will receive the ExternalReplyMessage, if Status is AlwaysEnabled or Scheduled. The possible values are: none, contactsOnly, all.
external_reply_message
Type: STRING
Provider name: externalReplyMessage
Description: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
internal_reply_message
Type: STRING
Provider name: internalReplyMessage
Description: The automatic reply to send to the audience internal to the signed-in user’s organization, if Status is AlwaysEnabled or Scheduled.
scheduled_end_date_time
Type: STRUCT
Provider name: scheduledEndDateTime
Description: The date and time that automatic replies are set to end, if Status is set to Scheduled.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
scheduled_start_date_time
Type: STRUCT
Provider name: scheduledStartDateTime
Description: The date and time that automatic replies are set to begin, if Status is set to Scheduled.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
status
Type: STRING
Provider name: status
Description: Configurations status for automatic replies. The possible values are: disabled, alwaysEnabled, scheduled.
date_format
Type: STRING
Provider name: dateFormat
Description: The date format for the user’s mailbox.
delegate_meeting_message_delivery_options
Type: STRING
Provider name: delegateMeetingMessageDeliveryOptions
Description: If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses. Possible values are: sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal, sendToDelegateOnly.
language
Type: STRUCT
Provider name: language
Description: The locale information for the user, including the preferred language and country/region.
display_name
Type: STRING
Provider name: displayName
Description: A name representing the user’s locale in natural language, for example, ‘English (United States)’.
locale
Type: STRING
Provider name: locale
Description: A locale representation for the user, which includes the user’s preferred language and country/region. For example, ’en-us’. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.
time_format
Type: STRING
Provider name: timeFormat
Description: The time format for the user’s mailbox.
time_zone
Type: STRING
Provider name: timeZone
Description: The default time zone for the user’s mailbox.
user_purpose
Type: STRING
Provider name: userPurpose
Description: The purpose of the mailbox. Differentiates a mailbox for a single user from a shared mailbox and equipment mailbox in Exchange Online. Possible values are: user, linked, shared, room, equipment, others, unknownFutureValue. Read-only.
working_hours
Type: STRUCT
Provider name: workingHours
Description: The days of the week and hours in a specific time zone that the user works.
days_of_week
Type: UNORDERED_LIST_STRING
Provider name: daysOfWeek
Description: The days of the week on which the user works.
end_time
Type: STRING
Provider name: endTime
Description: The time of the day that the user stops working.
start_time
Type: STRING
Provider name: startTime
Description: The time of the day that the user starts working.
time_zone
Type: STRUCT
Provider name: timeZone
Description: The time zone to which the working hours apply.
name
Type: STRING
Provider name: name
Description: The name of a time zone. It can be a standard time zone name such as ‘Hawaii-Aleutian Standard Time’, or ‘Customized Time Zone’ for a custom time zone.
managed_app_registrations
Type: UNORDERED_LIST_STRUCT
Provider name: managedAppRegistrations
Description: Zero or more managed app registrations that belong to the user.
app_identifier
Type: STRUCT
Provider name: appIdentifier
Description: The app package Identifier
application_version
Type: STRING
Provider name: applicationVersion
Description: App version
applied_policies
Type: UNORDERED_LIST_STRUCT
Provider name: appliedPolicies
Description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time the policy was created.
description
Type: STRING
Provider name: description
Description: The policy’s description.
display_name
Type: STRING
Provider name: displayName
Description: Policy display name.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Last time the policy was modified.
name
Type: STRING
Provider name: name
version
Type: STRING
Provider name: version
Description: Version of the entity.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Date and time of creation
device_name
Type: STRING
Provider name: deviceName
Description: Host device name
device_tag
Type: STRING
Provider name: deviceTag
Description: App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.
device_type
Type: STRING
Provider name: deviceType
Description: Host device type
flagged_reasons
Type: UNORDERED_LIST_STRING
Provider name: flaggedReasons
Description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
intended_policies
Type: UNORDERED_LIST_STRUCT
Provider name: intendedPolicies
Description: Zero or more policies admin intended for the app as of now.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time the policy was created.
description
Type: STRING
Provider name: description
Description: The policy’s description.
display_name
Type: STRING
Provider name: displayName
Description: Policy display name.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Last time the policy was modified.
name
Type: STRING
Provider name: name
version
Type: STRING
Provider name: version
Description: Version of the entity.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
last_sync_date_time
Type: STRING
Provider name: lastSyncDateTime
Description: Date and time of last the app synced with management service.
management_sdk_version
Type: STRING
Provider name: managementSdkVersion
Description: App management SDK version
name
Type: STRING
Provider name: name
operations
Type: UNORDERED_LIST_STRUCT
Provider name: operations
Description: Zero or more long running operations triggered on the app registration.
display_name
Type: STRING
Provider name: displayName
Description: The operation name.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The last time the app operation was modified.
name
Type: STRING
Provider name: name
state
Type: STRING
Provider name: state
Description: The current state of the operation
version
Type: STRING
Provider name: version
Description: Version of the entity.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
platform_version
Type: STRING
Provider name: platformVersion
Description: Operating System version
user_id
Type: STRING
Provider name: userId
Description: The user Id to who this app registration belongs.
version
Type: STRING
Provider name: version
Description: Version of the entity.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
manager
Type: STRUCT
Provider name: manager
Description: The user or contact that is this user’s manager. Read-only. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
member_of
Type: UNORDERED_LIST_STRUCT
Provider name: memberOf
Description: The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
messages
Type: UNORDERED_LIST_STRUCT
Provider name: messages
Description: The messages in a mailbox or folder. Read-only. Nullable.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: The fileAttachment and itemAttachment attachments for the message.
content_type
Type: STRING
Provider name: contentType
Description: The MIME type.
is_inline
Type: BOOLEAN
Provider name: isInline
Description: true if the attachment is an inline attachment; otherwise, false.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
name
Type: STRING
Provider name: name
Description: The attachment’s file name.
size
Type: INT32
Provider name: size
Description: The length of the attachment in bytes.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
bcc_recipients
Type: UNORDERED_LIST_STRUCT
Provider name: bccRecipients
Description: The Bcc: recipients for the message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
body
Type: STRUCT
Provider name: body
Description: The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
body_preview
Type: STRING
Provider name: bodyPreview
Description: The first 255 characters of the message body. It is in text format.
cc_recipients
Type: UNORDERED_LIST_STRUCT
Provider name: ccRecipients
Description: The Cc: recipients for the message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
conversation_id
Type: STRING
Provider name: conversationId
Description: The ID of the conversation the email belongs to.
conversation_index
Type: STRING
Provider name: conversationIndex
Description: Indicates the position of the message within the conversation.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the message. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
flag
Type: STRUCT
Provider name: flag
Description: Indicates the status, start date, due date, or completion date for the message.
completed_date_time
Type: STRUCT
Provider name: completedDateTime
Description: The date and time that the follow-up was finished.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
due_date_time
Type: STRUCT
Provider name: dueDateTime
Description: The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
flag_status
Type: STRING
Provider name: flagStatus
Description: The status for follow-up for an item. Possible values are notFlagged, complete, and flagged.
start_date_time
Type: STRUCT
Provider name: startDateTime
Description: The date and time that the follow-up is to begin.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
from
Type: STRUCT
Provider name: from
Description: The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
has_attachments
Type: BOOLEAN
Provider name: hasAttachments
Description: Indicates whether the message has attachments. This property doesn’t include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as .
importance
Type: STRING
Provider name: importance
Description: The importance of the message. The possible values are: low, normal, and high.
inference_classification
Type: STRING
Provider name: inferenceClassification
Description: The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.
internet_message_headers
Type: UNORDERED_LIST_STRUCT
Provider name: internetMessageHeaders
Description: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.
name
Type: STRING
Provider name: name
Description: Represents the key in a key-value pair.
value
Type: STRING
Provider name: value
Description: The value in a key-value pair.
internet_message_id
Type: STRING
Provider name: internetMessageId
Description: The message ID in the format specified by RFC2822.
is_delivery_receipt_requested
Type: BOOLEAN
Provider name: isDeliveryReceiptRequested
Description: Indicates whether a read receipt is requested for the message.
is_draft
Type: BOOLEAN
Provider name: isDraft
Description: Indicates whether the message is a draft. A message is a draft if it hasn’t been sent yet.
is_read
Type: BOOLEAN
Provider name: isRead
Description: Indicates whether the message has been read.
is_read_receipt_requested
Type: BOOLEAN
Provider name: isReadReceiptRequested
Description: Indicates whether a read receipt is requested for the message.
multi_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: multiValueExtendedProperties
Description: The collection of multi-value extended properties defined for the message. Nullable.
name
Type: STRING
Provider name: name
value
Type: UNORDERED_LIST_STRING
Provider name: value
Description: A collection of property values.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
parent_folder_id
Type: STRING
Provider name: parentFolderId
Description: The unique identifier for the message’s parent mailFolder.
received_date_time
Type: STRING
Provider name: receivedDateTime
Description: The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
reply_to
Type: UNORDERED_LIST_STRUCT
Provider name: replyTo
Description: The email addresses to use when replying.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
sender
Type: STRUCT
Provider name: sender
Description: The account that is used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
sent_date_time
Type: STRING
Provider name: sentDateTime
Description: The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
single_value_extended_properties
Type: UNORDERED_LIST_STRUCT
Provider name: singleValueExtendedProperties
Description: The collection of single-value extended properties defined for the message. Nullable.
name
Type: STRING
Provider name: name
value
Type: STRING
Provider name: value
Description: A property value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
subject
Type: STRING
Provider name: subject
Description: The subject of the message.
to_recipients
Type: UNORDERED_LIST_STRUCT
Provider name: toRecipients
Description: The To: recipients for the message.
email_address
Type: STRUCT
Provider name: emailAddress
Description: The recipient’s email address.
address
Type: STRING
Provider name: address
Description: The email address of the person or entity.
name
Type: STRING
Provider name: name
Description: The display name of the person or entity.
unique_body
Type: STRUCT
Provider name: uniqueBody
Description: The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
web_link
Type: STRING
Provider name: webLink
Description: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: The categories associated with the item
change_key
Type: STRING
Provider name: changeKey
Description: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
mobile_phone
Type: STRING
Provider name: mobilePhone
Description: The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.
my_site
Type: STRING
Provider name: mySite
Description: The URL for the user’s site. Returned only on $select.
name
Type: STRING
Provider name: name
oauth2_permission_grants
Type: UNORDERED_LIST_STRUCT
Provider name: oauth2PermissionGrants
client_id
Type: STRING
Provider name: clientId
Description: The object id (not appId) of the client service principal for the application that’s authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
consent_type
Type: STRING
Provider name: consentType
Description: Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users might be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).
name
Type: STRING
Provider name: name
principal_id
Type: STRING
Provider name: principalId
Description: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only).
resource_id
Type: STRING
Provider name: resourceId
Description: The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).
scope
Type: STRING
Provider name: scope
Description: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3,850 characters in length.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
office_location
Type: STRING
Provider name: officeLocation
Description: The office location in the user’s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
on_premises_distinguished_name
Type: STRING
Provider name: onPremisesDistinguishedName
Description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select.
on_premises_domain_name
Type: STRING
Provider name: onPremisesDomainName
Description: Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select.
on_premises_extension_attributes
Type: STRUCT
Provider name: onPremisesExtensionAttributes
Description: Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Returned only on $select. Supports $filter (eq, ne, not, in).
extension_attribute1
Type: STRING
Provider name: extensionAttribute1
Description: First customizable extension attribute.
extension_attribute10
Type: STRING
Provider name: extensionAttribute10
Description: Tenth customizable extension attribute.
extension_attribute11
Type: STRING
Provider name: extensionAttribute11
Description: Eleventh customizable extension attribute.
extension_attribute12
Type: STRING
Provider name: extensionAttribute12
Description: Twelfth customizable extension attribute.
extension_attribute13
Type: STRING
Provider name: extensionAttribute13
Description: Thirteenth customizable extension attribute.
extension_attribute14
Type: STRING
Provider name: extensionAttribute14
Description: Fourteenth customizable extension attribute.
extension_attribute15
Type: STRING
Provider name: extensionAttribute15
Description: Fifteenth customizable extension attribute.
extension_attribute2
Type: STRING
Provider name: extensionAttribute2
Description: Second customizable extension attribute.
extension_attribute3
Type: STRING
Provider name: extensionAttribute3
Description: Third customizable extension attribute.
extension_attribute4
Type: STRING
Provider name: extensionAttribute4
Description: Fourth customizable extension attribute.
extension_attribute5
Type: STRING
Provider name: extensionAttribute5
Description: Fifth customizable extension attribute.
extension_attribute6
Type: STRING
Provider name: extensionAttribute6
Description: Sixth customizable extension attribute.
extension_attribute7
Type: STRING
Provider name: extensionAttribute7
Description: Seventh customizable extension attribute.
extension_attribute8
Type: STRING
Provider name: extensionAttribute8
Description: Eighth customizable extension attribute.
extension_attribute9
Type: STRING
Provider name: extensionAttribute9
Description: Ninth customizable extension attribute.
on_premises_immutable_id
Type: STRING
Provider name: onPremisesImmutableId
Description: This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you’re using a federated domain for the user’s userPrincipalName (UPN) property. NOTE: The $ and _ characters can’t be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
on_premises_last_sync_date_time
Type: STRING
Provider name: onPremisesLastSyncDateTime
Description: Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
on_premises_provisioning_errors
Type: UNORDERED_LIST_STRUCT
Provider name: onPremisesProvisioningErrors
Description: Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le).
category
Type: STRING
Provider name: category
Description: Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.
occurred_date_time
Type: STRING
Provider name: occurredDateTime
Description: The date and time at which the error occurred.
property_causing_error
Type: STRING
Provider name: propertyCausingError
Description: Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress
value
Type: STRING
Provider name: value
Description: Value of the property causing the error.
on_premises_sam_account_name
Type: STRING
Provider name: onPremisesSamAccountName
Description: Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
on_premises_security_identifier
Type: STRING
Provider name: onPremisesSecurityIdentifier
Description: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq including on null values).
on_premises_sync_enabled
Type: BOOLEAN
Provider name: onPremisesSyncEnabled
Description: true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn’t being synced and can be managed in Microsoft Entra ID. Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
on_premises_user_principal_name
Type: STRING
Provider name: onPremisesUserPrincipalName
Description: Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
onenote
Type: STRUCT
Provider name: onenote
name
Type: STRING
Provider name: name
notebooks
Type: UNORDERED_LIST_STRUCT
Provider name: notebooks
Description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section group. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section_group
Type: STRUCT
Provider name: parentSectionGroup
Description: The section group that contains the section group. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section group. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections
Type: UNORDERED_LIST_STRUCT
Provider name: sections
Description: The sections in the notebook. Read-only. Nullable.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default section. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it’s installed. The oneNoteWebURL link opens the section in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the section in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the section in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
pages
Type: UNORDERED_LIST_STRUCT
Provider name: pages
Description: The collection of pages in the section. Read-only. Nullable.
content
Type: STRING
Provider name: content
Description: The page’s HTML content.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the page’s HTML content. Read-only.
created_by_app_id
Type: STRING
Provider name: createdByAppId
Description: The unique identifier of the application that created the page. Read-only.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
level
Type: INT32
Provider name: level
Description: The indentation level of the page. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the page. The oneNoteClientURL link opens the page in the OneNote native client if it ’s installed. The oneNoteWebUrl link opens the page in OneNote on the web. Read-only.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the page in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the page in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
order
Type: INT32
Provider name: order
Description: The order of the page within its parent section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the page. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section
Type: STRUCT
Provider name: parentSection
Description: The section that contains the page. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default section. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it’s installed. The oneNoteWebURL link opens the section in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the section in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the section in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
pages_url
Type: STRING
Provider name: pagesUrl
Description: The pages endpoint where you can get details for all the pages in the section. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
title
Type: STRING
Provider name: title
Description: The title of the page.
user_tags
Type: UNORDERED_LIST_STRING
Provider name: userTags
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
pages_url
Type: STRING
Provider name: pagesUrl
Description: The pages endpoint where you can get details for all the pages in the section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section_group
Type: STRUCT
Provider name: parentSectionGroup
Description: The section group that contains the section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section group. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
operations
Type: UNORDERED_LIST_STRUCT
Provider name: operations
Description: The status of OneNote operations. Getting an operations collection isn’t supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.
error
Type: STRUCT
Provider name: error
Description: The error returned by the operation.
code
Type: STRING
Provider name: code
Description: The error code.
message
Type: STRING
Provider name: message
Description: The error message.
name
Type: STRING
Provider name: name
percent_complete
Type: STRING
Provider name: percentComplete
Description: The operation percent complete if the operation is still in running status.
resource_id
Type: STRING
Provider name: resourceId
Description: The resource id.
resource_location
Type: STRING
Provider name: resourceLocation
Description: The resource URI for the object. For example, the resource URI for a copied page or section.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The start time of the operation.
last_action_date_time
Type: STRING
Provider name: lastActionDateTime
Description: The time of the last action of the operation.
status
Type: STRING
Provider name: status
Description: The current status of the operation: notStarted, running, completed, failed
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
pages
Type: UNORDERED_LIST_STRUCT
Provider name: pages
Description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
content
Type: STRING
Provider name: content
Description: The page’s HTML content.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the page’s HTML content. Read-only.
created_by_app_id
Type: STRING
Provider name: createdByAppId
Description: The unique identifier of the application that created the page. Read-only.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
level
Type: INT32
Provider name: level
Description: The indentation level of the page. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the page. The oneNoteClientURL link opens the page in the OneNote native client if it ’s installed. The oneNoteWebUrl link opens the page in OneNote on the web. Read-only.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the page in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the page in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
order
Type: INT32
Provider name: order
Description: The order of the page within its parent section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the page. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections
Type: UNORDERED_LIST_STRUCT
Provider name: sections
Description: The sections in the notebook. Read-only. Nullable.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default section. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it’s installed. The oneNoteWebURL link opens the section in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the section in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the section in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
pages_url
Type: STRING
Provider name: pagesUrl
Description: The pages endpoint where you can get details for all the pages in the section. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section
Type: STRUCT
Provider name: parentSection
Description: The section that contains the page. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default section. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it’s installed. The oneNoteWebURL link opens the section in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the section in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the section in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
pages_url
Type: STRING
Provider name: pagesUrl
Description: The pages endpoint where you can get details for all the pages in the section. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
title
Type: STRING
Provider name: title
Description: The title of the page.
user_tags
Type: UNORDERED_LIST_STRING
Provider name: userTags
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
resources
Type: UNORDERED_LIST_STRUCT
Provider name: resources
Description: The image and other file resources in OneNote pages. Getting a resources collection isn’t supported, but you can get the binary content of a specific resource. Read-only. Nullable.
content
Type: STRING
Provider name: content
Description: The content stream
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for downloading the content
name
Type: STRING
Provider name: name
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section group. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section_group
Type: STRUCT
Provider name: parentSectionGroup
Description: The section group that contains the section group. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section group. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
sections
Type: UNORDERED_LIST_STRUCT
Provider name: sections
Description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default section. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it’s installed. The oneNoteWebURL link opens the section in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the section in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the section in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
pages
Type: UNORDERED_LIST_STRUCT
Provider name: pages
Description: The collection of pages in the section. Read-only. Nullable.
content
Type: STRING
Provider name: content
Description: The page’s HTML content.
content_url
Type: STRING
Provider name: contentUrl
Description: The URL for the page’s HTML content. Read-only.
created_by_app_id
Type: STRING
Provider name: createdByAppId
Description: The unique identifier of the application that created the page. Read-only.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
level
Type: INT32
Provider name: level
Description: The indentation level of the page. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the page. The oneNoteClientURL link opens the page in the OneNote native client if it ’s installed. The oneNoteWebUrl link opens the page in OneNote on the web. Read-only.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the page in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the page in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
name
Type: STRING
Provider name: name
order
Type: INT32
Provider name: order
Description: The order of the page within its parent section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the page. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section
Type: STRUCT
Provider name: parentSection
Description: The section that contains the page. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default section. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the section. The oneNoteClientURL link opens the section in the OneNote native client if it’s installed. The oneNoteWebURL link opens the section in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the section in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the section in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
pages_url
Type: STRING
Provider name: pagesUrl
Description: The pages endpoint where you can get details for all the pages in the section. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
title
Type: STRING
Provider name: title
Description: The title of the page.
user_tags
Type: UNORDERED_LIST_STRING
Provider name: userTags
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
pages_url
Type: STRING
Provider name: pagesUrl
Description: The pages endpoint where you can get details for all the pages in the section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
parent_section_group
Type: STRUCT
Provider name: parentSectionGroup
Description: The section group that contains the section. Read-only.
parent_notebook
Type: STRUCT
Provider name: parentNotebook
Description: The notebook that contains the section group. Read-only.
is_default
Type: BOOLEAN
Provider name: isDefault
Description: Indicates whether this is the user’s default notebook. Read-only.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
links
Type: STRUCT
Provider name: links
Description: Links for opening the notebook. The oneNoteClientURL link opens the notebook in the OneNote native client if it’s installed. The oneNoteWebURL link opens the notebook in OneNote on the web.
one_note_client_url
Type: STRUCT
Provider name: oneNoteClientUrl
Description: Opens the notebook in the OneNote native client if it’s installed.
href
Type: STRING
Provider name: href
Description: The URL of the link.
one_note_web_url
Type: STRUCT
Provider name: oneNoteWebUrl
Description: Opens the notebook in OneNote on the web.
href
Type: STRING
Provider name: href
Description: The URL of the link.
section_groups
Type: UNORDERED_LIST_STRUCT
Provider name: sectionGroups
Description: The section groups in the notebook. Read-only. Nullable.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.
user_role
Type: STRING
Provider name: userRole
Description: Possible values are: Owner, Contributor, Reader, None. Owner represents owner-level access to the notebook. Contributor represents read/write access to the notebook. Reader represents read-only access to the notebook. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
section_groups_url
Type: STRING
Provider name: sectionGroupsUrl
Description: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.
sections_url
Type: STRING
Provider name: sectionsUrl
Description: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
name
Type: STRING
Provider name: name
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
display_name
Type: STRING
Provider name: displayName
Description: The name of the notebook.
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the user, device, and application that created the item. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
self
Type: STRING
Provider name: self
Description: The endpoint where you can get details about the page. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
online_meetings
Type: UNORDERED_LIST_STRUCT
Provider name: onlineMeetings
Description: Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
attendee_report
Type: STRING
Provider name: attendeeReport
Description: The content stream of the attendee report of a Microsoft Teams live event. Read-only.
broadcast_settings
Type: STRUCT
Provider name: broadcastSettings
Description: Settings related to a live event.
allowed_audience
Type: STRING
Provider name: allowedAudience
Description: Defines who can join the Teams live event. Possible values are listed in the following table.
captions
Type: STRUCT
Provider name: captions
Description: Caption settings of a Teams live event.
is_caption_enabled
Type: BOOLEAN
Provider name: isCaptionEnabled
Description: Indicates whether captions are enabled for this Teams live event.
spoken_language
Type: STRING
Provider name: spokenLanguage
Description: The spoken language.
translation_languages
Type: UNORDERED_LIST_STRING
Provider name: translationLanguages
Description: The translation languages (choose up to 6).
is_attendee_report_enabled
Type: BOOLEAN
Provider name: isAttendeeReportEnabled
Description: Indicates whether attendee report is enabled for this Teams live event. Default value is false.
is_question_and_answer_enabled
Type: BOOLEAN
Provider name: isQuestionAndAnswerEnabled
Description: Indicates whether Q&A is enabled for this Teams live event. Default value is false.
is_recording_enabled
Type: BOOLEAN
Provider name: isRecordingEnabled
Description: Indicates whether recording is enabled for this Teams live event. Default value is false.
is_video_on_demand_enabled
Type: BOOLEAN
Provider name: isVideoOnDemandEnabled
Description: Indicates whether video on demand is enabled for this Teams live event. Default value is false.
creation_date_time
Type: STRING
Provider name: creationDateTime
Description: The meeting creation time in UTC. Read-only.
end_date_time
Type: STRING
Provider name: endDateTime
Description: The meeting end time in UTC. Required when you create an online meeting.
external_id
Type: STRING
Provider name: externalId
is_broadcast
Type: BOOLEAN
Provider name: isBroadcast
Description: Indicates whether this meeting is a Teams live event.
meeting_template_id
Type: STRING
Provider name: meetingTemplateId
Description: The ID of the meeting template.
name
Type: STRING
Provider name: name
participants
Type: STRUCT
Provider name: participants
Description: The participants associated with the online meeting, including the organizer and the attendees.
attendees
Type: UNORDERED_LIST_STRUCT
Provider name: attendees
Description: Information about the meeting attendees.
identity
Type: STRUCT
Provider name: identity
Description: Identity information of the participant.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
role
Type: STRING
Provider name: role
Description: Specifies the participant’s role in the meeting.
upn
Type: STRING
Provider name: upn
Description: User principal name of the participant.
organizer
Type: STRUCT
Provider name: organizer
Description: Information about the meeting organizer.
identity
Type: STRUCT
Provider name: identity
Description: Identity information of the participant.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
role
Type: STRING
Provider name: role
Description: Specifies the participant’s role in the meeting.
upn
Type: STRING
Provider name: upn
Description: User principal name of the participant.
recordings
Type: UNORDERED_LIST_STRUCT
Provider name: recordings
Description: The recordings of an online meeting. Read-only.
call_id
Type: STRING
Provider name: callId
Description: The unique identifier for the call that is related to this recording. Read-only.
content
Type: STRING
Provider name: content
Description: The content of the recording. Read-only.
content_correlation_id
Type: STRING
Provider name: contentCorrelationId
Description: The unique identifier that links the transcript with its corresponding recording. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Date and time at which the recording was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
end_date_time
Type: STRING
Provider name: endDateTime
Description: Date and time at which the recording ends. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
meeting_id
Type: STRING
Provider name: meetingId
Description: The unique identifier of the onlineMeeting related to this recording. Read-only.
meeting_organizer
Type: STRUCT
Provider name: meetingOrganizer
Description: The identity information of the organizer of the onlineMeeting related to this recording. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
name
Type: STRING
Provider name: name
recording_content_url
Type: STRING
Provider name: recordingContentUrl
Description: The URL that can be used to access the content of the recording. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
start_date_time
Type: STRING
Provider name: startDateTime
Description: The meeting start time in UTC.
transcripts
Type: UNORDERED_LIST_STRUCT
Provider name: transcripts
Description: The transcripts of an online meeting. Read-only.
call_id
Type: STRING
Provider name: callId
Description: The unique identifier for the call that is related to this transcript. Read-only.
content
Type: STRING
Provider name: content
Description: The content of the transcript. Read-only.
content_correlation_id
Type: STRING
Provider name: contentCorrelationId
Description: The unique identifier that links the transcript with its corresponding recording. Read-only.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Date and time at which the transcript was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
end_date_time
Type: STRING
Provider name: endDateTime
Description: Date and time at which the transcription ends. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
meeting_id
Type: STRING
Provider name: meetingId
Description: The unique identifier of the online meeting related to this transcript. Read-only.
meeting_organizer
Type: STRUCT
Provider name: meetingOrganizer
Description: The identity information of the organizer of the onlineMeeting related to this transcript. Read-only.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
metadata_content
Type: STRING
Provider name: metadataContent
Description: The time-aligned metadata of the utterances in the transcript. Read-only.
name
Type: STRING
Provider name: name
transcript_content_url
Type: STRING
Provider name: transcriptContentUrl
Description: The URL that can be used to access the content of the transcript. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
allow_attendee_to_enable_camera
Type: BOOLEAN
Provider name: allowAttendeeToEnableCamera
Description: Indicates whether attendees can turn on their camera.
allow_attendee_to_enable_mic
Type: BOOLEAN
Provider name: allowAttendeeToEnableMic
Description: Indicates whether attendees can turn on their microphone.
allow_breakout_rooms
Type: BOOLEAN
Provider name: allowBreakoutRooms
Description: Indicates whether breakout rooms are enabled for the meeting.
allow_live_share
Type: STRING
Provider name: allowLiveShare
Description: Indicates whether live share is enabled for the meeting. Possible values are: enabled, disabled, unknownFutureValue.
allow_meeting_chat
Type: STRING
Provider name: allowMeetingChat
Description: Specifies the mode of the meeting chat.
allow_participants_to_change_name
Type: BOOLEAN
Provider name: allowParticipantsToChangeName
Description: Specifies if participants are allowed to rename themselves in an instance of the meeting.
allow_power_point_sharing
Type: BOOLEAN
Provider name: allowPowerPointSharing
Description: Indicates whether PowerPoint live is enabled for the meeting.
allow_recording
Type: BOOLEAN
Provider name: allowRecording
Description: Indicates whether recording is enabled for the meeting.
allow_teamwork_reactions
Type: BOOLEAN
Provider name: allowTeamworkReactions
Description: Indicates if Teams reactions are enabled for the meeting.
allow_transcription
Type: BOOLEAN
Provider name: allowTranscription
Description: Indicates whether transcription is enabled for the meeting.
allow_whiteboard
Type: BOOLEAN
Provider name: allowWhiteboard
Description: Indicates whether whiteboard is enabled for the meeting.
allowed_lobby_admitters
Type: STRING
Provider name: allowedLobbyAdmitters
Description: Specifies the users who can admit from the lobby. Possible values are: organizerAndCoOrganizersAndPresenters, organizerAndCoOrganizers, unknownFutureValue.
allowed_presenters
Type: STRING
Provider name: allowedPresenters
Description: Specifies who can be a presenter in a meeting.
attendance_reports
Type: UNORDERED_LIST_STRUCT
Provider name: attendanceReports
Description: The attendance reports of an online meeting. Read-only.
attendance_records
Type: UNORDERED_LIST_STRUCT
Provider name: attendanceRecords
Description: List of attendance records of an attendance report. Read-only.
attendance_intervals
Type: UNORDERED_LIST_STRUCT
Provider name: attendanceIntervals
Description: List of time periods between joining and leaving a meeting.
duration_in_seconds
Type: INT32
Provider name: durationInSeconds
Description: Duration of the meeting interval in seconds; that is, the difference between joinDateTime and leaveDateTime.
join_date_time
Type: STRING
Provider name: joinDateTime
Description: The time the attendee joined in UTC.
leave_date_time
Type: STRING
Provider name: leaveDateTime
Description: The time the attendee left in UTC.
email_address
Type: STRING
Provider name: emailAddress
Description: Email address of the user associated with this attendance record.
external_registration_information
Type: STRUCT
Provider name: externalRegistrationInformation
Description: The external information for a virtualEventRegistration.
referrer
Type: STRING
Provider name: referrer
Description: A URL or string that represents the location from which the registrant registered. Optional.
registration_id
Type: STRING
Provider name: registrationId
Description: The identifier for a virtualEventExternalRegistrationInformation object. Optional. If set, the maximum supported length is 256 characters.
identity
Type: STRUCT
Provider name: identity
Description: 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.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
name
Type: STRING
Provider name: name
registration_id
Type: STRING
Provider name: registrationId
Description: Unique identifier of a virtualEventRegistration that is available to all participants registered for the virtualEventWebinar.
role
Type: STRING
Provider name: role
Description: Role of the attendee. Possible values are: None, Attendee, Presenter, and Organizer.
total_attendance_in_seconds
Type: INT32
Provider name: totalAttendanceInSeconds
Description: Total duration of the attendances in seconds.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
external_event_information
Type: UNORDERED_LIST_STRUCT
Provider name: externalEventInformation
Description: The external information of a virtual event. Returned only for event organizers or coorganizers. Read-only.
application_id
Type: STRING
Provider name: applicationId
Description: Identifier of the application that hosts the externalEventId. Read-only.
external_event_id
Type: STRING
Provider name: externalEventId
Description: The identifier for a virtualEventExternalInformation object that associates the virtual event with an event ID in an external application. This association bundles all the information (both supported and not supported in virtualEvent) into one virtual event object. Optional. If set, the maximum supported length is 256 characters.
meeting_end_date_time
Type: STRING
Provider name: meetingEndDateTime
Description: UTC time when the meeting ended. Read-only.
meeting_start_date_time
Type: STRING
Provider name: meetingStartDateTime
Description: UTC time when the meeting started. Read-only.
name
Type: STRING
Provider name: name
total_participant_count
Type: INT32
Provider name: totalParticipantCount
Description: Total number of participants. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
audio_conferencing
Type: STRUCT
Provider name: audioConferencing
Description: The phone access (dial-in) information for an online meeting. Read-only.
conference_id
Type: STRING
Provider name: conferenceId
Description: The conference id of the online meeting.
dialin_url
Type: STRING
Provider name: dialinUrl
Description: A URL to the externally-accessible web page that contains dial-in information.
toll_free_number
Type: STRING
Provider name: tollFreeNumber
Description: The toll-free number that connects to the Audio Conference Provider.
toll_free_numbers
Type: UNORDERED_LIST_STRING
Provider name: tollFreeNumbers
Description: List of toll-free numbers that are displayed in the meeting invite.
toll_number
Type: STRING
Provider name: tollNumber
Description: The toll number that connects to the Audio Conference Provider.
toll_numbers
Type: UNORDERED_LIST_STRING
Provider name: tollNumbers
Description: List of toll numbers that are displayed in the meeting invite.
chat_info
Type: STRUCT
Provider name: chatInfo
Description: The chat information associated with this online meeting.
message_id
Type: STRING
Provider name: messageId
Description: The unique identifier of a message in a Microsoft Teams channel.
reply_chain_message_id
Type: STRING
Provider name: replyChainMessageId
Description: The ID of the reply message.
thread_id
Type: STRING
Provider name: threadId
Description: The unique identifier for a thread in Microsoft Teams.
chat_restrictions
Type: STRUCT
Provider name: chatRestrictions
Description: Specifies the configuration settings for meeting chat restrictions.
allow_text_only
Type: BOOLEAN
Provider name: allowTextOnly
Description: Indicates whether only text is allowed in the meeting chat. Optional.
is_entry_exit_announced
Type: BOOLEAN
Provider name: isEntryExitAnnounced
Description: Indicates whether to announce when callers join or leave.
join_information
Type: STRUCT
Provider name: joinInformation
Description: The join information in the language and locale variant specified in ‘Accept-Language’ request HTTP header. Read-only.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
join_meeting_id_settings
Type: STRUCT
Provider name: joinMeetingIdSettings
Description: 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, you must cancel this meeting and create a new one.
is_passcode_required
Type: BOOLEAN
Provider name: isPasscodeRequired
Description: Indicates whether a passcode is required to join a meeting when using joinMeetingId. Optional.
join_meeting_id
Type: STRING
Provider name: joinMeetingId
Description: The meeting ID to be used to join a meeting. Optional. Read-only.
passcode
Type: STRING
Provider name: passcode
Description: The passcode to join a meeting. Optional. Read-only.
join_web_url
Type: STRING
Provider name: joinWebUrl
Description: The join URL of the online meeting. Read-only.
lobby_bypass_settings
Type: STRUCT
Provider name: lobbyBypassSettings
Description: Specifies which participants can bypass the meeting lobby.
is_dial_in_bypass_enabled
Type: BOOLEAN
Provider name: isDialInBypassEnabled
Description: Specifies whether or not to always let dial-in callers bypass the lobby. Optional.
scope
Type: STRING
Provider name: scope
Description: Specifies the type of participants that are automatically admitted into a meeting, bypassing the lobby. Optional.
record_automatically
Type: BOOLEAN
Provider name: recordAutomatically
Description: Indicates whether to record the meeting automatically.
share_meeting_chat_history_default
Type: STRING
Provider name: shareMeetingChatHistoryDefault
Description: Specifies whether meeting chat history is shared with participants. Possible values are: all, none, unknownFutureValue.
subject
Type: STRING
Provider name: subject
Description: The subject of the online meeting.
video_teleconference_id
Type: STRING
Provider name: videoTeleconferenceId
Description: The video teleconferencing ID. Read-only.
watermark_protection
Type: STRUCT
Provider name: watermarkProtection
Description: Specifies whether the client application should apply a watermark to a content type.
is_enabled_for_content_sharing
Type: BOOLEAN
Provider name: isEnabledForContentSharing
Description: Indicates whether to apply a watermark to any shared content.
is_enabled_for_video
Type: BOOLEAN
Provider name: isEnabledForVideo
Description: Indicates whether to apply a watermark to everyone’s video feed.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
other_mails
Type: UNORDERED_LIST_STRING
Provider name: otherMails
Description: A list of other email addresses for the user; for example: [‘bob@contoso.com’, ‘Robert@fabrikam.com’]. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can’t contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
outlook
Type: STRUCT
Provider name: outlook
master_categories
Type: UNORDERED_LIST_STRUCT
Provider name: masterCategories
Description: A list of categories defined for the user.
color
Type: STRING
Provider name: color
Description: A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. For more details, see the following note.
display_name
Type: STRING
Provider name: displayName
Description: A unique name that identifies a category in the user’s mailbox. After a category is created, the name cannot be changed. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
owned_devices
Type: UNORDERED_LIST_STRUCT
Provider name: ownedDevices
Description: Devices the user owns. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
owned_objects
Type: UNORDERED_LIST_STRUCT
Provider name: ownedObjects
Description: Directory objects the user owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
password_policies
Type: STRING
Provider name: passwordPolicies
Description: Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values).
password_profile
Type: STRUCT
Provider name: passwordProfile
Description: Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). To update this property: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that’s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.
force_change_password_next_sign_in
Type: BOOLEAN
Provider name: forceChangePasswordNextSignIn
Description: true if the user must change their password on the next sign-in; otherwise false.
force_change_password_next_sign_in_with_mfa
Type: BOOLEAN
Provider name: forceChangePasswordNextSignInWithMfa
Description: If true, at next sign-in, the user must perform a multifactor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multifactor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.
password
Type: STRING
Provider name: password
Description: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next sign-in. The password must satisfy minimum requirements as specified by the user’s passwordPolicies property. By default, a strong password is required.
past_projects
Type: UNORDERED_LIST_STRING
Provider name: pastProjects
Description: A list for the user to enumerate their past projects. Returned only on $select.
people
Type: UNORDERED_LIST_STRUCT
Provider name: people
Description: People that are relevant to the user. Read-only. Nullable.
birthday
Type: STRING
Provider name: birthday
Description: The person’s birthday.
company_name
Type: STRING
Provider name: companyName
Description: The name of the person’s company.
department
Type: STRING
Provider name: department
Description: The person’s department.
display_name
Type: STRING
Provider name: displayName
Description: The person’s display name.
given_name
Type: STRING
Provider name: givenName
Description: The person’s given name.
im_address
Type: STRING
Provider name: imAddress
Description: The instant message voice over IP (VOIP) session initiation protocol (SIP) address for the user. Read-only.
is_favorite
Type: BOOLEAN
Provider name: isFavorite
Description: True if the user has flagged this person as a favorite.
job_title
Type: STRING
Provider name: jobTitle
Description: The person’s job title.
name
Type: STRING
Provider name: name
office_location
Type: STRING
Provider name: officeLocation
Description: The location of the person’s office.
person_notes
Type: STRING
Provider name: personNotes
Description: Free-form notes that the user has taken about this person.
person_type
Type: STRUCT
Provider name: personType
Description: The type of person.
class
Type: STRING
Provider name: class
Description: The type of data source, such as Person.
subclass
Type: STRING
Provider name: subclass
Description: The secondary type of data source, such as OrganizationUser.
phones
Type: UNORDERED_LIST_STRUCT
Provider name: phones
Description: The person’s phone numbers.
language
Type: STRING
Provider name: language
number
Type: STRING
Provider name: number
Description: The phone number.
region
Type: STRING
Provider name: region
type
Type: STRING
Provider name: type
Description: The type of phone number. The possible values are: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio.
postal_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: postalAddresses
Description: The person’s addresses.
address
Type: STRUCT
Provider name: address
Description: The street address of the location.
city
Type: STRING
Provider name: city
Description: The city.
country_or_region
Type: STRING
Provider name: countryOrRegion
Description: The country or region. It’s a free-format string value, for example, ‘United States’.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code.
state
Type: STRING
Provider name: state
Description: The state.
street
Type: STRING
Provider name: street
Description: The street.
coordinates
Type: STRUCT
Provider name: coordinates
Description: The geographic coordinates and elevation of the location.
display_name
Type: STRING
Provider name: displayName
Description: The name associated with the location.
location_email_address
Type: STRING
Provider name: locationEmailAddress
Description: Optional email address of the location.
location_type
Type: STRING
Provider name: locationType
Description: The type of location. The possible values are: default, conferenceRoom, homeAddress, businessAddress,geoCoordinates, streetAddress, hotel, restaurant, localBusiness, postalAddress. Read-only.
location_uri
Type: STRING
Provider name: locationUri
Description: Optional URI representing the location.
unique_id
Type: STRING
Provider name: uniqueId
Description: For internal use only.
unique_id_type
Type: STRING
Provider name: uniqueIdType
Description: For internal use only.
profession
Type: STRING
Provider name: profession
Description: The person’s profession.
scored_email_addresses
Type: UNORDERED_LIST_STRUCT
Provider name: scoredEmailAddresses
Description: The person’s email addresses.
address
Type: STRING
Provider name: address
Description: The email address.
item_id
Type: STRING
Provider name: itemId
selection_likelihood
Type: STRING
Provider name: selectionLikelihood
surname
Type: STRING
Provider name: surname
Description: The person’s surname.
user_principal_name
Type: STRING
Provider name: userPrincipalName
Description: The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person’s email name. The general format is alias@domain.
websites
Type: UNORDERED_LIST_STRUCT
Provider name: websites
Description: The person’s websites.
address
Type: STRING
Provider name: address
Description: The URL of the website.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the web site.
type
Type: STRING
Provider name: type
Description: The possible values are: other, home, work, blog, profile.
yomi_company
Type: STRING
Provider name: yomiCompany
Description: The phonetic Japanese name of the person’s company.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
permission_grants
Type: UNORDERED_LIST_STRUCT
Provider name: permissionGrants
Description: List all resource-specific permission grants of a user.
client_app_id
Type: STRING
Provider name: clientAppId
Description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
client_id
Type: STRING
Provider name: clientId
Description: ID of the Microsoft Entra app that has been granted access. Read-only.
name
Type: STRING
Provider name: name
permission
Type: STRING
Provider name: permission
Description: The name of the resource-specific permission. Read-only.
permission_type
Type: STRING
Provider name: permissionType
Description: The type of permission. Possible values are: Application, Delegated. Read-only.
resource_app_id
Type: STRING
Provider name: resourceAppId
Description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
photo
Type: STRUCT
Provider name: photo
Description: The user’s profile photo. Read-only.
height
Type: INT32
Provider name: height
Description: The height of the photo. Read-only.
name
Type: STRING
Provider name: name
width
Type: INT32
Provider name: width
Description: The width of the photo. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
photos
Type: UNORDERED_LIST_STRUCT
Provider name: photos
Description: The collection of the user’s profile photos in different sizes. Read-only.
height
Type: INT32
Provider name: height
Description: The height of the photo. Read-only.
name
Type: STRING
Provider name: name
width
Type: INT32
Provider name: width
Description: The width of the photo. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
planner
Type: STRUCT
Provider name: planner
Description: Entry-point to the Planner resource that might exist for a user. Read-only.
name
Type: STRING
Provider name: name
plans
Type: UNORDERED_LIST_STRUCT
Provider name: plans
Description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
buckets
Type: UNORDERED_LIST_STRUCT
Provider name: buckets
Description: Read-only. Nullable. Collection of buckets in the plan.
name
Type: STRING
Provider name: name
Description: Name of the bucket.
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
plan_id
Type: STRING
Provider name: planId
Description: Plan ID to which the bucket belongs.
tasks
Type: UNORDERED_LIST_STRUCT
Provider name: tasks
Description: Read-only. Nullable. The collection of tasks in the bucket.
active_checklist_item_count
Type: INT32
Provider name: activeChecklistItemCount
Description: Number of checklist items with value set to false, representing incomplete items.
applied_categories
Type: STRUCT
Provider name: appliedCategories
Description: The categories to which the task has been applied. See applied Categories for possible values.
assigned_to_task_board_format
Type: STRUCT
Provider name: assignedToTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.
name
Type: STRING
Provider name: name
order_hints_by_assignee
Type: STRUCT
Provider name: orderHintsByAssignee
Description: Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here.
unassigned_order_hint
Type: STRING
Provider name: unassignedOrderHint
Description: Hint value used to order the task on the AssignedTo view of the Task Board when the task isn’t assigned to anyone, or if the orderHintsByAssignee dictionary doesn’t provide an order hint for the user the task is assigned to. The format is defined as outlined here.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
assignee_priority
Type: STRING
Provider name: assigneePriority
Description: Hint used to order items of this type in a list view. The format is defined as outlined here.
assignments
Type: STRUCT
Provider name: assignments
Description: The set of assignees the task is assigned to.
bucket_id
Type: STRING
Provider name: bucketId
Description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It’s 28 characters long and case-sensitive. Format validation is done on the service.
bucket_task_board_format
Type: STRUCT
Provider name: bucketTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
checklist_item_count
Type: INT32
Provider name: checklistItemCount
Description: Number of checklist items that are present on the task.
completed_by
Type: STRUCT
Provider name: completedBy
Description: Identity of the user that completed the task.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
completed_date_time
Type: STRING
Provider name: completedDateTime
Description: Read-only. Date and time at which the ‘percentComplete’ of the task is set to ‘100’. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
conversation_thread_id
Type: STRING
Provider name: conversationThreadId
Description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user that created the task.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
details
Type: STRUCT
Provider name: details
Description: Read-only. Nullable. More details about the task.
checklist
Type: STRUCT
Provider name: checklist
Description: The collection of checklist items on the task.
description
Type: STRING
Provider name: description
Description: Description of the task.
name
Type: STRING
Provider name: name
preview_type
Type: STRING
Provider name: previewType
Description: This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference. When set to automatic the displayed preview is chosen by the app viewing the task.
references
Type: STRUCT
Provider name: references
Description: The collection of references on the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
due_date_time
Type: STRING
Provider name: dueDateTime
Description: Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
has_description
Type: BOOLEAN
Provider name: hasDescription
Description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order items of this type in a list view. The format is defined as outlined here.
percent_complete
Type: INT32
Provider name: percentComplete
Description: Percentage of task completion. When set to 100, the task is considered completed.
plan_id
Type: STRING
Provider name: planId
Description: Plan ID to which the task belongs.
preview_type
Type: STRING
Provider name: previewType
Description: This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference.
priority
Type: INT32
Provider name: priority
Description: Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ‘urgent’, 2, 3 and 4 as ‘important’, 5, 6, and 7 as ‘medium’, and 8, 9, and 10 as ’low’. Additionally, Planner sets the value 1 for ‘urgent’, 3 for ‘important’, 5 for ‘medium’, and 9 for ’low’.
progress_task_board_format
Type: STRUCT
Provider name: progressTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
reference_count
Type: INT32
Provider name: referenceCount
Description: Number of external references that exist on the task.
start_date_time
Type: STRING
Provider name: startDateTime
Description: Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
title
Type: STRING
Provider name: title
Description: Title of the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
container
Type: STRUCT
Provider name: container
Description: Identifies the container of the plan. Specify only the url, the containerId and type, or all properties. After it’s set, this property can’t be updated. Required.
container_id
Type: STRING
Provider name: containerId
Description: The identifier of the resource that contains the plan. Optional.
type
Type: STRING
Provider name: type
Description: The type of the resource that contains the plan. For supported types, see the previous table. Possible values are: group, unknownFutureValue, roster. Use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: roster. Optional.
url
Type: STRING
Provider name: url
Description: The full canonical URL of the container. Optional.
created_by
Type: STRUCT
Provider name: createdBy
Description: Read-only. The user who created the plan.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
details
Type: STRUCT
Provider name: details
Description: Read-only. Nullable. Extra details about the plan.
category_descriptions
Type: STRUCT
Provider name: categoryDescriptions
Description: An object that specifies the descriptions of the 25 categories that can be associated with tasks in the plan.
category1
Type: STRING
Provider name: category1
Description: The label associated with Category 1
category10
Type: STRING
Provider name: category10
Description: The label associated with Category 10
category11
Type: STRING
Provider name: category11
Description: The label associated with Category 11
category12
Type: STRING
Provider name: category12
Description: The label associated with Category 12
category13
Type: STRING
Provider name: category13
Description: The label associated with Category 13
category14
Type: STRING
Provider name: category14
Description: The label associated with Category 14
category15
Type: STRING
Provider name: category15
Description: The label associated with Category 15
category16
Type: STRING
Provider name: category16
Description: The label associated with Category 16
category17
Type: STRING
Provider name: category17
Description: The label associated with Category 17
category18
Type: STRING
Provider name: category18
Description: The label associated with Category 18
category19
Type: STRING
Provider name: category19
Description: The label associated with Category 19
category2
Type: STRING
Provider name: category2
Description: The label associated with Category 2
category20
Type: STRING
Provider name: category20
Description: The label associated with Category 20
category21
Type: STRING
Provider name: category21
Description: The label associated with Category 21
category22
Type: STRING
Provider name: category22
Description: The label associated with Category 22
category23
Type: STRING
Provider name: category23
Description: The label associated with Category 23
category24
Type: STRING
Provider name: category24
Description: The label associated with Category 24
category25
Type: STRING
Provider name: category25
Description: The label associated with Category 25
category3
Type: STRING
Provider name: category3
Description: The label associated with Category 3
category4
Type: STRING
Provider name: category4
Description: The label associated with Category 4
category5
Type: STRING
Provider name: category5
Description: The label associated with Category 5
category6
Type: STRING
Provider name: category6
Description: The label associated with Category 6
category7
Type: STRING
Provider name: category7
Description: The label associated with Category 7
category8
Type: STRING
Provider name: category8
Description: The label associated with Category 8
category9
Type: STRING
Provider name: category9
Description: The label associated with Category 9
name
Type: STRING
Provider name: name
shared_with
Type: STRUCT
Provider name: sharedWith
Description: Set of user IDs that this plan is shared with. If you’re using Microsoft 365 groups, use the Groups API to manage group membership to share the group’s plan. You can also add existing members of the group to this collection, although it isn’t required for them to access the plan owned by the group.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
owner
Type: STRING
Provider name: owner
Description: Use the container property instead. ID of the group that owns the plan. After it’s set, this property can’t be updated. This property won’t return a valid group ID if the container of the plan isn’t a group.
tasks
Type: UNORDERED_LIST_STRUCT
Provider name: tasks
Description: Read-only. Nullable. Collection of tasks in the plan.
active_checklist_item_count
Type: INT32
Provider name: activeChecklistItemCount
Description: Number of checklist items with value set to false, representing incomplete items.
applied_categories
Type: STRUCT
Provider name: appliedCategories
Description: The categories to which the task has been applied. See applied Categories for possible values.
assigned_to_task_board_format
Type: STRUCT
Provider name: assignedToTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.
name
Type: STRING
Provider name: name
order_hints_by_assignee
Type: STRUCT
Provider name: orderHintsByAssignee
Description: Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here.
unassigned_order_hint
Type: STRING
Provider name: unassignedOrderHint
Description: Hint value used to order the task on the AssignedTo view of the Task Board when the task isn’t assigned to anyone, or if the orderHintsByAssignee dictionary doesn’t provide an order hint for the user the task is assigned to. The format is defined as outlined here.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
assignee_priority
Type: STRING
Provider name: assigneePriority
Description: Hint used to order items of this type in a list view. The format is defined as outlined here.
assignments
Type: STRUCT
Provider name: assignments
Description: The set of assignees the task is assigned to.
bucket_id
Type: STRING
Provider name: bucketId
Description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It’s 28 characters long and case-sensitive. Format validation is done on the service.
bucket_task_board_format
Type: STRUCT
Provider name: bucketTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
checklist_item_count
Type: INT32
Provider name: checklistItemCount
Description: Number of checklist items that are present on the task.
completed_by
Type: STRUCT
Provider name: completedBy
Description: Identity of the user that completed the task.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
completed_date_time
Type: STRING
Provider name: completedDateTime
Description: Read-only. Date and time at which the ‘percentComplete’ of the task is set to ‘100’. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
conversation_thread_id
Type: STRING
Provider name: conversationThreadId
Description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user that created the task.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
details
Type: STRUCT
Provider name: details
Description: Read-only. Nullable. More details about the task.
checklist
Type: STRUCT
Provider name: checklist
Description: The collection of checklist items on the task.
description
Type: STRING
Provider name: description
Description: Description of the task.
name
Type: STRING
Provider name: name
preview_type
Type: STRING
Provider name: previewType
Description: This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference. When set to automatic the displayed preview is chosen by the app viewing the task.
references
Type: STRUCT
Provider name: references
Description: The collection of references on the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
due_date_time
Type: STRING
Provider name: dueDateTime
Description: Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
has_description
Type: BOOLEAN
Provider name: hasDescription
Description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order items of this type in a list view. The format is defined as outlined here.
percent_complete
Type: INT32
Provider name: percentComplete
Description: Percentage of task completion. When set to 100, the task is considered completed.
plan_id
Type: STRING
Provider name: planId
Description: Plan ID to which the task belongs.
preview_type
Type: STRING
Provider name: previewType
Description: This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference.
priority
Type: INT32
Provider name: priority
Description: Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ‘urgent’, 2, 3 and 4 as ‘important’, 5, 6, and 7 as ‘medium’, and 8, 9, and 10 as ’low’. Additionally, Planner sets the value 1 for ‘urgent’, 3 for ‘important’, 5 for ‘medium’, and 9 for ’low’.
progress_task_board_format
Type: STRUCT
Provider name: progressTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
reference_count
Type: INT32
Provider name: referenceCount
Description: Number of external references that exist on the task.
start_date_time
Type: STRING
Provider name: startDateTime
Description: Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
title
Type: STRING
Provider name: title
Description: Title of the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
title
Type: STRING
Provider name: title
Description: Required. Title of the plan.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
tasks
Type: UNORDERED_LIST_STRUCT
Provider name: tasks
Description: Read-only. Nullable. Returns the plannerPlans shared with the user.
active_checklist_item_count
Type: INT32
Provider name: activeChecklistItemCount
Description: Number of checklist items with value set to false, representing incomplete items.
applied_categories
Type: STRUCT
Provider name: appliedCategories
Description: The categories to which the task has been applied. See applied Categories for possible values.
assigned_to_task_board_format
Type: STRUCT
Provider name: assignedToTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by assignedTo.
name
Type: STRING
Provider name: name
order_hints_by_assignee
Type: STRUCT
Provider name: orderHintsByAssignee
Description: Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here.
unassigned_order_hint
Type: STRING
Provider name: unassignedOrderHint
Description: Hint value used to order the task on the AssignedTo view of the Task Board when the task isn’t assigned to anyone, or if the orderHintsByAssignee dictionary doesn’t provide an order hint for the user the task is assigned to. The format is defined as outlined here.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
assignee_priority
Type: STRING
Provider name: assigneePriority
Description: Hint used to order items of this type in a list view. The format is defined as outlined here.
assignments
Type: STRUCT
Provider name: assignments
Description: The set of assignees the task is assigned to.
bucket_id
Type: STRING
Provider name: bucketId
Description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It’s 28 characters long and case-sensitive. Format validation is done on the service.
bucket_task_board_format
Type: STRUCT
Provider name: bucketTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by bucket.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
checklist_item_count
Type: INT32
Provider name: checklistItemCount
Description: Number of checklist items that are present on the task.
completed_by
Type: STRUCT
Provider name: completedBy
Description: Identity of the user that completed the task.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
completed_date_time
Type: STRING
Provider name: completedDateTime
Description: Read-only. Date and time at which the ‘percentComplete’ of the task is set to ‘100’. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
conversation_thread_id
Type: STRING
Provider name: conversationThreadId
Description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the user that created the task.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
details
Type: STRUCT
Provider name: details
Description: Read-only. Nullable. More details about the task.
checklist
Type: STRUCT
Provider name: checklist
Description: The collection of checklist items on the task.
description
Type: STRING
Provider name: description
Description: Description of the task.
name
Type: STRING
Provider name: name
preview_type
Type: STRING
Provider name: previewType
Description: This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference. When set to automatic the displayed preview is chosen by the app viewing the task.
references
Type: STRUCT
Provider name: references
Description: The collection of references on the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
due_date_time
Type: STRING
Provider name: dueDateTime
Description: Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
has_description
Type: BOOLEAN
Provider name: hasDescription
Description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint used to order items of this type in a list view. The format is defined as outlined here.
percent_complete
Type: INT32
Provider name: percentComplete
Description: Percentage of task completion. When set to 100, the task is considered completed.
plan_id
Type: STRING
Provider name: planId
Description: Plan ID to which the task belongs.
preview_type
Type: STRING
Provider name: previewType
Description: This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference.
priority
Type: INT32
Provider name: priority
Description: Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ‘urgent’, 2, 3 and 4 as ‘important’, 5, 6, and 7 as ‘medium’, and 8, 9, and 10 as ’low’. Additionally, Planner sets the value 1 for ‘urgent’, 3 for ‘important’, 5 for ‘medium’, and 9 for ’low’.
progress_task_board_format
Type: STRUCT
Provider name: progressTaskBoardFormat
Description: Read-only. Nullable. Used to render the task correctly in the task board view when grouped by progress.
name
Type: STRING
Provider name: name
order_hint
Type: STRING
Provider name: orderHint
Description: Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
reference_count
Type: INT32
Provider name: referenceCount
Description: Number of external references that exist on the task.
start_date_time
Type: STRING
Provider name: startDateTime
Description: Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
title
Type: STRING
Provider name: title
Description: Title of the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
postal_code
Type: STRING
Provider name: postalCode
Description: The postal code for the user’s postal address. The postal code is specific to the user’s country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
preferred_data_location
Type: STRING
Provider name: preferredDataLocation
Description: The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
preferred_language
Type: STRING
Provider name: preferredLanguage
Description: The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: ’en-US’, or ’es-ES’. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)
preferred_name
Type: STRING
Provider name: preferredName
Description: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.
presence
Type: STRUCT
Provider name: presence
activity
Type: STRING
Provider name: activity
Description: The supplemental information to a user’s availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.
availability
Type: STRING
Provider name: availability
Description: The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown
name
Type: STRING
Provider name: name
status_message
Type: STRUCT
Provider name: statusMessage
Description: The presence status message of a user.
expiry_date_time
Type: STRUCT
Provider name: expiryDateTime
Description: Time in which the status message expires.If not provided, the status message doesn’t expire.expiryDateTime.dateTime shouldn’t include time zone.expiryDateTime isn’t available when you request the presence of another user.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
message
Type: STRUCT
Provider name: message
Description: Status message item. The only supported format currently is message.contentType = ’text’.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
published_date_time
Type: STRING
Provider name: publishedDateTime
Description: Time in which the status message was published.Read-only.publishedDateTime isn’t available when you request the presence of another user.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
provisioned_plans
Type: UNORDERED_LIST_STRUCT
Provider name: provisionedPlans
Description: The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le).
capability_status
Type: STRING
Provider name: capabilityStatus
Description: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.
provisioning_status
Type: STRING
Provider name: provisioningStatus
Description: The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn’t provisioned and is in an error state.PendingInput - The service isn’t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn’t activated in the tenant.
service
Type: STRING
Provider name: service
Description: The name of the service; for example, ‘AccessControlS2S’.
proxy_addresses
Type: UNORDERED_LIST_STRING
Provider name: proxyAddresses
Description: For example: [‘SMTP: bob@contoso.com’, ‘smtp: bob@sales.contoso.com’]. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
registered_devices
Type: UNORDERED_LIST_STRUCT
Provider name: registeredDevices
Description: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
resource_group
Type: STRING
responsibilities
Type: UNORDERED_LIST_STRING
Provider name: responsibilities
Description: A list for the user to enumerate their responsibilities. Returned only on $select.
schools
Type: UNORDERED_LIST_STRING
Provider name: schools
Description: A list for the user to enumerate the schools they attended. Returned only on $select.
scoped_role_member_of
Type: UNORDERED_LIST_STRUCT
Provider name: scopedRoleMemberOf
administrative_unit_id
Type: STRING
Provider name: administrativeUnitId
Description: Unique identifier for the administrative unit that the directory role is scoped to
name
Type: STRING
Provider name: name
role_id
Type: STRING
Provider name: roleId
Description: Unique identifier for the directory role that the member is in.
role_member_info
Type: STRUCT
Provider name: roleMemberInfo
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
security_identifier
Type: STRING
Provider name: securityIdentifier
Description: Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).
service_provisioning_errors
Type: UNORDERED_LIST_STRUCT
Provider name: serviceProvisioningErrors
Description: Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time at which the error occurred.
is_resolved
Type: BOOLEAN
Provider name: isResolved
Description: Indicates whether the error has been attended to.
service_instance
Type: STRING
Provider name: serviceInstance
Description: Qualified service instance (for example, ‘SharePoint/Dublin’) that published the service error information.
settings
Type: STRUCT
Provider name: settings
contribution_to_content_discovery_as_organization_disabled
Type: BOOLEAN
Provider name: contributionToContentDiscoveryAsOrganizationDisabled
Description: Reflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn’t have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center.
contribution_to_content_discovery_disabled
Type: BOOLEAN
Provider name: contributionToContentDiscoveryDisabled
Description: When set to true, the delegate access to the user’s trending API is disabled. When set to true, documents in the user’s Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve.
item_insights
Type: STRUCT
Provider name: itemInsights
Description: The user’s settings for the visibility of meeting hour insights, and insights derived between a user and other items in Microsoft 365, such as documents or sites. Get userInsightsSettings through this navigation property.
is_enabled
Type: BOOLEAN
Provider name: isEnabled
Description: True if the user’s itemInsights and meeting hours insights are enabled; false if the user’s itemInsights and meeting hours insights are disabled. The default value is true. Optional.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
shift_preferences
Type: STRUCT
Provider name: shiftPreferences
availability
Type: UNORDERED_LIST_STRUCT
Provider name: availability
Description: Availability of the user to be scheduled for work and its recurrence pattern.
recurrence
Type: STRUCT
Provider name: recurrence
Description: Specifies the pattern for recurrence
pattern
Type: STRUCT
Provider name: pattern
Description: The frequency of an event. For access reviews: Do not specify this property for a one-time access review. Only interval, dayOfMonth, and type (weekly, absoluteMonthly) properties of recurrencePattern are supported.
day_of_month
Type: INT32
Provider name: dayOfMonth
Description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.
days_of_week
Type: UNORDERED_LIST_STRING
Provider name: daysOfWeek
Description: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.
first_day_of_week
Type: STRING
Provider name: firstDayOfWeek
Description: The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly.
index
Type: STRING
Provider name: index
Description: Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly.
interval
Type: INT32
Provider name: interval
Description: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.
month
Type: INT32
Provider name: month
Description: The month in which the event occurs. This is a number from 1 to 12.
type
Type: STRING
Provider name: type
Description: The recurrence pattern type: daily, weekly, absoluteMonthly, relativeMonthly, absoluteYearly, relativeYearly. Required. For more information, see values of type property.
range
Type: STRUCT
Provider name: range
Description: The duration of an event.
end_date
Type: STRING
Provider name: endDate
Description: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.
number_of_occurrences
Type: INT32
Provider name: numberOfOccurrences
Description: The number of times to repeat the event. Required and must be positive if type is numbered.
recurrence_time_zone
Type: STRING
Provider name: recurrenceTimeZone
Description: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.
start_date
Type: STRING
Provider name: startDate
Description: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.
type
Type: STRING
Provider name: type
Description: The recurrence range. The possible values are: endDate, noEnd, numbered. Required.
time_slots
Type: UNORDERED_LIST_STRUCT
Provider name: timeSlots
Description: The time slot(s) preferred by the user.
end_time
Type: STRING
Provider name: endTime
Description: End time for the time range.
start_time
Type: STRING
Provider name: startTime
Description: Start time for the time range.
time_zone
Type: STRING
Provider name: timeZone
Description: Specifies the time zone for the indicated time.
name
Type: STRING
Provider name: name
created_by
Type: STRUCT
Provider name: createdBy
Description: Identity of the creator of the entity.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
last_modified_by
Type: STRUCT
Provider name: lastModifiedBy
Description: Identity of the person who last modified the entity.
application
Type: STRUCT
Provider name: application
Description: Optional. The application associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
device
Type: STRUCT
Provider name: device
Description: Optional. The device associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
user
Type: STRUCT
Provider name: user
Description: Optional. The user associated with this action.
display_name
Type: STRING
Provider name: displayName
Description: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don’t show up as changed when using delta.
id
Type: STRING
Provider name: id
Description: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that’s subject to review.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
storage
Type: STRUCT
Provider name: storage
name
Type: STRING
Provider name: name
quota
Type: STRUCT
Provider name: quota
deleted
Type: INT64
Provider name: deleted
manage_web_url
Type: STRING
Provider name: manageWebUrl
name
Type: STRING
Provider name: name
remaining
Type: INT64
Provider name: remaining
services
Type: UNORDERED_LIST_STRUCT
Provider name: services
name
Type: STRING
Provider name: name
display_name
Type: STRING
Provider name: displayName
manage_web_url
Type: STRING
Provider name: manageWebUrl
used
Type: INT64
Provider name: used
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
state
Type: STRING
Provider name: state
total
Type: INT64
Provider name: total
used
Type: INT64
Provider name: used
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
windows
Type: UNORDERED_LIST_STRUCT
Provider name: windows
instances
Type: UNORDERED_LIST_STRUCT
Provider name: instances
Description: A collection of setting values for a given windowsSetting.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: Set by the server. Represents the dateTime in UTC when the object was created on the server.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: Set by the server. The object expires at the specified dateTime in UTC, making it unavailable after that time.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: Set by the server if not provided in the request from the Windows client device. Refers to the user’s Windows device that modified the object at the specified dateTime in UTC.
name
Type: STRING
Provider name: name
payload
Type: STRING
Provider name: payload
Description: Base64-encoded JSON setting value.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
payload_type
Type: STRING
Provider name: payloadType
Description: The type of setting payloads contained in the instances navigation property.
setting_type
Type: STRING
Provider name: settingType
windows_device_id
Type: STRING
Provider name: windowsDeviceId
Description: A unique identifier for the device the setting might belong to if it is of the settingType backup.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
show_in_address_list
Type: BOOLEAN
Provider name: showInAddressList
Description: Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
sign_in_activity
Type: STRUCT
Provider name: signInActivity
Description: Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: Details for this property require a Microsoft Entra ID P1 or P2 license and the AuditLog.Read.All permission.This property isn’t returned for a user who never signed in or last signed in before April 2020.
last_non_interactive_sign_in_date_time
Type: STRING
Provider name: lastNonInteractiveSignInDateTime
Description: The last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted (either successfully or unsuccessfully) to sign in to the directory on behalf of a user. Because some users may use clients to access tenant resources rather than signing into your tenant directly, you can use the non-interactive sign-in date to along with lastSignInDateTime to identify inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains non-interactive sign-ins going back to May 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.
last_non_interactive_sign_in_request_id
Type: STRING
Provider name: lastNonInteractiveSignInRequestId
Description: Request identifier of the last non-interactive sign-in performed by this user.
last_sign_in_date_time
Type: STRING
Provider name: lastSignInDateTime
Description: The last interactive sign-in date and time for a specific user. This property records the last time a user attempted an interactive sign-in to the directory—whether the attempt was successful or not. Note: Since unsuccessful attempts are also logged, this value might not accurately reflect actual system usage. For tracking actual account access, please use the lastSuccessfulSignInDateTime property. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
last_sign_in_request_id
Type: STRING
Provider name: lastSignInRequestId
Description: Request identifier of the last interactive sign-in performed by this user.
last_successful_sign_in_date_time
Type: STRING
Provider name: lastSuccessfulSignInDateTime
Description: The date and time of the user’s most recent successful interactive or non-interactive sign-in. Use this property if you need to determine when the account was truly accessed. This field can be used to build reports, such as inactive users. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Microsoft Entra ID maintains interactive sign-ins going back to April 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.
last_successful_sign_in_request_id
Type: STRING
Provider name: lastSuccessfulSignInRequestId
Description: The request ID of the last successful sign-in.
sign_in_sessions_valid_from_date_time
Type: STRING
Provider name: signInSessionsValidFromDateTime
Description: Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select.
skills
Type: UNORDERED_LIST_STRING
Provider name: skills
Description: A list for the user to enumerate their skills. Returned only on $select.
solutions
Type: STRUCT
Provider name: solutions
Description: The identifier that relates the user to the working time schedule triggers. Read-Only. Nullable
name
Type: STRING
Provider name: name
working_time_schedule
Type: STRUCT
Provider name: workingTimeSchedule
Description: The working time schedule entity associated with the solution.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
Type: UNORDERED_LIST_STRUCT
Provider name: sponsors
Description: The users and groups responsible for this guest’s privileges in the tenant and keeping the guest’s information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
state
Type: STRING
Provider name: state
Description: The state or province in the user’s address. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
street_address
Type: STRING
Provider name: streetAddress
Description: The street address of the user’s place of business. Maximum length is 1,024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
subscription_id
Type: STRING
subscription_name
Type: STRING
surname
Type: STRING
Provider name: surname
Description: The user’s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
Type: UNORDERED_LIST_STRING
todo
Type: STRUCT
Provider name: todo
Description: Represents the To Do services available to a user.
lists
Type: UNORDERED_LIST_STRUCT
Provider name: lists
Description: The task lists in the users mailbox.
display_name
Type: STRING
Provider name: displayName
Description: The name of the task list.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the task list. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
is_owner
Type: BOOLEAN
Provider name: isOwner
Description: True if the user is owner of the given task list.
is_shared
Type: BOOLEAN
Provider name: isShared
Description: True if the task list is shared with other users
name
Type: STRING
Provider name: name
tasks
Type: UNORDERED_LIST_STRUCT
Provider name: tasks
Description: The tasks in this task list. Read-only. Nullable.
attachment_sessions
Type: UNORDERED_LIST_STRUCT
Provider name: attachmentSessions
content
Type: STRING
Provider name: content
Description: The content streams that are uploaded.
expiration_date_time
Type: STRING
Provider name: expirationDateTime
Description: The date and time in UTC when the upload session will expire. The complete file must be uploaded before this expiration time is reached.
name
Type: STRING
Provider name: name
next_expected_ranges
Type: UNORDERED_LIST_STRING
Provider name: nextExpectedRanges
Description: Indicates a single value {start} that represents the location in the file where the next upload should begin.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
attachments
Type: UNORDERED_LIST_STRUCT
Provider name: attachments
Description: A collection of file attachments for the task.
content_type
Type: STRING
Provider name: contentType
Description: The MIME type.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
name
Type: STRING
Provider name: name
Description: The display name of the attachment. This doesn’t need to be the actual file name.
size
Type: INT32
Provider name: size
Description: The length of the attachment in bytes.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
body
Type: STRUCT
Provider name: body
Description: The task body that typically contains information about the task.
content
Type: STRING
Provider name: content
Description: The content of the item.
content_type
Type: STRING
Provider name: contentType
Description: The type of the content. Possible values are text and html.
body_last_modified_date_time
Type: STRING
Provider name: bodyLastModifiedDateTime
Description: The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.
categories
Type: UNORDERED_LIST_STRING
Provider name: categories
Description: The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.
checklist_items
Type: UNORDERED_LIST_STRUCT
Provider name: checklistItems
Description: A collection of checklistItems linked to a task.
checked_date_time
Type: STRING
Provider name: checkedDateTime
Description: The date and time when the checklistItem was finished.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the checklistItem was created.
display_name
Type: STRING
Provider name: displayName
Description: Indicates the title of the checklistItem.
is_checked
Type: BOOLEAN
Provider name: isChecked
Description: State that indicates whether the item is checked off or not.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
completed_date_time
Type: STRUCT
Provider name: completedDateTime
Description: The date and time in the specified time zone that the task was finished.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
created_date_time
Type: STRING
Provider name: createdDateTime
Description: The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.
due_date_time
Type: STRUCT
Provider name: dueDateTime
Description: The date and time in the specified time zone that the task is to be finished.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
extensions
Type: UNORDERED_LIST_STRUCT
Provider name: extensions
Description: The collection of open extensions defined for the task. Nullable.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
has_attachments
Type: BOOLEAN
Provider name: hasAttachments
Description: Indicates whether the task has attachments.
importance
Type: STRING
Provider name: importance
is_reminder_on
Type: BOOLEAN
Provider name: isReminderOn
Description: Set to true if an alert is set to remind the user of the task.
last_modified_date_time
Type: STRING
Provider name: lastModifiedDateTime
Description: The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: ‘2020-01-01T00:00:00Z’.
linked_resources
Type: UNORDERED_LIST_STRUCT
Provider name: linkedResources
Description: A collection of resources linked to the task.
application_name
Type: STRING
Provider name: applicationName
Description: The app name of the source that sends the linkedResource.
display_name
Type: STRING
Provider name: displayName
Description: The title of the linkedResource.
external_id
Type: STRING
Provider name: externalId
Description: ID of the object that is associated with this task on the third-party/partner system.
name
Type: STRING
Provider name: name
web_url
Type: STRING
Provider name: webUrl
Description: Deep link to the linkedResource.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
recurrence
Type: STRUCT
Provider name: recurrence
Description: The recurrence pattern for the task.
pattern
Type: STRUCT
Provider name: pattern
Description: The frequency of an event. For access reviews: Do not specify this property for a one-time access review. Only interval, dayOfMonth, and type (weekly, absoluteMonthly) properties of recurrencePattern are supported.
day_of_month
Type: INT32
Provider name: dayOfMonth
Description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.
days_of_week
Type: UNORDERED_LIST_STRING
Provider name: daysOfWeek
Description: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.
first_day_of_week
Type: STRING
Provider name: firstDayOfWeek
Description: The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly.
index
Type: STRING
Provider name: index
Description: Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly.
interval
Type: INT32
Provider name: interval
Description: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.
month
Type: INT32
Provider name: month
Description: The month in which the event occurs. This is a number from 1 to 12.
type
Type: STRING
Provider name: type
Description: The recurrence pattern type: daily, weekly, absoluteMonthly, relativeMonthly, absoluteYearly, relativeYearly. Required. For more information, see values of type property.
range
Type: STRUCT
Provider name: range
Description: The duration of an event.
end_date
Type: STRING
Provider name: endDate
Description: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.
number_of_occurrences
Type: INT32
Provider name: numberOfOccurrences
Description: The number of times to repeat the event. Required and must be positive if type is numbered.
recurrence_time_zone
Type: STRING
Provider name: recurrenceTimeZone
Description: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.
start_date
Type: STRING
Provider name: startDate
Description: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.
type
Type: STRING
Provider name: type
Description: The recurrence range. The possible values are: endDate, noEnd, numbered. Required.
reminder_date_time
Type: STRUCT
Provider name: reminderDateTime
Description: The date and time in the specified time zone for a reminder alert of the task to occur.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
start_date_time
Type: STRUCT
Provider name: startDateTime
Description: The date and time in the specified time zone at which the task is scheduled to start.
date_time
Type: STRING
Provider name: dateTime
Description: A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
time_zone
Type: STRING
Provider name: timeZone
Description: Represents a time zone, for example, ‘Pacific Standard Time’. See below for more possible values.
status
Type: STRING
Provider name: status
title
Type: STRING
Provider name: title
Description: A brief description of the task.
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
wellknown_list_name
Type: STRING
Provider name: wellknownListName
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
transitive_member_of
Type: UNORDERED_LIST_STRUCT
Provider name: transitiveMemberOf
Description: The groups, including nested groups, and directory roles that a user is a member of. Nullable.
deleted_date_time
Type: STRING
Provider name: deletedDateTime
Description: Date and time when this object was deleted. Always null when the object hasn’t been deleted.
name
Type: STRING
Provider name: name
id
Type: STRING
Provider name: id
Description: The unique identifier for an entity. Read-only.
usage_location
Type: STRING
Provider name: usageLocation
Description: A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: US, JP, and GB. Not nullable. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
user_principal_name
Type: STRING
Provider name: userPrincipalName
Description: The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user’s email name. The general format is alias@domain, where the domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property can’t contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ’ . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
user_type
Type: STRING
Provider name: userType
Description: A string value that can be used to classify user types in your directory. The possible values are Member and Guest. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for members and guests, see What are the default user permissions in Microsoft Entra ID?
