Skip to content

Instantly share code, notes, and snippets.

@timayabi2020

timayabi2020/SampleIdentityGovernance.yml

Created June 14, 2023 14:01
Show Gist options
  • Save timayabi2020/ce733256dab5002ee304d87d4b15642f to your computer and use it in GitHub Desktop.
Save timayabi2020/ce733256dab5002ee304d87d4b15642f to your computer and use it in GitHub Desktop.
Download ZIP
Raw
SampleIdentityGovernance.yml
openapi: 3.0.1
info:
version: v1.0
title: Identity.Governance
servers:
- url: https://graph.microsoft.com/v1.0/
description: Core
paths:
/identityGovernance/accessReviews/definitions:
get:
tags:
- identityGovernance.accessReviewSet
summary: List definitions
description: Get a list of the accessReviewScheduleDefinition objects and their properties.
externalDocs:
description: Find more info here
url: https://docs.microsoft.com/graph/api/accessreviewset-list-definitions?view=graph-rest-1.0
operationId: identityGovernance.accessReview_ListDefinition
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
enum:
- id
- id desc
- additionalNotificationRecipients
- additionalNotificationRecipients desc
- createdBy
- createdBy desc
- createdDateTime
- createdDateTime desc
- descriptionForAdmins
- descriptionForAdmins desc
- descriptionForReviewers
- descriptionForReviewers desc
- displayName
- displayName desc
- fallbackReviewers
- fallbackReviewers desc
- instanceEnumerationScope
- instanceEnumerationScope desc
- lastModifiedDateTime
- lastModifiedDateTime desc
- reviewers
- reviewers desc
- scope
- scope desc
- settings
- settings desc
- stageSettings
- stageSettings desc
- status
- status desc
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
enum:
- id
- additionalNotificationRecipients
- createdBy
- createdDateTime
- descriptionForAdmins
- descriptionForReviewers
- displayName
- fallbackReviewers
- instanceEnumerationScope
- lastModifiedDateTime
- reviewers
- scope
- settings
- stageSettings
- status
- instances
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
enum:
- '*'
- instances
type: string
responses:
2XX:
$ref: '#/components/responses/microsoft.graph.accessReviewScheduleDefinitionCollectionResponse'
default:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- identityGovernance.accessReviewSet
summary: Create definitions
description: Create a new accessReviewScheduleDefinition object.
externalDocs:
description: Find more info here
url: https://docs.microsoft.com/graph/api/accessreviewset-post-definitions?view=graph-rest-1.0
operationId: identityGovernance.accessReview_CreateDefinition
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
default:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
components:
schemas:
microsoft.graph.agreement:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreement
type: object
properties:
displayName:
type: string
description: Display name of the agreement. The display name is used for internal tracking of the agreement but is not shown to end users who view the agreement. Supports $filter (eq).
nullable: true
isPerDeviceAcceptanceRequired:
type: boolean
description: 'Indicates whether end users are required to accept this agreement on every device that they access it from. The end user is required to register their device in Azure AD, if they haven''t already done so. Supports $filter (eq).'
nullable: true
isViewingBeforeAcceptanceRequired:
type: boolean
description: Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).
nullable: true
termsExpiration:
$ref: '#/components/schemas/microsoft.graph.termsExpiration'
userReacceptRequiredFrequency:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: The duration after which the user must re-accept the terms of use. The value is represented in ISO 8601 format for durations. Supports $filter (eq).
format: duration
nullable: true
acceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: Read-only. Information about acceptances of this agreement.
x-ms-navigationProperty: true
file:
$ref: '#/components/schemas/microsoft.graph.agreementFile'
files:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementAcceptance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementAcceptance
type: object
properties:
agreementFileId:
type: string
description: The identifier of the agreement file accepted by the user.
nullable: true
agreementId:
type: string
description: The identifier of the agreement.
nullable: true
deviceDisplayName:
type: string
description: The display name of the device used for accepting the agreement.
nullable: true
deviceId:
type: string
description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
nullable: true
deviceOSType:
type: string
description: The operating system used to accept the agreement.
nullable: true
deviceOSVersion:
type: string
description: The operating system version of the device used to accept the agreement.
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
recordedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState'
userDisplayName:
type: string
description: Display name of the user when the acceptance was recorded.
nullable: true
userEmail:
type: string
description: Email of the user when the acceptance was recorded.
nullable: true
userId:
type: string
description: The identifier of the user who accepted the agreement. Supports $filter (eq).
nullable: true
userPrincipalName:
type: string
description: UPN of the user when the acceptance was recorded.
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementFile:
allOf:
- $ref: '#/components/schemas/microsoft.graph.agreementFileProperties'
- title: agreementFile
type: object
properties:
localizations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
description: The localized version of the terms of use agreement files attached to the agreement.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementFileLocalization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.agreementFileProperties'
- title: agreementFileLocalization
type: object
properties:
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.agreementFileVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.agreementFileProperties'
- title: agreementFileVersion
type: object
additionalProperties:
type: object
microsoft.graph.identityGovernance:
title: identityGovernance
type: object
properties:
accessReviews:
$ref: '#/components/schemas/microsoft.graph.accessReviewSet'
appConsent:
$ref: '#/components/schemas/microsoft.graph.appConsentApprovalRoute'
termsOfUse:
$ref: '#/components/schemas/microsoft.graph.termsOfUseContainer'
entitlementManagement:
$ref: '#/components/schemas/microsoft.graph.entitlementManagement'
additionalProperties:
type: object
microsoft.graph.accessReviewSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewSet
type: object
properties:
definitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
description: Represents the template and scheduling for an access review.
x-ms-navigationProperty: true
historyDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
description: Represents a collection of access review history data and the scopes used to collect that data.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewScheduleDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewScheduleDefinition
type: object
properties:
additionalNotificationRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientItem'
description: Defines the list of additional users or group members to be notified of the access review progress.
createdBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the access review series was created. Supports $select. Read-only.
format: date-time
nullable: true
descriptionForAdmins:
type: string
description: Description provided by review creators to provide more context of the review to admins. Supports $select.
nullable: true
descriptionForReviewers:
type: string
description: Description provided by review creators to provide more context of the review to reviewers. Reviewers will see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.
nullable: true
displayName:
type: string
description: Name of the access review series. Supports $select and $orderBy. Required on create.
nullable: true
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.'
instanceEnumerationScope:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the access review series was last modified. Supports $select. Read-only.
format: date-time
nullable: true
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.'
scope:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
settings:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleSettings'
stageSettings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStageSettings'
description: 'Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages will be created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.'
status:
type: string
description: 'This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
description: 'If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that does not recur will have exactly one instance. Instances also represent each unique resource under review in the accessReviewScheduleDefinition. If a review has multiple resources and multiple instances, each resource will have a unique instance for each recurrence.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewInstance
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'DateTime when review instance is scheduled to end.The DatetimeOffset 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 $select. Read-only.'
format: date-time
nullable: true
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist. Supports $select.'
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
scope:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'DateTime when review instance is scheduled to start. May be in the future. The DateTimeOffset 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 $select. Read-only.'
format: date-time
nullable: true
status:
type: string
description: 'Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
contactedReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
description: 'Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.'
x-ms-navigationProperty: true
decisions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
description: 'Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.'
x-ms-navigationProperty: true
stages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
description: 'If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewReviewer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewReviewer
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date when the reviewer was added for the access review.
format: date-time
nullable: true
displayName:
type: string
description: Name of reviewer.
nullable: true
userPrincipalName:
type: string
description: User principal name of the reviewer.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewInstanceDecisionItem
type: object
properties:
accessReviewId:
type: string
description: The identifier of the accessReviewInstance parent. Supports $select. Read-only.
appliedBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
appliedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The timestamp when the approval decision was applied.00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn''t applied the decision or it was automatically applied. The DatetimeOffset 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 $select. Read-only.'
format: date-time
nullable: true
applyResult:
type: string
description: 'The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
decision:
type: string
description: 'Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).'
nullable: true
justification:
type: string
description: Justification left by the reviewer when they made the decision.
nullable: true
principal:
$ref: '#/components/schemas/microsoft.graph.identity'
principalLink:
type: string
description: 'A link to the principal object. For example, https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.'
nullable: true
recommendation:
type: string
description: 'A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within thirty days of start of review. Recommend deny if sign-in is greater than thirty days of start of review. Recommendation not available otherwise. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
resource:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemResource'
resourceLink:
type: string
description: 'A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.'
nullable: true
reviewedBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
reviewedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The timestamp when the review decision occurred. Supports $select. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItemFilterByCurrentUserOptions:
title: accessReviewInstanceDecisionItemFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewStage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewStage
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time in ISO 8601 format and UTC time when the review stage is scheduled to end. This property is the cumulative total of the durationInDays for all stages. Read-only.
format: date-time
nullable: true
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist.'
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'This collection of access review scopes is used to define who the reviewers are. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time in ISO 8601 format and UTC time when the review stage is scheduled to start. Read-only.
format: date-time
nullable: true
status:
type: string
description: 'Specifies the status of an accessReviewStage. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $orderby, and $filter (eq only). Read-only.'
nullable: true
decisions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
description: 'Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewStageFilterByCurrentUserOptions:
title: accessReviewStageFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewInstanceFilterByCurrentUserOptions:
title: accessReviewInstanceFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewScheduleDefinitionFilterByCurrentUserOptions:
title: accessReviewScheduleDefinitionFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.accessReviewHistoryDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewHistoryDefinition
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.userIdentity'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the access review definition was created.
format: date-time
decisions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDecisionFilter'
description: 'Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions will be included by default if no decisions are provided on create. Possible values are: approve, deny, dontKnow, notReviewed, and notNotified.'
displayName:
type: string
description: Name for the access review history data collection. Required.
reviewHistoryPeriodEndDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined.
format: date-time
reviewHistoryPeriodStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined.
format: date-time
scheduleSettings:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryScheduleSettings'
scopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScope'
description: Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
status:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryStatus'
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
description: 'If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that does not recur will have exactly one instance.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessReviewHistoryInstance
type: object
properties:
downloadUri:
type: string
description: Uri which can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when this instance and associated data expires and the history is deleted. Required.
format: date-time
fulfilledDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when all of the available data for this instance was collected. This will be set after this instance's status is set to done. Required.
format: date-time
nullable: true
reviewHistoryPeriodEndDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp, reviews ending on or before this date will be included in the fetched history data.'
format: date-time
nullable: true
reviewHistoryPeriodStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp, reviews starting on or after this date will be included in the fetched history data.'
format: date-time
nullable: true
runDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp when the instance's history data is scheduled to be generated.
format: date-time
status:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryStatus'
additionalProperties:
type: object
microsoft.graph.appConsentApprovalRoute:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: appConsentApprovalRoute
type: object
properties:
appConsentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
description: A collection of userConsentRequest objects for a specific application.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.appConsentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: appConsentRequest
type: object
properties:
appDisplayName:
type: string
description: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.
nullable: true
appId:
type: string
description: The identifier of the application. Required. Supports $filter (eq only) and $orderby.
pendingScopes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequestScope'
description: A list of pending scopes waiting for approval. Required.
userConsentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
description: A list of pending user consent requests. Supports $filter (eq).
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userConsentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: userConsentRequest
type: object
properties:
reason:
type: string
description: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
nullable: true
approval:
$ref: '#/components/schemas/microsoft.graph.approval'
additionalProperties:
type: object
microsoft.graph.approval:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: approval
type: object
properties:
stages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
description: A collection of stages in the approval decision.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.approvalStage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: approvalStage
type: object
properties:
assignedToMe:
type: boolean
description: Indicates whether the stage is assigned to the calling user to review. Read-only.
nullable: true
displayName:
type: string
description: The label provided by the policy creator to identify an approval stage. Read-only.
nullable: true
justification:
type: string
description: The justification associated with the approval stage decision.
nullable: true
reviewedBy:
$ref: '#/components/schemas/microsoft.graph.identity'
reviewedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when a decision was recorded. 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. Read-only.'
format: date-time
nullable: true
reviewResult:
type: string
description: 'The result of this approval record. Possible values include: NotReviewed, Approved, Denied.'
nullable: true
status:
type: string
description: 'The stage status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.consentRequestFilterByCurrentUserOptions:
title: consentRequestFilterByCurrentUserOptions
enum:
- reviewer
- unknownFutureValue
type: string
microsoft.graph.entitlementManagement:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: entitlementManagement
type: object
properties:
accessPackageAssignmentApprovals:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
description: Approval stages for decisions associated with access package assignment requests.
x-ms-navigationProperty: true
accessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: Access packages define the collection of resource roles and the policies for which subjects can request or be assigned access to those resources.
x-ms-navigationProperty: true
assignmentPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
description: Access package assignment policies govern which subjects can request or be assigned an access package via an access package assignment.
x-ms-navigationProperty: true
assignmentRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
description: Access package assignment requests created by or on behalf of a subject.
x-ms-navigationProperty: true
assignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
description: The assignment of an access package to a subject for a period of time.
x-ms-navigationProperty: true
catalogs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
description: A container for access packages.
x-ms-navigationProperty: true
connectedOrganizations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
description: References to a directory or domain of another organization whose users can request access.
x-ms-navigationProperty: true
settings:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings'
additionalProperties:
type: object
microsoft.graph.approvalFilterByCurrentUserOptions:
title: approvalFilterByCurrentUserOptions
enum:
- target
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.accessPackage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackage
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
description:
type: string
description: The description of the access package.
nullable: true
displayName:
type: string
description: 'The display name of the access package. Supports $filter (eq, contains).'
nullable: true
isHidden:
type: boolean
description: Whether the access package is hidden from the requestor.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
accessPackagesIncompatibleWith:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: The access packages that are incompatible with this package. Read-only.
x-ms-navigationProperty: true
assignmentPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
x-ms-navigationProperty: true
catalog:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
incompatibleAccessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: The access packages whose assigned users are ineligible to be assigned this access package.
x-ms-navigationProperty: true
incompatibleGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
description: The groups whose members are ineligible to be assigned this access package.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageAssignmentPolicy
type: object
properties:
allowedTargetScope:
$ref: '#/components/schemas/microsoft.graph.allowedTargetScope'
automaticRequestSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAutomaticRequestSettings'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
description:
type: string
description: The description of the policy.
nullable: true
displayName:
type: string
description: The display name of the policy.
nullable: true
expiration:
$ref: '#/components/schemas/microsoft.graph.expirationPattern'
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
requestApprovalSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentApprovalSettings'
requestorSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestorSettings'
reviewSettings:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentReviewSettings'
specificAllowedTargets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: The principals that can be assigned access from an access package through this policy.
accessPackage:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
catalog:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
questions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
description: Questions that are posed to the requestor.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageCatalog:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageCatalog
type: object
properties:
catalogType:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalogType'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
description:
type: string
description: The description of the access package catalog.
nullable: true
displayName:
type: string
description: The display name of the access package catalog.
nullable: true
isExternallyVisible:
type: boolean
description: Whether the access packages in this catalog can be requested by users outside of the tenant.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalogState'
accessPackages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
description: The access packages in this catalog. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageQuestion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageQuestion
type: object
properties:
isAnswerEditable:
type: boolean
description: Specifies whether the requestor is allowed to edit answers to questions for an assignment by posting an update to accessPackageAssignmentRequest.
nullable: true
isRequired:
type: boolean
description: Whether the requestor is required to supply an answer or not.
nullable: true
localizations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageLocalizedText'
description: The text of the question represented in a format for a specific locale.
sequence:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Relative position of this question when displaying a list of questions to the requestor.
format: int32
nullable: true
text:
type: string
description: The text of the question to show to the requestor.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestRequirements:
title: accessPackageAssignmentRequestRequirements
type: object
properties:
allowCustomAssignmentSchedule:
type: boolean
description: Indicates whether the requestor is allowed to set a custom schedule.
nullable: true
isApprovalRequiredForAdd:
type: boolean
description: Indicates whether a request to add must be approved by an approver.
nullable: true
isApprovalRequiredForUpdate:
type: boolean
description: Indicates whether a request to update must be approved by an approver.
nullable: true
policyDescription:
type: string
description: The description of the policy that the user is trying to request access using.
nullable: true
policyDisplayName:
type: string
description: The display name of the policy that the user is trying to request access using.
nullable: true
policyId:
type: string
description: The identifier of the policy that these requirements are associated with. This identifier can be used when creating a new assignment request.
nullable: true
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
questions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.accessPackageFilterByCurrentUserOptions:
title: accessPackageFilterByCurrentUserOptions
enum:
- allowedRequestor
- unknownFutureValue
type: string
microsoft.graph.accessPackageAssignmentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageAssignmentRequest
type: object
properties:
answers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAnswer'
description: Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date of the end of processing, either successful or failure, of a request. 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.'
format: date-time
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
requestType:
$ref: '#/components/schemas/microsoft.graph.accessPackageRequestType'
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageRequestState'
status:
type: string
description: More information on the request processing status. Read-only.
nullable: true
accessPackage:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
assignment:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
requestor:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageAssignment
type: object
properties:
expiredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
state:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentState'
status:
type: string
description: 'More information about the assignment lifecycle. Possible values include Delivering, Delivered, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.'
nullable: true
accessPackage:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
assignmentPolicy:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
target:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubject'
additionalProperties:
type: object
microsoft.graph.accessPackageSubject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: accessPackageSubject
type: object
properties:
displayName:
type: string
description: The display name of the subject.
nullable: true
email:
type: string
description: The email address of the subject.
nullable: true
objectId:
type: string
description: The object identifier of the subject. null if the subject is not yet a user in the tenant.
nullable: true
onPremisesSecurityIdentifier:
type: string
description: 'A string representation of the principal''s security identifier, if known, or null if the subject does not have a security identifier.'
nullable: true
principalName:
type: string
description: 'The principal name, if known, of the subject.'
nullable: true
subjectType:
$ref: '#/components/schemas/microsoft.graph.accessPackageSubjectType'
connectedOrganization:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestFilterByCurrentUserOptions:
title: accessPackageAssignmentRequestFilterByCurrentUserOptions
enum:
- target
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.accessPackageAssignmentFilterByCurrentUserOptions:
title: accessPackageAssignmentFilterByCurrentUserOptions
enum:
- target
- createdBy
- unknownFutureValue
type: string
microsoft.graph.connectedOrganization:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: connectedOrganization
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
description:
type: string
description: The description of the connected organization.
nullable: true
displayName:
type: string
description: The display name of the connected organization. Supports $filter (eq).
nullable: true
identitySources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identitySource'
description: 'The identity sources in this connected organization, one of azureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation or crossCloudAzureActiveDirectoryTenant. Nullable.'
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
state:
$ref: '#/components/schemas/microsoft.graph.connectedOrganizationState'
externalSponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
internalSponsors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.directoryObject:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: directoryObject
type: object
properties:
deletedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time when this object was deleted. Always null when the object hasn't been deleted.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.extensionProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: extensionProperty
type: object
properties:
appDisplayName:
type: string
description: Display name of the application object on which this extension property is defined. Read-only.
nullable: true
dataType:
type: string
description: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum
isSyncedFromOnPremises:
type: boolean
description: Indicates if this extension property was synced from on-premises active directory using Azure AD Connect. Read-only.
nullable: true
name:
type: string
description: Name of the extension property. Not nullable. Supports $filter (eq).
targetObjects:
type: array
items:
type: string
description: Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization
additionalProperties:
type: object
microsoft.graph.entitlementManagementSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: entitlementManagementSettings
type: object
properties:
durationUntilExternalUserDeletedAfterBlocked:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'If externalUserLifecycleAction is blockSignInAndDelete, the duration, typically a number of days, after an external user is blocked from sign in before their account is deleted.'
format: duration
nullable: true
externalUserLifecycleAction:
$ref: '#/components/schemas/microsoft.graph.accessPackageExternalUserLifecycleAction'
additionalProperties:
type: object
microsoft.graph.termsOfUseContainer:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: termsOfUseContainer
type: object
properties:
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: Represents the current status of a user's response to a company's customizable terms of use agreement.
x-ms-navigationProperty: true
agreements:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreement'
description: Represents a tenant's customizable terms of use agreement that's created and managed with Azure Active Directory (Azure AD).
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.rbacApplication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: rbacApplication
type: object
properties:
resourceNamespaces:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
x-ms-navigationProperty: true
roleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
description: Resource to grant access to users or groups.
x-ms-navigationProperty: true
roleDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
description: Resource representing the roles allowed by RBAC providers and the permissions assigned to the roles.
x-ms-navigationProperty: true
roleAssignmentScheduleInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
description: Instances for active role assignments.
x-ms-navigationProperty: true
roleAssignmentScheduleRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
description: Requests for active role assignments to principals through PIM.
x-ms-navigationProperty: true
roleAssignmentSchedules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
description: Schedules for active role assignment operations.
x-ms-navigationProperty: true
roleEligibilityScheduleInstances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
description: Instances for role eligibility requests.
x-ms-navigationProperty: true
roleEligibilityScheduleRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
description: Requests for role eligibilities for principals through PIM.
x-ms-navigationProperty: true
roleEligibilitySchedules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
description: Schedules for role eligibility operations.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceNamespace:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRbacResourceNamespace
type: object
properties:
name:
type: string
resourceActions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceAction:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRbacResourceAction
type: object
properties:
actionVerb:
type: string
nullable: true
authenticationContextId:
type: string
nullable: true
description:
type: string
nullable: true
isAuthenticationContextSettable:
type: boolean
nullable: true
name:
type: string
resourceScopeId:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleAssignment
type: object
properties:
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment scope is app-specific. Either this property or directoryScopeId is required. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, in).'
nullable: true
condition:
type: string
nullable: true
directoryScopeId:
type: string
description: 'Identifier of the directory object representing the scope of the assignment. Either this property or appScopeId is required. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, in).'
nullable: true
principalId:
type: string
description: 'Identifier of the principal to which the assignment is granted. Supports $filter (eq, in).'
nullable: true
roleDefinitionId:
type: string
description: 'Identifier of the role definition the assignment is for. Read only. Supports $filter (eq, in).'
nullable: true
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
additionalProperties:
type: object
microsoft.graph.appScope:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: appScope
type: object
properties:
displayName:
type: string
description: 'Provides the display name of the app-specific resource represented by the app scope. Provided for display purposes since appScopeId is often an immutable, non-human-readable id. Read-only.'
nullable: true
type:
type: string
description: 'Describes the type of app-specific resource represented by the app scope. Provided for display purposes, so a user interface can convey to the user the kind of app specific resource represented by the app scope. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleDefinition
type: object
properties:
description:
type: string
description: The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true.
nullable: true
displayName:
type: string
description: 'The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in).'
nullable: true
isBuiltIn:
type: boolean
description: 'Flag indicating whether the role definition is part of the default set included in Azure Active Directory (Azure AD) or a custom definition. Read-only. Supports $filter (eq, in).'
nullable: true
isEnabled:
type: boolean
description: Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.
nullable: true
resourceScopes:
type: array
items:
type: string
description: List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment.
rolePermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRolePermission'
description: List of permissions included in the role. Read-only when isBuiltIn is true. Required.
templateId:
type: string
description: Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories.
nullable: true
version:
type: string
description: Indicates version of the role definition. Read-only when isBuiltIn is true.
nullable: true
inheritsPermissionsFrom:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
description: Read-only collection of role definitions that the given role definition inherits from. Only Azure AD built-in roles (isBuiltIn is true) support this attribute. Supports $expand.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleInstanceBase'
- title: unifiedRoleAssignmentScheduleInstance
type: object
properties:
assignmentType:
type: string
description: 'Type of the assignment which can either be Assigned or Activated. Supports $filter (eq, ne).'
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The end date of the schedule instance.
format: date-time
nullable: true
memberType:
type: string
description: 'How the assignments is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
roleAssignmentOriginId:
type: string
description: 'The identifier of the role assignment in Azure AD. Supports $filter (eq, ne).'
nullable: true
roleAssignmentScheduleId:
type: string
description: 'The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created. Supports $filter (eq, ne).'
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When this instance starts.
format: date-time
nullable: true
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleInstance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleInstanceBase'
- title: unifiedRoleEligibilityScheduleInstance
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The end date of the schedule instance.
format: date-time
nullable: true
memberType:
type: string
description: 'How the role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
roleEligibilityScheduleId:
type: string
description: 'The identifier of the unifiedRoleEligibilitySchedule object from which this instance was created. Supports $filter (eq, ne).'
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When this instance starts.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.roleAssignmentScheduleInstanceFilterByCurrentUserOptions:
title: roleAssignmentScheduleInstanceFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.unifiedRoleAssignmentScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: unifiedRoleAssignmentScheduleRequest
type: object
properties:
action:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleRequestActions'
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment is scoped to an app. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, ne, and on null values).'
nullable: true
directoryScopeId:
type: string
description: 'Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, ne, and on null values).'
nullable: true
isValidationOnly:
type: boolean
description: Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
nullable: true
justification:
type: string
description: A message provided by users and administrators when create they create the unifiedRoleAssignmentScheduleRequest object.
nullable: true
principalId:
type: string
description: 'Identifier of the principal that has been granted the assignment. Can be a user, role-assignable group, or a service principal. Supports $filter (eq, ne).'
nullable: true
roleDefinitionId:
type: string
description: 'Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
targetScheduleId:
type: string
description: 'Identifier of the schedule object that''s linked to the assignment request. Supports $filter (eq, ne).'
nullable: true
ticketInfo:
$ref: '#/components/schemas/microsoft.graph.ticketInfo'
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
targetSchedule:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilitySchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleBase'
- title: unifiedRoleEligibilitySchedule
type: object
properties:
memberType:
type: string
description: 'How the role eligibility is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleEligibilitySchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentSchedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleBase'
- title: unifiedRoleAssignmentSchedule
type: object
properties:
assignmentType:
type: string
description: 'Type of the assignment which can either be Assigned or Activated. Supports $filter (eq, ne).'
nullable: true
memberType:
type: string
description: 'How the assignments is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
activatedUsing:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
additionalProperties:
type: object
microsoft.graph.roleAssignmentScheduleRequestFilterByCurrentUserOptions:
title: roleAssignmentScheduleRequestFilterByCurrentUserOptions
enum:
- principal
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.roleAssignmentScheduleFilterByCurrentUserOptions:
title: roleAssignmentScheduleFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.roleEligibilityScheduleInstanceFilterByCurrentUserOptions:
title: roleEligibilityScheduleInstanceFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.unifiedRoleEligibilityScheduleRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.request'
- title: unifiedRoleEligibilityScheduleRequest
type: object
properties:
action:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleScheduleRequestActions'
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of a role eligibility determines the set of resources for which the principal is eligible to access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, ne, and on null values).'
nullable: true
directoryScopeId:
type: string
description: 'Identifier of the directory object representing the scope of the role eligibility. The scope of a role eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, ne, and on null values).'
nullable: true
isValidationOnly:
type: boolean
description: Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
nullable: true
justification:
type: string
description: A message provided by users and administrators when create they create the unifiedRoleEligibilityScheduleRequest object.
nullable: true
principalId:
type: string
description: 'Identifier of the principal that has been granted the role eligibility. Can be a user or a role-assignable group. You can grant only active assignments service principals.Supports $filter (eq, ne).'
nullable: true
roleDefinitionId:
type: string
description: 'Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports $filter (eq, ne).'
nullable: true
scheduleInfo:
$ref: '#/components/schemas/microsoft.graph.requestSchedule'
targetScheduleId:
type: string
description: 'Identifier of the schedule object that''s linked to the eligibility request. Supports $filter (eq, ne).'
nullable: true
ticketInfo:
$ref: '#/components/schemas/microsoft.graph.ticketInfo'
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
targetSchedule:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
additionalProperties:
type: object
microsoft.graph.roleEligibilityScheduleRequestFilterByCurrentUserOptions:
title: roleEligibilityScheduleRequestFilterByCurrentUserOptions
enum:
- principal
- createdBy
- approver
- unknownFutureValue
type: string
microsoft.graph.roleEligibilityScheduleFilterByCurrentUserOptions:
title: roleEligibilityScheduleFilterByCurrentUserOptions
enum:
- principal
- unknownFutureValue
type: string
microsoft.graph.entity:
title: entity
type: object
properties:
id:
type: string
description: The unique idenfier for an entity. Read-only.
additionalProperties:
type: object
microsoft.graph.termsExpiration:
title: termsExpiration
type: object
properties:
frequency:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'Represents the frequency at which the terms will expire, after its first expiration as set in startDateTime. The value is represented in ISO 8601 format for durations. For example, PT1M represents a time period of 1 month.'
format: duration
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The DateTime when the agreement is set to expire for all users. 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.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementAcceptanceState:
title: agreementAcceptanceState
enum:
- accepted
- declined
- unknownFutureValue
type: string
microsoft.graph.agreementFileProperties:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: agreementFileProperties
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date time representing when the file 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.'
format: date-time
nullable: true
displayName:
type: string
description: Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
nullable: true
fileData:
$ref: '#/components/schemas/microsoft.graph.agreementFileData'
fileName:
type: string
description: 'Name of the agreement file (for example, TOU.pdf). Read-only.'
nullable: true
isDefault:
type: boolean
description: 'If none of the languages matches the client preference, indicates whether this is the default agreement file . If none of the files are marked as default, the first one is treated as the default. Read-only.'
nullable: true
isMajorVersion:
type: boolean
description: Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
nullable: true
language:
type: string
description: 'The language of the agreement file in the format ''languagecode2-country/regioncode2''. ''languagecode2'' is a lowercase two-letter code derived from ISO 639-1, while ''country/regioncode2'' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.'
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewNotificationRecipientItem:
title: accessReviewNotificationRecipientItem
type: object
properties:
notificationRecipientScope:
$ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientScope'
notificationTemplateType:
type: string
description: 'Indicates the type of access review email to be sent. Supported template type is CompletedAdditionalRecipients, which sends review completion notifications to the recipients.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: userIdentity
type: object
properties:
ipAddress:
type: string
description: Indicates the client IP address used by user performing the activity (audit log only).
nullable: true
userPrincipalName:
type: string
description: The userPrincipalName attribute of the user.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewReviewerScope:
title: accessReviewReviewerScope
type: object
properties:
query:
type: string
description: The query specifying who will be the reviewer.
nullable: true
queryRoot:
type: string
description: 'In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.'
nullable: true
queryType:
type: string
description: The type of query. Examples include MicrosoftGraph and ARM.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewScope:
title: accessReviewScope
type: object
additionalProperties:
type: object
microsoft.graph.accessReviewScheduleSettings:
title: accessReviewScheduleSettings
type: object
properties:
applyActions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewApplyAction'
description: 'Optional field. Describes the actions to take once a review is complete. There are two types that are currently supported: removeAccessApplyAction (default) and disableAndDeleteUserApplyAction. Field only needs to be specified in the case of disableAndDeleteUserApplyAction.'
autoApplyDecisionsEnabled:
type: boolean
description: 'Indicates whether decisions are automatically applied. When set to false, an admin must apply the decisions manually once the reviewer completes the access review. When set to true, decisions are applied automatically after the access review instance duration ends, whether or not the reviewers have responded. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.'
decisionHistoriesForReviewersEnabled:
type: boolean
description: 'Indicates whether decisions on previous access review stages are available for reviewers on an accessReviewInstance with multiple subsequent stages. If not provided, the default is disabled (false).'
nullable: true
defaultDecision:
type: string
description: 'Decision chosen if defaultDecisionEnabled is enabled. Can be one of Approve, Deny, or Recommendation.'
nullable: true
defaultDecisionEnabled:
type: boolean
description: 'Indicates whether the default decision is enabled or disabled when reviewers do not respond. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.'
instanceDurationInDays:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Duration of an access review instance in days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its durationInDays setting will be used instead of the value of this property.'
format: int32
justificationRequiredOnApproval:
type: boolean
description: Indicates whether reviewers are required to provide justification with their decision. Default value is false.
mailNotificationsEnabled:
type: boolean
description: Indicates whether emails are enabled or disabled. Default value is false.
recommendationsEnabled:
type: boolean
description: 'Indicates whether decision recommendations are enabled or disabled. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationsEnabled setting will be used instead of the value of this property.'
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderNotificationsEnabled:
type: boolean
description: Indicates whether reminders are enabled or disabled. Default value is false.
additionalProperties:
type: object
microsoft.graph.accessReviewStageSettings:
title: accessReviewStageSettings
type: object
properties:
decisionsThatWillMoveToNextStage:
type: array
items:
type: string
nullable: true
description: 'Indicate which decisions will go to the next stage. Can be a sub-set of Approve, Deny, Recommendation, or NotReviewed. If not provided, all decisions will go to the next stage. Optional.'
dependsOn:
type: array
items:
type: string
description: 'Defines the sequential or parallel order of the stages and depends on the stageId. Only sequential stages are currently supported. For example, if stageId is 2, then dependsOn must be 1. If stageId is 1, do not specify dependsOn. Required if stageId is not 1.'
durationInDays:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'The duration of the stage. Required. NOTE: The cumulative value of this property across all stages 1. Will override the instanceDurationInDays setting on the accessReviewScheduleDefinition object. 2. Cannot exceed the length of one recurrence. That is, if the review recurs weekly, the cumulative durationInDays cannot exceed 7.'
format: int32
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'If provided, the fallback reviewers are asked to complete a review if the primary reviewers do not exist. For example, if managers are selected as reviewers and a principal under review does not have a manager in Azure AD, the fallback reviewers are asked to review that principal. NOTE: The value of this property will override the corresponding setting on the accessReviewScheduleDefinition object.'
recommendationsEnabled:
type: boolean
description: 'Indicates whether showing recommendations to reviewers is enabled. Required. NOTE: The value of this property will override override the corresponding setting on the accessReviewScheduleDefinition object.'
reviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
description: 'Defines who the reviewers are. If none are specified, the review is a self-review (users review their own access). For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will override the corresponding setting on the accessReviewScheduleDefinition.'
stageId:
type: string
description: Unique identifier of the accessReviewStageSettings object. The stageId will be used by the dependsOn property to indicate the order of the stages. Required.
additionalProperties:
type: object
microsoft.graph.identity:
title: identity
type: object
properties:
displayName:
type: string
description: 'The display name of the identity. Note that this might not always be available or up to date. For example, if a user changes their display name, the API might show the new value in a future response, but the items associated with the user won''t show up as having changed when using delta.'
nullable: true
id:
type: string
description: Unique identifier for the identity.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItemResource:
title: accessReviewInstanceDecisionItemResource
type: object
properties:
displayName:
type: string
description: Display name of the resource
nullable: true
id:
type: string
description: Identifier of the resource
nullable: true
type:
type: string
description: 'Type of resource. Types include: Group, ServicePrincipal, DirectoryRole, AzureRole, AccessPackageAssignmentPolicy.'
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryDecisionFilter:
title: accessReviewHistoryDecisionFilter
enum:
- approve
- deny
- notReviewed
- dontKnow
- notNotified
- unknownFutureValue
type: string
microsoft.graph.accessReviewHistoryScheduleSettings:
title: accessReviewHistoryScheduleSettings
type: object
properties:
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reportRange:
type: string
description: 'A duration string in ISO 8601 duration format specifying the lookback period of the generated review history data. For example, if a history definition is scheduled to run on the 1st of every month, the reportRange is P1M. In this case, on the first of every month, access review history data will be collected containing only the previous month''s review data. Note: Only years, months, and days ISO 8601 properties are supported. Required.'
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryStatus:
title: accessReviewHistoryStatus
enum:
- done
- inprogress
- error
- requested
- unknownFutureValue
type: string
microsoft.graph.appConsentRequestScope:
title: appConsentRequestScope
type: object
properties:
displayName:
type: string
description: The name of the scope.
nullable: true
additionalProperties:
type: object
microsoft.graph.request:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: request
type: object
properties:
approvalId:
type: string
description: The identifier of the approval of the request.
nullable: true
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The request completion date time.
format: date-time
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The request creation date time.
format: date-time
nullable: true
customData:
type: string
description: Free text field to define any custom data for the request. Not used.
nullable: true
status:
type: string
description: 'The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.'
additionalProperties:
type: object
microsoft.graph.group:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: group
type: object
properties:
assignedLabels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLabel'
description: 'The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select.'
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.
classification:
type: string
description: 'Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group 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. Returned by default. Read-only.'
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.'
nullable: true
displayName:
type: string
description: 'The display name for the group. This property is required when a group is created and cannot 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), $search, and $orderBy.'
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of when the group is set to expire. Is null for security groups but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. 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. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
groupTypes:
type: array
items:
type: string
description: 'Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it''s either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).'
hasMembersWithLicenseErrors:
type: boolean
description: 'Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).'
nullable: true
isAssignableToRole:
type: boolean
description: 'Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignmentsUsing this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).'
nullable: true
licenseProcessingState:
$ref: '#/components/schemas/microsoft.graph.licenseProcessingState'
mail:
type: string
description: 'The SMTP address for the group, for example, ''[email protected]''. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mailEnabled:
type: boolean
description: 'Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).'
nullable: true
mailNickname:
type: string
description: 'The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / [] '' ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
membershipRule:
type: string
description: 'The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
nullable: true
membershipRuleProcessingState:
type: string
description: 'Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
onPremisesDomainName:
type: string
nullable: true
onPremisesLastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Indicates the last time at which the group 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. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesNetBiosName:
type: string
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).'
onPremisesSamAccountName:
type: string
description: 'Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.'
nullable: true
onPremisesSecurityIdentifier:
type: string
description: Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only.
nullable: true
onPremisesSyncEnabled:
type: boolean
description: 'true if this group is synced from an on-premises directory; false if this group 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). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator''s preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
proxyAddresses:
type: array
items:
type: string
description: 'Email addresses for the group that direct to the same group mailbox. For example: [''SMTP: [email protected]'', ''smtp: [email protected]'']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
renewedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. 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. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
securityEnabled:
type: boolean
description: 'Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
securityIdentifier:
type: string
description: 'Security identifier of the group, used in Windows scenarios. Returned by default.'
nullable: true
theme:
type: string
description: 'Specifies a Microsoft 365 group''s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.'
nullable: true
visibility:
type: string
description: 'Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can''t be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more. Returned by default. Nullable.'
nullable: true
allowExternalSenders:
type: boolean
description: 'Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
autoSubscribeNewMembers:
type: boolean
description: 'Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
hideFromAddressLists:
type: boolean
description: 'True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
hideFromOutlookClients:
type: boolean
description: 'True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
isSubscribedByMail:
type: boolean
description: 'Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
unseenCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
format: int32
nullable: true
isArchived:
type: boolean
description: 'When a group is associated with a team this property determines whether the team is in read-only mode.To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.'
nullable: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a group has been granted for an application. Supports $expand.
x-ms-navigationProperty: true
createdOnBehalfOf:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
membersWithLicenseErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: A list of group members with license errors from this group-based license assignment. Read-only.
x-ms-navigationProperty: true
owners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The owners of the group. Limited to 100 owners. Nullable. If this property is not specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
permissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
description: The permission that has been granted for a group to a specific application. Supports $expand.
x-ms-navigationProperty: true
settings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupSetting'
description: 'Settings that can govern this group''s behavior, like whether members can invite guest users to the group. Nullable.'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups that a group is a member of, either directly and through nested membership. Nullable.'
x-ms-navigationProperty: true
transitiveMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The direct and transitive members of a group. Nullable.
x-ms-navigationProperty: true
acceptedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post.
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only.
x-ms-navigationProperty: true
conversations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversation'
description: The group's conversations.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The group's calendar events.
x-ms-navigationProperty: true
rejectedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
x-ms-navigationProperty: true
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: The group's conversation threads. Nullable.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The group's drives. Read-only.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The list of SharePoint sites in this group. Access the default site with /sites/root.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the group. Read-only. Nullable.
x-ms-navigationProperty: true
groupLifecyclePolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
description: The collection of lifecycle policies for this group. Read-only. Nullable.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerGroup'
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
description: The profile photos owned by the group. Read-only. Nullable.
x-ms-navigationProperty: true
team:
$ref: '#/components/schemas/microsoft.graph.team'
additionalProperties:
type: object
microsoft.graph.allowedTargetScope:
title: allowedTargetScope
enum:
- notSpecified
- specificDirectoryUsers
- specificConnectedOrganizationUsers
- specificDirectoryServicePrincipals
- allMemberUsers
- allDirectoryUsers
- allDirectoryServicePrincipals
- allConfiguredConnectedOrganizationUsers
- allExternalUsers
- unknownFutureValue
type: string
microsoft.graph.accessPackageAutomaticRequestSettings:
title: accessPackageAutomaticRequestSettings
type: object
properties:
gracePeriodBeforeAccessRemoval:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
format: duration
nullable: true
removeAccessWhenTargetLeavesAllowedTargets:
type: boolean
nullable: true
requestAccessForAllowedTargets:
type: boolean
description: 'If set to true, automatic assignments will be created for targets in the allowed target scope.'
nullable: true
additionalProperties:
type: object
microsoft.graph.expirationPattern:
title: expirationPattern
type: object
properties:
duration:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'The requestor''s desired duration of access represented in ISO 8601 format for durations. For example, PT3H refers to three hours. If specified in a request, endDateTime should not be present and the type property should be set to afterDuration.'
format: duration
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Timestamp of 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.'
format: date-time
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.expirationPatternType'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentApprovalSettings:
title: accessPackageAssignmentApprovalSettings
type: object
properties:
isApprovalRequiredForAdd:
type: boolean
description: 'If false, then approval is not required for new requests in this policy.'
nullable: true
isApprovalRequiredForUpdate:
type: boolean
description: 'If false, then approval is not required for updates to requests in this policy.'
nullable: true
stages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageApprovalStage'
description: 'If approval is required, the one, two or three elements of this collection define each of the stages of approval. An empty array is present if no approval is required.'
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestorSettings:
title: accessPackageAssignmentRequestorSettings
type: object
properties:
allowCustomAssignmentSchedule:
type: boolean
description: False indicates that the requestor is not permitted to include a schedule in their request.
nullable: true
enableOnBehalfRequestorsToAddAccess:
type: boolean
description: True allows on-behalf-of requestors to create a request to add access for another principal.
nullable: true
enableOnBehalfRequestorsToRemoveAccess:
type: boolean
description: True allows on-behalf-of requestors to create a request to remove access for another principal.
nullable: true
enableOnBehalfRequestorsToUpdateAccess:
type: boolean
description: True allows on-behalf-of requestors to create a request to update access for another principal.
nullable: true
enableTargetsToSelfAddAccess:
type: boolean
description: True allows requestors to create a request to add access for themselves.
nullable: true
enableTargetsToSelfRemoveAccess:
type: boolean
description: True allows requestors to create a request to remove their access.
nullable: true
enableTargetsToSelfUpdateAccess:
type: boolean
description: True allows requestors to create a request to update their access.
nullable: true
onBehalfRequestors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: The principals who can request on-behalf-of others.
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentReviewSettings:
title: accessPackageAssignmentReviewSettings
type: object
properties:
expirationBehavior:
$ref: '#/components/schemas/microsoft.graph.accessReviewExpirationBehavior'
fallbackReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: This collection specifies the users who will be the fallback reviewers when the primary reviewers don't respond.
isEnabled:
type: boolean
description: 'If true, access reviews are required for assignments through this policy.'
nullable: true
isRecommendationEnabled:
type: boolean
description: Specifies whether to display recommendations to the reviewer. The default value is true.
nullable: true
isReviewerJustificationRequired:
type: boolean
description: Specifies whether the reviewer must provide justification for the approval. The default value is true.
nullable: true
isSelfReview:
type: boolean
description: Specifies whether the principals can review their own assignments.
nullable: true
primaryReviewers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: This collection specifies the users or group of users who will review the access package assignments.
schedule:
$ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule'
additionalProperties:
type: object
microsoft.graph.subjectSet:
title: subjectSet
type: object
additionalProperties:
type: object
microsoft.graph.accessPackageCatalogType:
title: accessPackageCatalogType
enum:
- userManaged
- serviceDefault
- serviceManaged
- unknownFutureValue
type: string
microsoft.graph.accessPackageCatalogState:
title: accessPackageCatalogState
enum:
- unpublished
- published
- unknownFutureValue
type: string
microsoft.graph.accessPackageLocalizedText:
title: accessPackageLocalizedText
type: object
properties:
languageCode:
type: string
description: 'The language code that text is in. 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. Required.'
text:
type: string
description: The question in the specific language. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.entitlementManagementSchedule:
title: entitlementManagementSchedule
type: object
properties:
expiration:
$ref: '#/components/schemas/microsoft.graph.expirationPattern'
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAnswer:
title: accessPackageAnswer
type: object
properties:
displayValue:
type: string
description: The localized display value shown to the requestor and approvers.
nullable: true
answeredQuestion:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
additionalProperties:
type: object
microsoft.graph.accessPackageRequestType:
title: accessPackageRequestType
enum:
- notSpecified
- userAdd
- userUpdate
- userRemove
- adminAdd
- adminUpdate
- adminRemove
- systemAdd
- systemUpdate
- systemRemove
- onBehalfAdd
- unknownFutureValue
type: string
microsoft.graph.accessPackageRequestState:
title: accessPackageRequestState
enum:
- submitted
- pendingApproval
- delivering
- delivered
- deliveryFailed
- denied
- scheduled
- canceled
- partiallyDelivered
- unknownFutureValue
type: string
microsoft.graph.accessPackageAssignmentState:
title: accessPackageAssignmentState
enum:
- delivering
- partiallyDelivered
- delivered
- expired
- deliveryFailed
- unknownFutureValue
type: string
microsoft.graph.accessPackageSubjectType:
title: accessPackageSubjectType
enum:
- notSpecified
- user
- servicePrincipal
- unknownFutureValue
type: string
microsoft.graph.identitySource:
title: identitySource
type: object
additionalProperties:
type: object
microsoft.graph.connectedOrganizationState:
title: connectedOrganizationState
enum:
- configured
- proposed
- unknownFutureValue
type: string
microsoft.graph.accessPackageExternalUserLifecycleAction:
title: accessPackageExternalUserLifecycleAction
enum:
- none
- blockSignIn
- blockSignInAndDelete
- unknownFutureValue
type: string
microsoft.graph.unifiedRolePermission:
title: unifiedRolePermission
type: object
properties:
allowedResourceActions:
type: array
items:
type: string
description: Set of tasks that can be performed on a resource. Required.
condition:
type: string
description: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.
nullable: true
excludedResourceActions:
type: array
items:
type: string
nullable: true
description: Set of tasks that may not be performed on a resource. Not yet supported.
additionalProperties:
type: object
microsoft.graph.unifiedRoleScheduleInstanceBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleScheduleInstanceBase
type: object
properties:
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.'
nullable: true
directoryScopeId:
type: string
description: Identifier of the directory object representing the scope of the assignment or role eligibility. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.
nullable: true
principalId:
type: string
description: Identifier of the principal that has been granted the role assignment or that's eligible for a role.
nullable: true
roleDefinitionId:
type: string
description: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that the principal is eligible for.
nullable: true
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
additionalProperties:
type: object
microsoft.graph.unifiedRoleScheduleRequestActions:
title: unifiedRoleScheduleRequestActions
enum:
- adminAssign
- adminUpdate
- adminRemove
- selfActivate
- selfDeactivate
- adminExtend
- adminRenew
- selfExtend
- selfRenew
- unknownFutureValue
type: string
microsoft.graph.requestSchedule:
title: requestSchedule
type: object
properties:
expiration:
$ref: '#/components/schemas/microsoft.graph.expirationPattern'
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the eligible or active assignment becomes active.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.ticketInfo:
title: ticketInfo
type: object
properties:
ticketNumber:
type: string
description: The ticket number.
nullable: true
ticketSystem:
type: string
description: The description of the ticket system.
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleScheduleBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: unifiedRoleScheduleBase
type: object
properties:
appScopeId:
type: string
description: 'Identifier of the app-specific scope when the assignment or eligibility is scoped to an app. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule was created.
format: date-time
nullable: true
createdUsing:
type: string
description: Identifier of the object through which this schedule was created.
nullable: true
directoryScopeId:
type: string
description: Identifier of the directory object representing the scope of the assignment or eligibility. The scope of an assignment or eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.
nullable: true
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the schedule was last modified.
format: date-time
nullable: true
principalId:
type: string
description: Identifier of the principal that has been granted the role assignment or eligibility.
nullable: true
roleDefinitionId:
type: string
description: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that a principal is eligible for.
nullable: true
status:
type: string
description: The status of the role assignment or eligibility request.
nullable: true
appScope:
$ref: '#/components/schemas/microsoft.graph.appScope'
directoryScope:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
principal:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
roleDefinition:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
additionalProperties:
type: object
ReferenceCreate:
type: object
properties:
'@odata.id':
type: string
additionalProperties:
type: object
microsoft.graph.agreementCollectionResponse:
title: Collection of agreement
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreement'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.ODataError:
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
additionalProperties:
type: object
microsoft.graph.agreementAcceptanceCollectionResponse:
title: Collection of agreementAcceptance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
ODataCountResponse:
type: integer
format: int32
microsoft.graph.agreementFileLocalizationCollectionResponse:
title: Collection of agreementFileLocalization
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalization'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementFileVersionCollectionResponse:
title: Collection of agreementFileVersion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewScheduleDefinitionCollectionResponse:
title: Collection of accessReviewScheduleDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceCollectionResponse:
title: Collection of accessReviewInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewReviewerCollectionResponse:
title: Collection of accessReviewReviewer
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewInstanceDecisionItemCollectionResponse:
title: Collection of accessReviewInstanceDecisionItem
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewStageCollectionResponse:
title: Collection of accessReviewStage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewStage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryDefinitionCollectionResponse:
title: Collection of accessReviewHistoryDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewHistoryInstanceCollectionResponse:
title: Collection of accessReviewHistoryInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.appConsentRequestCollectionResponse:
title: Collection of appConsentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appConsentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.userConsentRequestCollectionResponse:
title: Collection of userConsentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userConsentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.approvalStageCollectionResponse:
title: Collection of approvalStage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approvalStage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.approvalCollectionResponse:
title: Collection of approval
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.approval'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageCollectionResponse:
title: Collection of accessPackage
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackage'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentPolicyCollectionResponse:
title: Collection of accessPackageAssignmentPolicy
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageQuestionCollectionResponse:
title: Collection of accessPackageQuestion
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestion'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
StringCollectionResponse:
title: Collection of string
type: object
properties:
value:
type: array
items:
type: string
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.groupCollectionResponse:
title: Collection of group
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.group'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentRequestCollectionResponse:
title: Collection of accessPackageAssignmentRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageAssignmentCollectionResponse:
title: Collection of accessPackageAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.accessPackageCatalogCollectionResponse:
title: Collection of accessPackageCatalog
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalog'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.connectedOrganizationCollectionResponse:
title: Collection of connectedOrganization
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.connectedOrganization'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.directoryObjectCollectionResponse:
title: Collection of directoryObject
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceNamespaceCollectionResponse:
title: Collection of unifiedRbacResourceNamespace
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespace'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRbacResourceActionCollectionResponse:
title: Collection of unifiedRbacResourceAction
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceAction'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentCollectionResponse:
title: Collection of unifiedRoleAssignment
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignment'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleInstanceCollectionResponse:
title: Collection of unifiedRoleAssignmentScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleRequestCollectionResponse:
title: Collection of unifiedRoleAssignmentScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleAssignmentScheduleCollectionResponse:
title: Collection of unifiedRoleAssignmentSchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentSchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleDefinitionCollectionResponse:
title: Collection of unifiedRoleDefinition
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinition'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleInstanceCollectionResponse:
title: Collection of unifiedRoleEligibilityScheduleInstance
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstance'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleRequestCollectionResponse:
title: Collection of unifiedRoleEligibilityScheduleRequest
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequest'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.unifiedRoleEligibilityScheduleCollectionResponse:
title: Collection of unifiedRoleEligibilitySchedule
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilitySchedule'
'@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.agreementFileData:
title: agreementFileData
type: object
properties:
data:
type: string
description: Data that represents the terms of use PDF document. Read-only.
format: base64url
nullable: true
additionalProperties:
type: object
microsoft.graph.accessReviewNotificationRecipientScope:
title: accessReviewNotificationRecipientScope
type: object
additionalProperties:
type: object
microsoft.graph.accessReviewApplyAction:
title: accessReviewApplyAction
type: object
additionalProperties:
type: object
microsoft.graph.patternedRecurrence:
title: patternedRecurrence
type: object
properties:
pattern:
$ref: '#/components/schemas/microsoft.graph.recurrencePattern'
range:
$ref: '#/components/schemas/microsoft.graph.recurrenceRange'
additionalProperties:
type: object
microsoft.graph.identitySet:
title: identitySet
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
device:
$ref: '#/components/schemas/microsoft.graph.identity'
user:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.assignedLabel:
title: assignedLabel
type: object
properties:
displayName:
type: string
description: The display name of the label. Read-only.
nullable: true
labelId:
type: string
description: The unique identifier of the label.
nullable: true
additionalProperties:
type: object
microsoft.graph.assignedLicense:
title: assignedLicense
type: object
properties:
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
description: A collection of the unique identifiers for plans that have been disabled.
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier for the SKU.
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.licenseProcessingState:
title: licenseProcessingState
type: object
properties:
state:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.onPremisesProvisioningError:
title: onPremisesProvisioningError
type: object
properties:
category:
type: string
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.'
nullable: true
occurredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time at which the error occurred.
format: date-time
nullable: true
propertyCausingError:
type: string
description: 'Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress'
nullable: true
value:
type: string
description: Value of the property causing the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.appRoleAssignment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: appRoleAssignment
type: object
properties:
appRoleId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: 'The identifier (id) for the app role which is 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 has not 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.'
format: uuid
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
principalDisplayName:
type: string
description: 'The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).'
nullable: true
principalId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
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.'
format: uuid
nullable: true
principalType:
type: string
description: 'The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.'
nullable: true
resourceDisplayName:
type: string
description: The display name of the resource app's service principal to which the assignment is made.
nullable: true
resourceId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.resourceSpecificPermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: resourceSpecificPermissionGrant
type: object
properties:
clientAppId:
type: string
description: ID of the service principal of the Azure AD app that has been granted access. Read-only.
nullable: true
clientId:
type: string
description: ID of the Azure AD app that has been granted access. Read-only.
nullable: true
permission:
type: string
description: The name of the resource-specific permission. Read-only.
nullable: true
permissionType:
type: string
description: 'The type of permission. Possible values are: Application, Delegated. Read-only.'
nullable: true
resourceAppId:
type: string
description: ID of the Azure AD app that is hosting the resource. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.groupSetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupSetting
type: object
properties:
displayName:
type: string
description: 'Display name of this group of settings, which comes from the associated template.'
nullable: true
templateId:
type: string
description: Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
nullable: true
values:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingValue'
description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.
additionalProperties:
type: object
microsoft.graph.calendar:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendar
type: object
properties:
allowedOnlineMeetingProviders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
canEdit:
type: boolean
description: 'true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who has been shared a calendar and granted write access.'
nullable: true
canShare:
type: boolean
description: 'true if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it.'
nullable: true
canViewPrivateItems:
type: boolean
description: 'true if the user can read calendar items that have been marked private, false otherwise.'
nullable: true
changeKey:
type: string
description: 'Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
color:
$ref: '#/components/schemas/microsoft.graph.calendarColor'
defaultOnlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
hexColor:
type: string
description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.'
nullable: true
isDefaultCalendar:
type: boolean
description: 'true if this is the default calendar where new events are created by default, false otherwise.'
nullable: true
isRemovable:
type: boolean
description: Indicates whether this user calendar can be deleted from the user mailbox.
nullable: true
isTallyingResponses:
type: boolean
description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
nullable: true
name:
type: string
description: The calendar name.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
calendarPermissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarPermission'
description: The permissions of the users with whom the calendar is shared.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The events in the calendar. Navigation property. Read-only.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.event:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: event
type: object
properties:
allowNewTimeProposals:
type: boolean
description: 'true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. Default is true.'
nullable: true
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendee'
description: The collection of attendees for the event.
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The preview of the message associated with the event. It is in text format.
nullable: true
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
hasAttachments:
type: boolean
description: Set to true if the event has attachments.
nullable: true
hideAttendees:
type: boolean
description: 'When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.'
nullable: true
iCalUId:
type: string
description: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isAllDay:
type: boolean
nullable: true
isCancelled:
type: boolean
nullable: true
isDraft:
type: boolean
nullable: true
isOnlineMeeting:
type: boolean
nullable: true
isOrganizer:
type: boolean
nullable: true
isReminderOn:
type: boolean
nullable: true
location:
$ref: '#/components/schemas/microsoft.graph.location'
locations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
onlineMeeting:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo'
onlineMeetingProvider:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
onlineMeetingUrl:
type: string
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.recipient'
originalEndTimeZone:
type: string
nullable: true
originalStart:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
originalStartTimeZone:
type: string
nullable: true
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderMinutesBeforeStart:
maximum: 2147483647
minimum: -2147483648
type: integer
format: int32
nullable: true
responseRequested:
type: boolean
nullable: true
responseStatus:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
seriesMasterId:
type: string
nullable: true
showAs:
$ref: '#/components/schemas/microsoft.graph.freeBusyStatus'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
subject:
type: string
nullable: true
transactionId:
type: string
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.eventType'
webLink:
type: string
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the event. Nullable.
x-ms-navigationProperty: true
instances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions that have been modified, but does not include occurrences that have been cancelled from the series. Navigation property. Read-only. Nullable.'
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the event. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.conversation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversation
type: object
properties:
hasAttachments:
type: boolean
description: 'Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.'
lastDeliveredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
preview:
type: string
description: 'A short summary from the body of the latest post in this conversation. Supports $filter (eq, ne, le, ge).'
topic:
type: string
description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.'
uniqueSenders:
type: array
items:
type: string
description: All the users that sent a message to this Conversation.
threads:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationThread'
description: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.conversationThread:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationThread
type: object
properties:
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the thread. Returned only on $select.'
hasAttachments:
type: boolean
description: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.
isLocked:
type: boolean
description: Indicates if the thread is locked. Returned by default.
lastDeliveredDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.Returned by default.'
format: date-time
preview:
type: string
description: A short summary from the body of the latest post in this conversation. Returned by default.
topic:
type: string
description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.'
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The To: recipients for the thread. Returned only on $select.'
uniqueSenders:
type: array
items:
type: string
description: All the users that sent a message to this thread. Returned by default.
posts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.post'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.drive:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: drive
type: object
properties:
driveType:
type: string
description: Describes the type of drive represented by this resource. OneDrive personal drives will return personal. OneDrive for Business will return business. SharePoint document libraries will return documentLibrary. Read-only.
nullable: true
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
quota:
$ref: '#/components/schemas/microsoft.graph.quota'
sharePointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
bundles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: 'Collection of [bundles][bundle] (albums and multi-select-shared sets of items). Only in personal OneDrive.'
x-ms-navigationProperty: true
following:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: The list of items the user is following. Only in OneDrive for Business.
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: All items contained in the drive. Read-only. Nullable.
x-ms-navigationProperty: true
list:
$ref: '#/components/schemas/microsoft.graph.list'
root:
$ref: '#/components/schemas/microsoft.graph.driveItem'
special:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection of common folders available in OneDrive. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: site
type: object
properties:
displayName:
type: string
description: The full title for the site. Read-only.
nullable: true
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
root:
$ref: '#/components/schemas/microsoft.graph.root'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteCollection:
$ref: '#/components/schemas/microsoft.graph.siteCollection'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions reusable across lists under this site.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types defined for this site.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: The collection of drives (document libraries) under this site.
x-ms-navigationProperty: true
externalColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.baseItem'
description: Used to address any item contained in this site. This collection can't be enumerated.
x-ms-navigationProperty: true
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.list'
description: The collection of lists under this site.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the site.
x-ms-navigationProperty: true
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The permissions associated with the site. Nullable.
x-ms-navigationProperty: true
sites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
description: The collection of the sub-sites under this site.
x-ms-navigationProperty: true
termStore:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
termStores:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
description: The collection of termStores under this site.
x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
additionalProperties:
type: object
microsoft.graph.extension:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: extension
type: object
additionalProperties:
type: object
microsoft.graph.groupLifecyclePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: groupLifecyclePolicy
type: object
properties:
alternateNotificationEmails:
type: string
description: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.
nullable: true
groupLifetimeInDays:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.'
format: int32
nullable: true
managedGroupTypes:
type: string
description: 'The group type for which the expiration policy applies. Possible values are All, Selected or None.'
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerGroup
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerPlans owned by the group.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenote:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenote
type: object
properties:
notebooks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.notebook'
description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteOperation'
description: 'The status of OneNote operations. Getting an operations collection is not supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.'
x-ms-navigationProperty: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
resources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteResource'
description: 'The image and other file resources in OneNote pages. Getting a resources collection is not supported, but you can get the binary content of a specific resource. Read-only. Nullable.'
x-ms-navigationProperty: true
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The height of the photo. Read-only.
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The width of the photo. Read-only.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.team:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: team
type: object
properties:
classification:
type: string
description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp at which the team was created.
format: date-time
nullable: true
description:
type: string
description: 'An optional description for the team. Maximum length: 1024 characters.'
nullable: true
displayName:
type: string
description: The name of the team.
nullable: true
funSettings:
$ref: '#/components/schemas/microsoft.graph.teamFunSettings'
guestSettings:
$ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
internalId:
type: string
description: A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
nullable: true
isArchived:
type: boolean
description: Whether this team is in read-only mode.
nullable: true
memberSettings:
$ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
messagingSettings:
$ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
specialization:
$ref: '#/components/schemas/microsoft.graph.teamSpecialization'
summary:
$ref: '#/components/schemas/microsoft.graph.teamSummary'
tenantId:
type: string
description: The ID of the Azure Active Directory tenant.
nullable: true
visibility:
$ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
webUrl:
type: string
description: 'A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.'
nullable: true
allChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels either hosted in or shared with the team (incoming channels).
x-ms-navigationProperty: true
channels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: The collection of channels and messages associated with the team.
x-ms-navigationProperty: true
group:
$ref: '#/components/schemas/microsoft.graph.group'
incomingChannels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.channel'
description: List of channels shared with the team.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: The apps installed in this team.
x-ms-navigationProperty: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: Members and owners of the team.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
description: The async operations that ran or are running on this team.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
primaryChannel:
$ref: '#/components/schemas/microsoft.graph.channel'
tags:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTag'
description: The tags associated with the team.
x-ms-navigationProperty: true
template:
$ref: '#/components/schemas/microsoft.graph.teamsTemplate'
schedule:
$ref: '#/components/schemas/microsoft.graph.schedule'
additionalProperties:
type: object
microsoft.graph.expirationPatternType:
title: expirationPatternType
enum:
- notSpecified
- noExpiration
- afterDateTime
- afterDuration
type: string
microsoft.graph.accessPackageApprovalStage:
title: accessPackageApprovalStage
type: object
properties:
durationBeforeAutomaticDenial:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: The number of days that a request can be pending a response before it is automatically denied.
format: duration
nullable: true
durationBeforeEscalation:
pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
type: string
description: 'If escalation is required, the time a request can be pending a response from a primary approver.'
format: duration
nullable: true
escalationApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'If escalation is enabled and the primary approvers do not respond before the escalation time, the escalationApprovers are the users who will be asked to approve requests.'
fallbackEscalationApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'The subjects, typically users, who are the fallback escalation approvers.'
fallbackPrimaryApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'The subjects, typically users, who are the fallback primary approvers.'
isApproverJustificationRequired:
type: boolean
description: Indicates whether the approver is required to provide a justification for approving a request.
nullable: true
isEscalationEnabled:
type: boolean
description: 'If true, then one or more escalationApprovers are configured in this approval stage.'
nullable: true
primaryApprovers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subjectSet'
description: 'The subjects, typically users, who will be asked to approve requests. A collection of singleUser, groupMembers, requestorManager, internalSponsors or externalSponsors.'
additionalProperties:
type: object
microsoft.graph.accessReviewExpirationBehavior:
title: accessReviewExpirationBehavior
enum:
- keepAccess
- removeAccess
- acceptAccessRecommendation
- unknownFutureValue
type: string
microsoft.graph.ODataErrors.MainError:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
innererror:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
additionalProperties:
type: object
microsoft.graph.recurrencePattern:
title: recurrencePattern
type: object
properties:
dayOfMonth:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.
format: int32
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
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.'
firstDayOfWeek:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
index:
$ref: '#/components/schemas/microsoft.graph.weekIndex'
interval:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.'
format: int32
month:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The month in which the event occurs. This is a number from 1 to 12.
format: int32
type:
$ref: '#/components/schemas/microsoft.graph.recurrencePatternType'
additionalProperties:
type: object
microsoft.graph.recurrenceRange:
title: recurrenceRange
type: object
properties:
endDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
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.'
format: date
nullable: true
numberOfOccurrences:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of times to repeat the event. Required and must be positive if type is numbered.
format: int32
recurrenceTimeZone:
type: string
description: 'Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.'
nullable: true
startDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
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.'
format: date
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.recurrenceRangeType'
additionalProperties:
type: object
microsoft.graph.settingValue:
title: settingValue
type: object
properties:
name:
type: string
description: Name of the setting (as defined by the groupSettingTemplate).
nullable: true
value:
type: string
description: Value of the setting.
nullable: true
additionalProperties:
type: object
microsoft.graph.onlineMeetingProviderType:
title: onlineMeetingProviderType
enum:
- unknown
- skypeForBusiness
- skypeForConsumer
- teamsForBusiness
type: string
microsoft.graph.calendarColor:
title: calendarColor
enum:
- auto
- lightBlue
- lightGreen
- lightOrange
- lightGray
- lightYellow
- lightTeal
- lightPink
- lightBrown
- lightRed
- maxColor
type: string
microsoft.graph.emailAddress:
title: emailAddress
type: object
properties:
address:
type: string
description: The email address of the person or entity.
nullable: true
name:
type: string
description: The display name of the person or entity.
nullable: true
additionalProperties:
type: object
microsoft.graph.calendarPermission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarPermission
type: object
properties:
allowedRoles:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
description: 'List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.'
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
isInsideOrganization:
type: boolean
description: True if the user in context (sharee or delegate) is inside the same organization as the calendar owner.
nullable: true
isRemovable:
type: boolean
description: 'True if the user can be removed from the list of sharees or delegates for the specified calendar, false otherwise. The ''My organization'' user determines the permissions other people within your organization have to the given calendar. You cannot remove ''My organization'' as a sharee to a calendar.'
nullable: true
role:
$ref: '#/components/schemas/microsoft.graph.calendarRoleType'
additionalProperties:
type: object
microsoft.graph.multiValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: multiValueLegacyExtendedProperty
type: object
properties:
value:
type: array
items:
type: string
nullable: true
description: A collection of property values.
additionalProperties:
type: object
microsoft.graph.singleValueLegacyExtendedProperty:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: singleValueLegacyExtendedProperty
type: object
properties:
value:
type: string
description: A property value.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookItem
type: object
properties:
categories:
type: array
items:
type: string
nullable: true
description: The categories associated with the item
changeKey:
type: string
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.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.attendee:
allOf:
- $ref: '#/components/schemas/microsoft.graph.attendeeBase'
- title: attendee
type: object
properties:
proposedNewTime:
$ref: '#/components/schemas/microsoft.graph.timeSlot'
status:
$ref: '#/components/schemas/microsoft.graph.responseStatus'
additionalProperties:
type: object
microsoft.graph.itemBody:
title: itemBody
type: object
properties:
content:
type: string
description: The content of the item.
nullable: true
contentType:
$ref: '#/components/schemas/microsoft.graph.bodyType'
additionalProperties:
type: object
microsoft.graph.dateTimeTimeZone:
title: dateTimeTimeZone
type: object
properties:
dateTime:
type: string
description: 'A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).'
timeZone:
type: string
description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.'
nullable: true
additionalProperties:
type: object
microsoft.graph.importance:
title: importance
enum:
- low
- normal
- high
type: string
microsoft.graph.location:
title: location
type: object
properties:
address:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
coordinates:
$ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates'
displayName:
type: string
description: The name associated with the location.
nullable: true
locationEmailAddress:
type: string
description: Optional email address of the location.
nullable: true
locationType:
$ref: '#/components/schemas/microsoft.graph.locationType'
locationUri:
type: string
description: Optional URI representing the location.
nullable: true
uniqueId:
type: string
description: For internal use only.
nullable: true
uniqueIdType:
$ref: '#/components/schemas/microsoft.graph.locationUniqueIdType'
additionalProperties:
type: object
microsoft.graph.onlineMeetingInfo:
title: onlineMeetingInfo
type: object
properties:
conferenceId:
type: string
description: The ID of the conference.
nullable: true
joinUrl:
type: string
description: The external link that launches the online meeting. This is a URL that clients will launch into a browser and will redirect the user to join the meeting.
nullable: true
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: All of the phone numbers associated with this conference.
quickDial:
type: string
description: The pre-formatted quickdial for this call.
nullable: true
tollFreeNumbers:
type: array
items:
type: string
nullable: true
description: The toll free numbers that can be used to join the conference.
tollNumber:
type: string
description: The toll number that can be used to join the conference.
nullable: true
additionalProperties:
type: object
microsoft.graph.recipient:
title: recipient
type: object
properties:
emailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.responseStatus:
title: responseStatus
type: object
properties:
response:
$ref: '#/components/schemas/microsoft.graph.responseType'
time:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.sensitivity:
title: sensitivity
enum:
- normal
- personal
- private
- confidential
type: string
microsoft.graph.freeBusyStatus:
title: freeBusyStatus
enum:
- unknown
- free
- tentative
- busy
- oof
- workingElsewhere
type: string
microsoft.graph.eventType:
title: eventType
enum:
- singleInstance
- occurrence
- exception
- seriesMaster
type: string
microsoft.graph.attachment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachment
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
isInline:
type: boolean
description: 'true if the attachment is an inline attachment; otherwise, false.'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
name:
type: string
description: The attachment's file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The length of the attachment in bytes.
format: int32
additionalProperties:
type: object
microsoft.graph.post:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: post
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
conversationId:
type: string
description: Unique ID of the conversation. Read-only.
nullable: true
conversationThreadId:
type: string
description: Unique ID of the conversation thread. Read-only.
nullable: true
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
description: Indicates whether the post has at least one attachment. This is a default property.
newParticipants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Conversation participants that were added to the thread as part of this post.
receivedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Specifies when the post was received. The DateTimeOffset 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'
format: date-time
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
inReplyTo:
$ref: '#/components/schemas/microsoft.graph.post'
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the post. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the post. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.baseItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of item creation. Read-only.
format: date-time
description:
type: string
description: Provides a user-visible description of the item. Optional.
nullable: true
eTag:
type: string
description: ETag for the item. Read-only.
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time the item was last modified. Read-only.
format: date-time
name:
type: string
description: The name of the item. Read-write.
nullable: true
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
webUrl:
type: string
description: URL that displays the resource in the browser. Read-only.
nullable: true
createdByUser:
$ref: '#/components/schemas/microsoft.graph.user'
lastModifiedByUser:
$ref: '#/components/schemas/microsoft.graph.user'
additionalProperties:
type: object
microsoft.graph.quota:
title: quota
type: object
properties:
deleted:
type: integer
description: 'Total space consumed by files in the recycle bin, in bytes. Read-only.'
format: int64
nullable: true
remaining:
type: integer
description: 'Total space remaining before reaching the quota limit, in bytes. Read-only.'
format: int64
nullable: true
state:
type: string
description: Enumeration value that indicates the state of the storage space. Read-only.
nullable: true
storagePlanInformation:
$ref: '#/components/schemas/microsoft.graph.storagePlanInformation'
total:
type: integer
description: 'Total allowed storage space, in bytes. Read-only.'
format: int64
nullable: true
used:
type: integer
description: 'Total space used, in bytes. Read-only.'
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.sharepointIds:
title: sharepointIds
type: object
properties:
listId:
type: string
description: The unique identifier (guid) for the item's list in SharePoint.
nullable: true
listItemId:
type: string
description: An integer identifier for the item within the containing list.
nullable: true
listItemUniqueId:
type: string
description: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
nullable: true
siteId:
type: string
description: The unique identifier (guid) for the item's site collection (SPSite).
nullable: true
siteUrl:
type: string
description: The SharePoint URL for the site that contains the item.
nullable: true
tenantId:
type: string
description: The unique identifier (guid) for the tenancy.
nullable: true
webId:
type: string
description: The unique identifier (guid) for the item's site (SPWeb).
nullable: true
additionalProperties:
type: object
microsoft.graph.systemFacet:
title: systemFacet
type: object
additionalProperties:
type: object
microsoft.graph.driveItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: driveItem
type: object
properties:
audio:
$ref: '#/components/schemas/microsoft.graph.audio'
bundle:
$ref: '#/components/schemas/microsoft.graph.bundle'
content:
type: string
description: 'The content stream, if the item represents a file.'
format: base64url
nullable: true
cTag:
type: string
description: An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.
nullable: true
deleted:
$ref: '#/components/schemas/microsoft.graph.deleted'
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
image:
$ref: '#/components/schemas/microsoft.graph.image'
location:
$ref: '#/components/schemas/microsoft.graph.geoCoordinates'
malware:
$ref: '#/components/schemas/microsoft.graph.malware'
package:
$ref: '#/components/schemas/microsoft.graph.package'
pendingOperations:
$ref: '#/components/schemas/microsoft.graph.pendingOperations'
photo:
$ref: '#/components/schemas/microsoft.graph.photo'
publication:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
remoteItem:
$ref: '#/components/schemas/microsoft.graph.remoteItem'
root:
$ref: '#/components/schemas/microsoft.graph.root'
searchResult:
$ref: '#/components/schemas/microsoft.graph.searchResult'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: integer
description: Size of the item in bytes. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: WebDAV compatible URL for the item.
nullable: true
workbook:
$ref: '#/components/schemas/microsoft.graph.workbook'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItem'
description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
x-ms-navigationProperty: true
listItem:
$ref: '#/components/schemas/microsoft.graph.listItem'
permissions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.permission'
description: The set of permissions for the item. Read-only. Nullable.
x-ms-navigationProperty: true
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the item. Only supported on the root of a drive.
x-ms-navigationProperty: true
thumbnails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
description: 'Collection containing [ThumbnailSet][] objects associated with the item. For more info, see [getting thumbnails][]. Read-only. Nullable.'
x-ms-navigationProperty: true
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.driveItemVersion'
description: 'The list of previous versions of the item. For more info, see [getting previous versions][]. Read-only. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.list:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: list
type: object
properties:
displayName:
type: string
description: The displayable title of the list.
nullable: true
list:
$ref: '#/components/schemas/microsoft.graph.listInfo'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
system:
$ref: '#/components/schemas/microsoft.graph.systemFacet'
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of field definitions for this list.
x-ms-navigationProperty: true
contentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types present in this list.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItem'
description: All items contained in the list.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.richLongRunningOperation'
description: The collection of long-running operations on the list.
x-ms-navigationProperty: true
subscriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.subscription'
description: The set of subscriptions on the list.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.publicError:
title: publicError
type: object
properties:
code:
type: string
description: Represents the error code.
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
description: Details of the error.
innerError:
$ref: '#/components/schemas/microsoft.graph.publicInnerError'
message:
type: string
description: A non-localized message for the developer.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.root:
title: root
type: object
additionalProperties:
type: object
microsoft.graph.siteCollection:
title: siteCollection
type: object
properties:
dataLocationCode:
type: string
description: The geographic region code for where this site collection resides. Read-only.
nullable: true
hostname:
type: string
description: The hostname for the site collection. Read-only.
nullable: true
root:
$ref: '#/components/schemas/microsoft.graph.root'
additionalProperties:
type: object
microsoft.graph.itemAnalytics:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemAnalytics
type: object
properties:
allTime:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
itemActivityStats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
x-ms-navigationProperty: true
lastSevenDays:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
additionalProperties:
type: object
microsoft.graph.columnDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnDefinition
type: object
properties:
boolean:
$ref: '#/components/schemas/microsoft.graph.booleanColumn'
calculated:
$ref: '#/components/schemas/microsoft.graph.calculatedColumn'
choice:
$ref: '#/components/schemas/microsoft.graph.choiceColumn'
columnGroup:
type: string
description: 'For site columns, the name of the group this column belongs to. Helps organize related columns.'
nullable: true
contentApprovalStatus:
$ref: '#/components/schemas/microsoft.graph.contentApprovalStatusColumn'
currency:
$ref: '#/components/schemas/microsoft.graph.currencyColumn'
dateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeColumn'
defaultValue:
$ref: '#/components/schemas/microsoft.graph.defaultColumnValue'
description:
type: string
description: The user-facing description of the column.
nullable: true
displayName:
type: string
description: The user-facing name of the column.
nullable: true
enforceUniqueValues:
type: boolean
description: 'If true, no two list items may have the same value for this column.'
nullable: true
geolocation:
$ref: '#/components/schemas/microsoft.graph.geolocationColumn'
hidden:
type: boolean
description: Specifies whether the column is displayed in the user interface.
nullable: true
hyperlinkOrPicture:
$ref: '#/components/schemas/microsoft.graph.hyperlinkOrPictureColumn'
indexed:
type: boolean
description: Specifies whether the column values can be used for sorting and searching.
nullable: true
isDeletable:
type: boolean
description: Indicates whether this column can be deleted.
nullable: true
isReorderable:
type: boolean
description: Indicates whether values in the column can be reordered. Read-only.
nullable: true
isSealed:
type: boolean
description: Specifies whether the column can be changed.
nullable: true
lookup:
$ref: '#/components/schemas/microsoft.graph.lookupColumn'
name:
type: string
description: 'The API-facing name of the column as it appears in the [fields][] on a [listItem][]. For the user-facing name, see displayName.'
nullable: true
number:
$ref: '#/components/schemas/microsoft.graph.numberColumn'
personOrGroup:
$ref: '#/components/schemas/microsoft.graph.personOrGroupColumn'
propagateChanges:
type: boolean
description: 'If ''true'', changes to this column will be propagated to lists that implement the column.'
nullable: true
readOnly:
type: boolean
description: Specifies whether the column values can be modified.
nullable: true
required:
type: boolean
description: Specifies whether the column value isn't optional.
nullable: true
sourceContentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
term:
$ref: '#/components/schemas/microsoft.graph.termColumn'
text:
$ref: '#/components/schemas/microsoft.graph.textColumn'
thumbnail:
$ref: '#/components/schemas/microsoft.graph.thumbnailColumn'
type:
$ref: '#/components/schemas/microsoft.graph.columnTypes'
validation:
$ref: '#/components/schemas/microsoft.graph.columnValidation'
sourceColumn:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
additionalProperties:
type: object
microsoft.graph.contentType:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contentType
type: object
properties:
associatedHubsUrls:
type: array
items:
type: string
nullable: true
description: List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type will be applied to the lists in the enforced sites.
description:
type: string
description: The descriptive text for the item.
nullable: true
documentSet:
$ref: '#/components/schemas/microsoft.graph.documentSet'
documentTemplate:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
group:
type: string
description: The name of the group this content type belongs to. Helps organize related content types.
nullable: true
hidden:
type: boolean
description: Indicates whether the content type is hidden in the list's 'New' menu.
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
isBuiltIn:
type: boolean
description: Specifies if a content type is a built-in content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
order:
$ref: '#/components/schemas/microsoft.graph.contentTypeOrder'
parentId:
type: string
description: The unique identifier of the content type.
nullable: true
propagateChanges:
type: boolean
description: 'If true, any changes made to the content type will be pushed to inherited content types and lists that implement the content type.'
nullable: true
readOnly:
type: boolean
description: 'If true, the content type can''t be modified unless this value is first set to false.'
nullable: true
sealed:
type: boolean
description: 'If true, the content type can''t be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.'
nullable: true
base:
$ref: '#/components/schemas/microsoft.graph.contentType'
baseTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
description: The collection of content types that are ancestors of this content type.
x-ms-navigationProperty: true
columnLinks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnLink'
description: The collection of columns that are required by this content type.
x-ms-navigationProperty: true
columnPositions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: Column order information in a content type.
x-ms-navigationProperty: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions for this contentType.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.publicError'
percentageComplete:
maximum: 2147483647
minimum: -2147483648
type: integer
description: A value between 0 and 100 that indicates the progress of the operation.
format: int32
nullable: true
resourceId:
type: string
description: The unique identifier for the result.
nullable: true
type:
type: string
description: The type of the operation.
nullable: true
additionalProperties:
type: object
microsoft.graph.permission:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: permission
type: object
properties:
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there is no expiration set for this permission. Optional.
format: date-time
nullable: true
grantedTo:
$ref: '#/components/schemas/microsoft.graph.identitySet'
grantedToIdentities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.identitySet'
grantedToIdentitiesV2:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
description: 'For link type permissions, the details of the users to whom permission was granted. Read-only.'
grantedToV2:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet'
hasPassword:
type: boolean
description: Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only..
nullable: true
inheritedFrom:
$ref: '#/components/schemas/microsoft.graph.itemReference'
invitation:
$ref: '#/components/schemas/microsoft.graph.sharingInvitation'
link:
$ref: '#/components/schemas/microsoft.graph.sharingLink'
roles:
type: array
items:
type: string
nullable: true
description: 'The type of permission, for example, read. See below for the full list of roles. Read-only.'
shareId:
type: string
description: A unique token that can be used to access this shared item via the **shares** API. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.store:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: store
type: object
properties:
defaultLanguageTag:
type: string
description: Default language of the term store.
languageTags:
type: array
items:
type: string
description: List of languages for the term store.
groups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.group'
description: Collection of all groups available in the term store.
x-ms-navigationProperty: true
sets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
description: Collection of all sets available in the term store. This relationship can only be used to load a specific term set.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.plannerPlan:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlan
type: object
properties:
container:
$ref: '#/components/schemas/microsoft.graph.plannerPlanContainer'
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
owner:
type: string
nullable: true
title:
type: string
description: Required. Title of the plan.
buckets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerBucket'
description: Read-only. Nullable. Collection of buckets in the plan.
x-ms-navigationProperty: true
details:
$ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Collection of tasks in the plan.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.notebook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: notebook
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default notebook. Read-only.
nullable: true
isShared:
type: boolean
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.'
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.notebookLinks'
sectionGroupsUrl:
type: string
description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.'
nullable: true
sectionsUrl:
type: string
description: 'The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.'
nullable: true
userRole:
$ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the notebook. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenoteOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.operation'
- title: onenoteOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
percentComplete:
type: string
description: The operation percent complete if the operation is still in running status.
nullable: true
resourceId:
type: string
description: The resource id.
nullable: true
resourceLocation:
type: string
description: 'The resource URI for the object. For example, the resource URI for a copied page or section.'
nullable: true
additionalProperties:
type: object
microsoft.graph.onenotePage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenotePage
type: object
properties:
content:
type: string
description: The page's HTML content.
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for the page's HTML content. Read-only.
nullable: true
createdByAppId:
type: string
description: The unique identifier of the application that created the page. Read-only.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
level:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The indentation level of the page. Read-only.
format: int32
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.pageLinks'
order:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The order of the page within its parent section. Read-only.
format: int32
nullable: true
title:
type: string
description: The title of the page.
nullable: true
userTags:
type: array
items:
type: string
nullable: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSection:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
additionalProperties:
type: object
microsoft.graph.onenoteResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteResource
type: object
properties:
content:
type: string
description: The content stream
format: base64url
nullable: true
contentUrl:
type: string
description: The URL for downloading the content
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: sectionGroup
type: object
properties:
sectionGroupsUrl:
type: string
description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.'
nullable: true
sectionsUrl:
type: string
description: 'The URL for the sections navigation property, which returns all the sections in the section group. Read-only.'
nullable: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSectionGroup:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
sectionGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
description: The section groups in the section. Read-only. Nullable.
x-ms-navigationProperty: true
sections:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenoteSection'
description: The sections in the section group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onenoteSection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- title: onenoteSection
type: object
properties:
isDefault:
type: boolean
description: Indicates whether this is the user's default section. Read-only.
nullable: true
links:
$ref: '#/components/schemas/microsoft.graph.sectionLinks'
pagesUrl:
type: string
description: The pages endpoint where you can get details for all the pages in the section. Read-only.
nullable: true
pages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onenotePage'
description: The collection of pages in the section. Read-only. Nullable.
x-ms-navigationProperty: true
parentNotebook:
$ref: '#/components/schemas/microsoft.graph.notebook'
parentSectionGroup:
$ref: '#/components/schemas/microsoft.graph.sectionGroup'
additionalProperties:
type: object
microsoft.graph.teamFunSettings:
title: teamFunSettings
type: object
properties:
allowCustomMemes:
type: boolean
description: 'If set to true, enables users to include custom memes.'
nullable: true
allowGiphy:
type: boolean
description: 'If set to true, enables Giphy use.'
nullable: true
allowStickersAndMemes:
type: boolean
description: 'If set to true, enables users to include stickers and memes.'
nullable: true
giphyContentRating:
$ref: '#/components/schemas/microsoft.graph.giphyRatingType'
additionalProperties:
type: object
microsoft.graph.teamGuestSettings:
title: teamGuestSettings
type: object
properties:
allowCreateUpdateChannels:
type: boolean
description: 'If set to true, guests can add and update channels.'
nullable: true
allowDeleteChannels:
type: boolean
description: 'If set to true, guests can delete channels.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamMemberSettings:
title: teamMemberSettings
type: object
properties:
allowAddRemoveApps:
type: boolean
description: 'If set to true, members can add and remove apps.'
nullable: true
allowCreatePrivateChannels:
type: boolean
description: 'If set to true, members can add and update private channels.'
nullable: true
allowCreateUpdateChannels:
type: boolean
description: 'If set to true, members can add and update channels.'
nullable: true
allowCreateUpdateRemoveConnectors:
type: boolean
description: 'If set to true, members can add, update, and remove connectors.'
nullable: true
allowCreateUpdateRemoveTabs:
type: boolean
description: 'If set to true, members can add, update, and remove tabs.'
nullable: true
allowDeleteChannels:
type: boolean
description: 'If set to true, members can delete channels.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamMessagingSettings:
title: teamMessagingSettings
type: object
properties:
allowChannelMentions:
type: boolean
description: 'If set to true, @channel mentions are allowed.'
nullable: true
allowOwnerDeleteMessages:
type: boolean
description: 'If set to true, owners can delete any message.'
nullable: true
allowTeamMentions:
type: boolean
description: 'If set to true, @team mentions are allowed.'
nullable: true
allowUserDeleteMessages:
type: boolean
description: 'If set to true, users can delete their messages.'
nullable: true
allowUserEditMessages:
type: boolean
description: 'If set to true, users can edit their messages.'
nullable: true
additionalProperties:
type: object
microsoft.graph.teamSpecialization:
title: teamSpecialization
enum:
- none
- educationStandard
- educationClass
- educationProfessionalLearningCommunity
- educationStaff
- healthcareStandard
- healthcareCareCoordination
- unknownFutureValue
type: string
microsoft.graph.teamSummary:
title: teamSummary
type: object
properties:
guestsCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Count of guests in a team.
format: int32
nullable: true
membersCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Count of members in a team.
format: int32
nullable: true
ownersCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Count of owners in a team.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.teamVisibilityType:
title: teamVisibilityType
enum:
- private
- public
- hiddenMembership
- unknownFutureValue
type: string
microsoft.graph.channel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: channel
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Read only. Timestamp at which the channel was created.
format: date-time
nullable: true
description:
type: string
description: Optional textual description for the channel.
nullable: true
displayName:
type: string
description: Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
email:
type: string
description: The email address for sending messages to the channel. Read-only.
nullable: true
isFavoriteByDefault:
type: boolean
description: 'Indicates whether the channel should automatically be marked ''favorite'' for all members of the team. Can only be set programmatically with Create team. Default: false.'
nullable: true
membershipType:
$ref: '#/components/schemas/microsoft.graph.channelMembershipType'
tenantId:
type: string
description: The ID of the Azure Active Directory tenant.
nullable: true
webUrl:
type: string
description: 'A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
filesFolder:
$ref: '#/components/schemas/microsoft.graph.driveItem'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of membership records associated with the channel.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the channel. A navigation property. Nullable.
x-ms-navigationProperty: true
sharedWithTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
description: A collection of teams with which a channel is shared.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the channel. A navigation property.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppInstallation
type: object
properties:
teamsApp:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
teamsAppDefinition:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
additionalProperties:
type: object
microsoft.graph.conversationMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: conversationMember
type: object
properties:
displayName:
type: string
description: The display name of the user.
nullable: true
roles:
type: array
items:
type: string
nullable: true
description: 'The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.'
visibleHistoryStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.teamsAsyncOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAsyncOperation
type: object
properties:
attemptsCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of times the operation was attempted before being marked successful or failed.
format: int32
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time when the operation was created.
format: date-time
error:
$ref: '#/components/schemas/microsoft.graph.operationError'
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time when the async operation was last updated.
format: date-time
operationType:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType'
status:
$ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus'
targetResourceId:
type: string
description: 'The ID of the object that''s created or modified as result of this async operation, typically a team.'
nullable: true
targetResourceLocation:
type: string
description: The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
nullable: true
additionalProperties:
type: object
microsoft.graph.teamworkTag:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkTag
type: object
properties:
description:
type: string
description: The description of the tag as it will appear to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
nullable: true
displayName:
type: string
description: The name of the tag as it will appear to the user in Microsoft Teams.
nullable: true
memberCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of users assigned to the tag.
format: int32
nullable: true
tagType:
$ref: '#/components/schemas/microsoft.graph.teamworkTagType'
teamId:
type: string
description: ID of the team in which the tag is defined.
nullable: true
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
description: Users assigned to the tag.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTemplate
type: object
additionalProperties:
type: object
microsoft.graph.schedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: schedule
type: object
properties:
enabled:
type: boolean
description: Indicates whether the schedule is enabled for the team. Required.
nullable: true
offerShiftRequestsEnabled:
type: boolean
description: Indicates whether offer shift requests are enabled for the schedule.
nullable: true
openShiftsEnabled:
type: boolean
description: Indicates whether open shifts are enabled for the schedule.
nullable: true
provisionStatus:
$ref: '#/components/schemas/microsoft.graph.operationStatus'
provisionStatusCode:
type: string
description: Additional information about why schedule provisioning failed.
nullable: true
readOnly: true
swapShiftsRequestsEnabled:
type: boolean
description: Indicates whether swap shifts requests are enabled for the schedule.
nullable: true
timeClockEnabled:
type: boolean
description: Indicates whether time clock is enabled for the schedule.
nullable: true
timeOffRequestsEnabled:
type: boolean
description: Indicates whether time off requests are enabled for the schedule.
nullable: true
timeZone:
type: string
description: Indicates the time zone of the schedule team using tz database format. Required.
nullable: true
workforceIntegrationIds:
type: array
items:
type: string
nullable: true
offerShiftRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
x-ms-navigationProperty: true
openShiftChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
description: The open shift requests in the schedule.
x-ms-navigationProperty: true
openShifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.openShift'
description: The set of open shifts in a scheduling group in the schedule.
x-ms-navigationProperty: true
schedulingGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.schedulingGroup'
description: The logical grouping of users in the schedule (usually by role).
x-ms-navigationProperty: true
shifts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shift'
description: The shifts in the schedule.
x-ms-navigationProperty: true
swapShiftsChangeRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
x-ms-navigationProperty: true
timeOffReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffReason'
description: The set of reasons for a time off in the schedule.
x-ms-navigationProperty: true
timeOffRequests:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOffRequest'
x-ms-navigationProperty: true
timesOff:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeOff'
description: The instances of times off in the schedule.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.ErrorDetails:
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.ODataErrors.InnerError:
type: object
additionalProperties:
type: object
description: The structure of this object is service-specific
microsoft.graph.dayOfWeek:
title: dayOfWeek
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
type: string
microsoft.graph.weekIndex:
title: weekIndex
enum:
- first
- second
- third
- fourth
- last
type: string
microsoft.graph.recurrencePatternType:
title: recurrencePatternType
enum:
- daily
- weekly
- absoluteMonthly
- relativeMonthly
- absoluteYearly
- relativeYearly
type: string
microsoft.graph.recurrenceRangeType:
title: recurrenceRangeType
enum:
- endDate
- noEnd
- numbered
type: string
microsoft.graph.calendarRoleType:
title: calendarRoleType
enum:
- none
- freeBusyRead
- limitedRead
- read
- write
- delegateWithoutPrivateEventAccess
- delegateWithPrivateEventAccess
- custom
type: string
microsoft.graph.attendeeBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- title: attendeeBase
type: object
properties:
type:
$ref: '#/components/schemas/microsoft.graph.attendeeType'
additionalProperties:
type: object
microsoft.graph.timeSlot:
title: timeSlot
type: object
properties:
end:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
start:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.bodyType:
title: bodyType
enum:
- text
- html
type: string
microsoft.graph.physicalAddress:
title: physicalAddress
type: object
properties:
city:
type: string
description: The city.
nullable: true
countryOrRegion:
type: string
description: 'The country or region. It''s a free-format string value, for example, ''United States''.'
nullable: true
postalCode:
type: string
description: The postal code.
nullable: true
state:
type: string
description: The state.
nullable: true
street:
type: string
description: The street.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookGeoCoordinates:
title: outlookGeoCoordinates
type: object
properties:
accuracy:
type: number
description: 'The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.'
format: double
nullable: true
altitude:
type: number
description: The altitude of the location.
format: double
nullable: true
altitudeAccuracy:
type: number
description: The accuracy of the altitude.
format: double
nullable: true
latitude:
type: number
description: The latitude of the location.
format: double
nullable: true
longitude:
type: number
description: The longitude of the location.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.locationType:
title: locationType
enum:
- default
- conferenceRoom
- homeAddress
- businessAddress
- geoCoordinates
- streetAddress
- hotel
- restaurant
- localBusiness
- postalAddress
type: string
microsoft.graph.locationUniqueIdType:
title: locationUniqueIdType
enum:
- unknown
- locationStore
- directory
- private
- bing
type: string
microsoft.graph.phone:
title: phone
type: object
properties:
language:
type: string
nullable: true
number:
type: string
description: The phone number.
nullable: true
region:
type: string
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.phoneType'
additionalProperties:
type: object
microsoft.graph.responseType:
title: responseType
enum:
- none
- organizer
- tentativelyAccepted
- accepted
- declined
- notResponded
type: string
microsoft.graph.itemReference:
title: itemReference
type: object
properties:
driveId:
type: string
description: 'Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a [drive][]. Read-only.'
nullable: true
driveType:
type: string
description: 'Identifies the type of drive. Only returned if the item is located in a [drive][]. See [drive][] resource for values.'
nullable: true
id:
type: string
description: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
nullable: true
name:
type: string
description: The name of the item being referenced. Read-only.
nullable: true
path:
type: string
description: Path that can be used to navigate to the item. Read-only.
nullable: true
shareId:
type: string
description: 'A unique identifier for a shared resource that can be accessed via the [Shares][] API.'
nullable: true
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteId:
type: string
description: 'For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that [site][] resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.'
nullable: true
additionalProperties:
type: object
microsoft.graph.user:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: user
type: object
properties:
signInActivity:
$ref: '#/components/schemas/microsoft.graph.signInActivity'
accountEnabled:
type: boolean
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).'
nullable: true
ageGroup:
type: string
description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).'
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn''t differentiate 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).'
assignedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedPlan'
description: The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not).
authorizationInfo:
$ref: '#/components/schemas/microsoft.graph.authorizationInfo'
businessPhones:
type: array
items:
type: string
description: 'The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith).'
city:
type: string
description: 'The city in which 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).'
nullable: true
companyName:
type: string
description: 'The company name which the user is associated. This property can be useful for describing the company that an external user 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).'
nullable: true
consentProvidedForMinor:
type: string
description: 'Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).'
nullable: true
country:
type: string
description: 'The country/region in which 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).'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot 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 Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
creationType:
type: string
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 an external user 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).'
nullable: true
department:
type: string
description: 'The name for 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).'
nullable: true
displayName:
type: string
description: 'The name displayed in the address book for the user. This is usually the combination of the user''s first name, middle initial and last name. This property is required when a user is created and it cannot 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.'
nullable: true
employeeHireDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The date and time when the user was hired or will start work in case of a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
employeeId:
type: string
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).'
nullable: true
employeeLeaveDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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 one of the following Azure AD roles: Lifecycle Workflows Administrator, Global Reader, or Global Administrator. 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.'
format: date-time
nullable: true
employeeOrgData:
$ref: '#/components/schemas/microsoft.graph.employeeOrgData'
employeeType:
type: string
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).'
nullable: true
externalUserState:
type: string
description: 'For an external user 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).'
nullable: true
externalUserStateChangeDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in).'
format: date-time
nullable: true
faxNumber:
type: string
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).'
nullable: true
givenName:
type: string
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).'
nullable: true
identities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectIdentity'
description: 'Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.'
imAddresses:
type: array
items:
type: string
nullable: true
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).'
isResourceAccount:
type: boolean
description: Do not use – reserved for future use.
nullable: true
jobTitle:
type: string
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).'
nullable: true
lastPasswordChangeDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The time when this Azure AD 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 time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.'
format: date-time
nullable: true
legalAgeGroupClassification:
type: string
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, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select.'
nullable: true
licenseAssignmentStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseAssignmentState'
description: State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only. Returned only on $select.
mail:
type: string
description: 'The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user''s proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters. NOTE: We do not 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).'
nullable: true
mailNickname:
type: string
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).'
nullable: true
mobilePhone:
type: string
description: 'The primary cellular telephone number for the user. Read-only for users synced from 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).'
nullable: true
officeLocation:
type: string
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).'
nullable: true
onPremisesDistinguishedName:
type: string
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 Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.
nullable: true
onPremisesDomainName:
type: string
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 Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesImmutableId:
type: string
description: 'This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user''s userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..'
nullable: true
onPremisesLastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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 time. 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).'
format: date-time
nullable: true
onPremisesProvisioningErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError'
description: 'Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le).'
onPremisesSamAccountName:
type: string
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 Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
onPremisesSecurityIdentifier:
type: string
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).
nullable: true
onPremisesSyncEnabled:
type: boolean
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 Azure Active Directory (Azure AD). Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
onPremisesUserPrincipalName:
type: string
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 Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
otherMails:
type: array
items:
type: string
description: 'A list of additional email addresses for the user; for example: [''[email protected]'', ''[email protected]'']. NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).'
passwordPolicies:
type: string
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 may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).'
nullable: true
passwordProfile:
$ref: '#/components/schemas/microsoft.graph.passwordProfile'
postalCode:
type: string
description: 'The postal code for the user''s postal address. The postal code is specific to the user''s country/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).'
nullable: true
preferredDataLocation:
type: string
description: 'The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.'
nullable: true
preferredLanguage:
type: string
description: 'The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)'
nullable: true
provisionedPlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.provisionedPlan'
description: 'The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le).'
proxyAddresses:
type: array
items:
type: string
description: 'For example: [''SMTP: [email protected]'', ''smtp: [email protected]'']. Changes to the mail property will also 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 prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten 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).'
securityIdentifier:
type: string
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).'
nullable: true
showInAddressList:
type: boolean
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.
nullable: true
signInSessionsValidFromDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select.'
format: date-time
nullable: true
state:
type: string
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).'
nullable: true
streetAddress:
type: string
description: 'The street address of the user''s place of business. Maximum length is 1024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
surname:
type: string
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).'
nullable: true
usageLocation:
type: string
description: 'A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. 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).'
nullable: true
userPrincipalName:
type: string
description: 'The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user''s email name. The general format is alias@domain, where 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 cannot 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.'
nullable: true
userType:
type: string
description: 'A string value that can be used to classify user types in your directory, such as 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 member and guest users, see What are the default user permissions in Azure Active Directory?'
nullable: true
mailboxSettings:
$ref: '#/components/schemas/microsoft.graph.mailboxSettings'
deviceEnrollmentLimit:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
format: int32
aboutMe:
type: string
description: A freeform text entry field for the user to describe themselves. Returned only on $select.
nullable: true
birthday:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The birthday of the user. 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. Returned only on $select.'
format: date-time
hireDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The hire date of the user. 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. Returned only on $select. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.'
format: date-time
interests:
type: array
items:
type: string
nullable: true
description: A list for the user to describe their interests. Returned only on $select.
mySite:
type: string
description: The URL for the user's personal site. Returned only on $select.
nullable: true
pastProjects:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their past projects. Returned only on $select.
preferredName:
type: string
description: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.
nullable: true
responsibilities:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their responsibilities. Returned only on $select.
schools:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate the schools they have attended. Returned only on $select.
skills:
type: array
items:
type: string
nullable: true
description: A list for the user to enumerate their skills. Returned only on $select.
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a user has been granted for an application. Supports $expand.
x-ms-navigationProperty: true
createdObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects that were created by the user. Read-only. Nullable.
x-ms-navigationProperty: true
directReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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.
x-ms-navigationProperty: true
licenseDetails:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseDetails'
description: A collection of this user's license details. Read-only.
x-ms-navigationProperty: true
manager:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
oauth2PermissionGrants:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
x-ms-navigationProperty: true
ownedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Devices that are owned by the user. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
ownedObjects:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Devices that are registered for the user. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
scopedRoleMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'The groups, including nested groups, and directory roles that a user is a member of. Nullable.'
x-ms-navigationProperty: true
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarGroups:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendarGroup'
description: The user's calendar groups. Read-only. Nullable.
x-ms-navigationProperty: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The user's calendars. Read-only. Nullable.
x-ms-navigationProperty: true
calendarView:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
contactFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The user's contacts folders. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The user's contacts. Read-only. Nullable.
x-ms-navigationProperty: true
events:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.event'
description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
x-ms-navigationProperty: true
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassification'
mailFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The user's mail folders. Read-only. Nullable.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The messages in a mailbox or folder. Read-only. Nullable.
x-ms-navigationProperty: true
outlook:
$ref: '#/components/schemas/microsoft.graph.outlookUser'
people:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.person'
description: People that are relevant to the user. Read-only. Nullable.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
drives:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.drive'
description: A collection of drives available for this user. Read-only.
x-ms-navigationProperty: true
followedSites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable.
x-ms-navigationProperty: true
agreementAcceptances:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
description: The user's terms of use acceptance statuses. Read-only. Nullable.
x-ms-navigationProperty: true
managedDevices:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedDevice'
description: The managed devices associated with the user.
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
description: Zero or more managed app registrations that belong to the user.
x-ms-navigationProperty: true
deviceManagementTroubleshootingEvents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent'
description: The list of troubleshooting events for this user.
x-ms-navigationProperty: true
planner:
$ref: '#/components/schemas/microsoft.graph.plannerUser'
insights:
$ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
settings:
$ref: '#/components/schemas/microsoft.graph.userSettings'
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
photos:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
x-ms-navigationProperty: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userActivity'
description: The user's activities across devices. Read-only. Nullable.
x-ms-navigationProperty: true
onlineMeetings:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.onlineMeeting'
x-ms-navigationProperty: true
presence:
$ref: '#/components/schemas/microsoft.graph.presence'
authentication:
$ref: '#/components/schemas/microsoft.graph.authentication'
chats:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chat'
x-ms-navigationProperty: true
joinedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.team'
x-ms-navigationProperty: true
teamwork:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
todo:
$ref: '#/components/schemas/microsoft.graph.todo'
additionalProperties:
type: object
microsoft.graph.storagePlanInformation:
title: storagePlanInformation
type: object
properties:
upgradeAvailable:
type: boolean
description: Indicates whether there are higher storage quota plans available. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.audio:
title: audio
type: object
properties:
album:
type: string
description: The title of the album for this audio file.
nullable: true
albumArtist:
type: string
description: The artist named on the album for the audio file.
nullable: true
artist:
type: string
description: The performing artist for the audio file.
nullable: true
bitrate:
type: integer
description: Bitrate expressed in kbps.
format: int64
nullable: true
composers:
type: string
description: The name of the composer of the audio file.
nullable: true
copyright:
type: string
description: Copyright information for the audio file.
nullable: true
disc:
maximum: 32767
minimum: -32768
type: integer
description: The number of the disc this audio file came from.
format: int16
nullable: true
discCount:
maximum: 32767
minimum: -32768
type: integer
description: The total number of discs in this album.
format: int16
nullable: true
duration:
type: integer
description: 'Duration of the audio file, expressed in milliseconds'
format: int64
nullable: true
genre:
type: string
description: The genre of this audio file.
nullable: true
hasDrm:
type: boolean
description: Indicates if the file is protected with digital rights management.
nullable: true
isVariableBitrate:
type: boolean
description: Indicates if the file is encoded with a variable bitrate.
nullable: true
title:
type: string
description: The title of the audio file.
nullable: true
track:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of the track on the original disc for this audio file.
format: int32
nullable: true
trackCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The total number of tracks on the original disc for this audio file.
format: int32
nullable: true
year:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The year the audio file was recorded.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.bundle:
title: bundle
type: object
properties:
album:
$ref: '#/components/schemas/microsoft.graph.album'
childCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of children contained immediately within this container.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.deleted:
title: deleted
type: object
properties:
state:
type: string
description: Represents the state of the deleted item.
nullable: true
additionalProperties:
type: object
microsoft.graph.file:
title: file
type: object
properties:
hashes:
$ref: '#/components/schemas/microsoft.graph.hashes'
mimeType:
type: string
description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only.
nullable: true
processingMetadata:
type: boolean
nullable: true
additionalProperties:
type: object
microsoft.graph.fileSystemInfo:
title: fileSystemInfo
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time the file was created on a client.
format: date-time
nullable: true
lastAccessedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time the file was last accessed. Available for the recent file list only.
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time the file was last modified on a client.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.folder:
title: folder
type: object
properties:
childCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of children contained immediately within this container.
format: int32
nullable: true
view:
$ref: '#/components/schemas/microsoft.graph.folderView'
additionalProperties:
type: object
microsoft.graph.image:
title: image
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Optional. Height of the image, in pixels. Read-only.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Optional. Width of the image, in pixels. Read-only.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.geoCoordinates:
title: geoCoordinates
type: object
properties:
altitude:
type: number
description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.'
format: double
nullable: true
latitude:
type: number
description: 'Optional. The latitude, in decimal, for the item. Read-only.'
format: double
nullable: true
longitude:
type: number
description: 'Optional. The longitude, in decimal, for the item. Read-only.'
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.malware:
title: malware
type: object
properties:
description:
type: string
description: Contains the virus details for the malware facet.
nullable: true
additionalProperties:
type: object
microsoft.graph.package:
title: package
type: object
properties:
type:
type: string
description: 'A string indicating the type of package. While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.'
nullable: true
additionalProperties:
type: object
microsoft.graph.pendingOperations:
title: pendingOperations
type: object
properties:
pendingContentUpdate:
$ref: '#/components/schemas/microsoft.graph.pendingContentUpdate'
additionalProperties:
type: object
microsoft.graph.photo:
title: photo
type: object
properties:
cameraMake:
type: string
description: Camera manufacturer. Read-only.
nullable: true
cameraModel:
type: string
description: Camera model. Read-only.
nullable: true
exposureDenominator:
type: number
description: The denominator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
exposureNumerator:
type: number
description: The numerator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
fNumber:
type: number
description: The F-stop value from the camera. Read-only.
format: double
nullable: true
focalLength:
type: number
description: The focal length from the camera. Read-only.
format: double
nullable: true
iso:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The ISO value from the camera. Read-only.
format: int32
nullable: true
orientation:
maximum: 32767
minimum: -32768
type: integer
description: The orientation value from the camera. Writable on OneDrive Personal.
format: int16
nullable: true
takenDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Represents the date and time the photo was taken. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.publicationFacet:
title: publicationFacet
type: object
properties:
level:
type: string
description: The state of publication for this document. Either published or checkout. Read-only.
nullable: true
versionId:
type: string
description: The unique identifier for the version that is visible to the current caller. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.remoteItem:
title: remoteItem
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of item creation. Read-only.
format: date-time
nullable: true
file:
$ref: '#/components/schemas/microsoft.graph.file'
fileSystemInfo:
$ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
folder:
$ref: '#/components/schemas/microsoft.graph.folder'
id:
type: string
description: Unique identifier for the remote item in its drive. Read-only.
nullable: true
image:
$ref: '#/components/schemas/microsoft.graph.image'
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time the item was last modified. Read-only.
format: date-time
nullable: true
name:
type: string
description: Optional. Filename of the remote item. Read-only.
nullable: true
package:
$ref: '#/components/schemas/microsoft.graph.package'
parentReference:
$ref: '#/components/schemas/microsoft.graph.itemReference'
shared:
$ref: '#/components/schemas/microsoft.graph.shared'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
size:
type: integer
description: Size of the remote item. Read-only.
format: int64
nullable: true
specialFolder:
$ref: '#/components/schemas/microsoft.graph.specialFolder'
video:
$ref: '#/components/schemas/microsoft.graph.video'
webDavUrl:
type: string
description: DAV compatible URL for the item.
nullable: true
webUrl:
type: string
description: URL that displays the resource in the browser. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.searchResult:
title: searchResult
type: object
properties:
onClickTelemetryUrl:
type: string
description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results.
nullable: true
additionalProperties:
type: object
microsoft.graph.shared:
title: shared
type: object
properties:
owner:
$ref: '#/components/schemas/microsoft.graph.identitySet'
scope:
type: string
description: 'Indicates the scope of how the item is shared: anonymous, organization, or users. Read-only.'
nullable: true
sharedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
sharedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The UTC date and time when the item was shared. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.specialFolder:
title: specialFolder
type: object
properties:
name:
type: string
description: The unique identifier for this item in the /drive/special collection
nullable: true
additionalProperties:
type: object
microsoft.graph.video:
title: video
type: object
properties:
audioBitsPerSample:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of audio bits per sample.
format: int32
nullable: true
audioChannels:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of audio channels.
format: int32
nullable: true
audioFormat:
type: string
description: 'Name of the audio format (AAC, MP3, etc.).'
nullable: true
audioSamplesPerSecond:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of audio samples per second.
format: int32
nullable: true
bitrate:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Bit rate of the video in bits per second.
format: int32
nullable: true
duration:
type: integer
description: Duration of the file in milliseconds.
format: int64
nullable: true
fourCC:
type: string
description: '''Four character code'' name of the video format.'
nullable: true
frameRate:
type: number
description: Frame rate of the video.
format: double
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Height of the video, in pixels.'
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Width of the video, in pixels.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.workbook:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbook
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.workbookApplication'
comments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookComment'
x-ms-navigationProperty: true
functions:
$ref: '#/components/schemas/microsoft.graph.workbookFunctions'
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookOperation'
description: 'The status of workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the Location header is returned in the response. Read-only.'
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: Represents a collection of tables associated with the workbook. Read-only.
x-ms-navigationProperty: true
worksheets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
description: Represents a collection of worksheets associated with the workbook. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.listItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
- title: listItem
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
sharepointIds:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
documentSetVersions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetVersion'
description: Version information for a document set version created by a user.
x-ms-navigationProperty: true
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
fields:
$ref: '#/components/schemas/microsoft.graph.fieldValueSet'
versions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.listItemVersion'
description: The list of previous versions of the list item.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.subscription:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: subscription
type: object
properties:
applicationId:
type: string
description: Optional. Identifier of the application used to create the subscription. Read-only.
nullable: true
changeType:
type: string
description: 'Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated or soft deleted. Use deleted to receive notifications when user or group is permanently deleted.'
clientState:
type: string
description: Required. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
nullable: true
creatorId:
type: string
description: 'Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the id of the service principal corresponding to the app. Read-only.'
nullable: true
encryptionCertificate:
type: string
description: Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true.
nullable: true
encryptionCertificateId:
type: string
description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see the table below.'
format: date-time
includeResourceData:
type: boolean
description: 'Optional. When set to true, change notifications include resource data (such as content of a chat message).'
nullable: true
latestSupportedTlsVersion:
type: string
description: 'Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.'
nullable: true
lifecycleNotificationUrl:
type: string
description: 'Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol.'
nullable: true
notificationQueryOptions:
type: string
description: 'Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.'
nullable: true
notificationUrl:
type: string
description: Required. The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property will be included in the HTTP POST request when Microsoft Graph sends the change notifications.
notificationUrlAppId:
type: string
description: Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received.
nullable: true
resource:
type: string
description: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.
additionalProperties:
type: object
microsoft.graph.thumbnailSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: thumbnailSet
type: object
properties:
large:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
medium:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
small:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
source:
$ref: '#/components/schemas/microsoft.graph.thumbnail'
additionalProperties:
type: object
microsoft.graph.driveItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- title: driveItemVersion
type: object
properties:
content:
type: string
description: The content stream for this version of the item.
format: base64url
nullable: true
size:
type: integer
description: Indicates the size of the content stream for this version of the item.
format: int64
nullable: true
additionalProperties:
type: object
microsoft.graph.listInfo:
title: listInfo
type: object
properties:
contentTypesEnabled:
type: boolean
description: 'If true, indicates that content types are enabled for this list.'
nullable: true
hidden:
type: boolean
description: 'If true, indicates that the list is not normally visible in the SharePoint user experience.'
nullable: true
template:
type: string
description: 'An enumerated value that represents the base list template used in creating the list. Possible values include documentLibrary, genericList, task, survey, announcements, contacts, and more.'
nullable: true
additionalProperties:
type: object
microsoft.graph.publicErrorDetail:
title: publicErrorDetail
type: object
properties:
code:
type: string
description: The error code.
nullable: true
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.publicInnerError:
title: publicInnerError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
description: A collection of error details.
message:
type: string
description: The error message.
nullable: true
target:
type: string
description: The target of the error.
nullable: true
additionalProperties:
type: object
microsoft.graph.itemActivityStat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemActivityStat
type: object
properties:
access:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
create:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
delete:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
edit:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the interval ends. Read-only.
format: date-time
nullable: true
incompleteData:
$ref: '#/components/schemas/microsoft.graph.incompleteData'
isTrending:
type: boolean
description: Indicates whether the item is 'trending.' Read-only.
nullable: true
move:
$ref: '#/components/schemas/microsoft.graph.itemActionStat'
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: When the interval starts. Read-only.
format: date-time
nullable: true
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivity'
description: Exposes the itemActivities represented in this itemActivityStat resource.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.booleanColumn:
title: booleanColumn
type: object
additionalProperties:
type: object
microsoft.graph.calculatedColumn:
title: calculatedColumn
type: object
properties:
format:
type: string
description: 'For dateTime output types, the format of the value. Must be one of dateOnly or dateTime.'
nullable: true
formula:
type: string
description: The formula used to compute the value for this column.
nullable: true
outputType:
type: string
description: 'The output type used to format values in this column. Must be one of boolean, currency, dateTime, number, or text.'
nullable: true
additionalProperties:
type: object
microsoft.graph.choiceColumn:
title: choiceColumn
type: object
properties:
allowTextEntry:
type: boolean
description: 'If true, allows custom values that aren''t in the configured choices.'
nullable: true
choices:
type: array
items:
type: string
nullable: true
description: The list of values available for this column.
displayAs:
type: string
description: 'How the choices are to be presented in the UX. Must be one of checkBoxes, dropDownMenu, or radioButtons'
nullable: true
additionalProperties:
type: object
microsoft.graph.contentApprovalStatusColumn:
title: contentApprovalStatusColumn
type: object
additionalProperties:
type: object
microsoft.graph.currencyColumn:
title: currencyColumn
type: object
properties:
locale:
type: string
description: Specifies the locale from which to infer the currency symbol.
nullable: true
additionalProperties:
type: object
microsoft.graph.dateTimeColumn:
title: dateTimeColumn
type: object
properties:
displayAs:
type: string
description: 'How the value should be presented in the UX. Must be one of default, friendly, or standard. See below for more details. If unspecified, treated as default.'
nullable: true
format:
type: string
description: Indicates whether the value should be presented as a date only or a date and time. Must be one of dateOnly or dateTime
nullable: true
additionalProperties:
type: object
microsoft.graph.defaultColumnValue:
title: defaultColumnValue
type: object
properties:
formula:
type: string
description: The formula used to compute the default value for this column.
nullable: true
value:
type: string
description: The direct value to use as the default value for this column.
nullable: true
additionalProperties:
type: object
microsoft.graph.geolocationColumn:
title: geolocationColumn
type: object
additionalProperties:
type: object
microsoft.graph.hyperlinkOrPictureColumn:
title: hyperlinkOrPictureColumn
type: object
properties:
isPicture:
type: boolean
description: Specifies whether the display format used for URL columns is an image or a hyperlink.
nullable: true
additionalProperties:
type: object
microsoft.graph.lookupColumn:
title: lookupColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Indicates whether multiple values can be selected from the source.
nullable: true
allowUnlimitedLength:
type: boolean
description: Indicates whether values in the column should be able to exceed the standard limit of 255 characters.
nullable: true
columnName:
type: string
description: The name of the lookup source column.
nullable: true
listId:
type: string
description: The unique identifier of the lookup source list.
nullable: true
primaryLookupColumnId:
type: string
description: 'If specified, this column is a secondary lookup, pulling an additional field from the list item looked up by the primary lookup. Use the list item looked up by the primary as the source for the column named here.'
nullable: true
additionalProperties:
type: object
microsoft.graph.numberColumn:
title: numberColumn
type: object
properties:
decimalPlaces:
type: string
description: How many decimal places to display. See below for information about the possible values.
nullable: true
displayAs:
type: string
description: 'How the value should be presented in the UX. Must be one of number or percentage. If unspecified, treated as number.'
nullable: true
maximum:
type: number
description: The maximum permitted value.
format: double
nullable: true
minimum:
type: number
description: The minimum permitted value.
format: double
nullable: true
additionalProperties:
type: object
microsoft.graph.personOrGroupColumn:
title: personOrGroupColumn
type: object
properties:
allowMultipleSelection:
type: boolean
description: Indicates whether multiple values can be selected from the source.
nullable: true
chooseFromType:
type: string
description: 'Whether to allow selection of people only, or people and groups. Must be one of peopleAndGroups or peopleOnly.'
nullable: true
displayAs:
type: string
description: How to display the information about the person or group chosen. See below.
nullable: true
additionalProperties:
type: object
microsoft.graph.contentTypeInfo:
title: contentTypeInfo
type: object
properties:
id:
type: string
description: The id of the content type.
nullable: true
name:
type: string
description: The name of the content type.
nullable: true
additionalProperties:
type: object
microsoft.graph.termColumn:
title: termColumn
type: object
properties:
allowMultipleValues:
type: boolean
description: Specifies whether the column will allow more than one value.
nullable: true
showFullyQualifiedName:
type: boolean
description: Specifies whether to display the entire term path or only the term label.
nullable: true
parentTerm:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
termSet:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
additionalProperties:
type: object
microsoft.graph.textColumn:
title: textColumn
type: object
properties:
allowMultipleLines:
type: boolean
description: Whether to allow multiple lines of text.
nullable: true
appendChangesToExistingText:
type: boolean
description: 'Whether updates to this column should replace existing text, or append to it.'
nullable: true
linesForEditing:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The size of the text box.
format: int32
nullable: true
maxLength:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The maximum number of characters for the value.
format: int32
nullable: true
textType:
type: string
description: The type of text being stored. Must be one of plain or richText
nullable: true
additionalProperties:
type: object
microsoft.graph.thumbnailColumn:
title: thumbnailColumn
type: object
additionalProperties:
type: object
microsoft.graph.columnTypes:
title: columnTypes
enum:
- note
- text
- choice
- multichoice
- number
- currency
- dateTime
- lookup
- boolean
- user
- url
- calculated
- location
- geolocation
- term
- multiterm
- thumbnail
- approvalStatus
- unknownFutureValue
type: string
microsoft.graph.columnValidation:
title: columnValidation
type: object
properties:
defaultLanguage:
type: string
description: Default BCP 47 language tag for the description.
nullable: true
descriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.displayNameLocalization'
description: Localized messages that explain what is needed for this column's value to be considered valid. User will be prompted with this message if validation fails.
formula:
type: string
description: 'The formula to validate column value. For examples, see Examples of common formulas in lists.'
nullable: true
additionalProperties:
type: object
microsoft.graph.documentSet:
title: documentSet
type: object
properties:
allowedContentTypes:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
description: Content types allowed in document set.
defaultContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetContent'
description: Default contents of document set.
propagateWelcomePageChanges:
type: boolean
description: Specifies whether to push welcome page changes to inherited content types.
nullable: true
shouldPrefixNameToFile:
type: boolean
description: Indicates whether to add the name of the document set to each file name.
nullable: true
welcomePageUrl:
type: string
description: Welcome page absolute URL.
nullable: true
sharedColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
welcomePageColumns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.documentSetContent:
title: documentSetContent
type: object
properties:
contentType:
$ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
fileName:
type: string
description: Name of the file in resource folder that should be added as a default content or a template in the document set.
nullable: true
folderName:
type: string
description: Folder name in which the file will be placed when a new document set is created in the library.
nullable: true
additionalProperties:
type: object
microsoft.graph.contentTypeOrder:
title: contentTypeOrder
type: object
properties:
default:
type: boolean
description: Whether this is the default Content Type
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Specifies the position in which the Content Type appears in the selection UI.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.columnLink:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: columnLink
type: object
properties:
name:
type: string
description: The name of the column in this content type.
nullable: true
additionalProperties:
type: object
microsoft.graph.longRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: longRunningOperation
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The start time of the operation. 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.'
format: date-time
nullable: true
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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 time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
resourceLocation:
type: string
description: URI of the resource that the operation is performed on.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus'
statusDetail:
type: string
description: Details about the status of the operation.
nullable: true
additionalProperties:
type: object
microsoft.graph.sharePointIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: sharePointIdentitySet
type: object
properties:
group:
$ref: '#/components/schemas/microsoft.graph.identity'
siteGroup:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
siteUser:
$ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
additionalProperties:
type: object
microsoft.graph.sharingInvitation:
title: sharingInvitation
type: object
properties:
email:
type: string
description: The email address provided for the recipient of the sharing invitation. Read-only.
nullable: true
invitedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
redeemedBy:
type: string
nullable: true
signInRequired:
type: boolean
description: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.sharingLink:
title: sharingLink
type: object
properties:
application:
$ref: '#/components/schemas/microsoft.graph.identity'
preventsDownload:
type: boolean
description: 'If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.'
nullable: true
scope:
type: string
description: 'The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.'
nullable: true
type:
type: string
description: The type of the link created.
nullable: true
webHtml:
type: string
description: 'For embed links, this property contains the HTML code for an <iframe> element that will embed the item in a webpage.'
nullable: true
webUrl:
type: string
description: A URL that opens the item in the browser on the OneDrive website.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.group:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: group
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of the group creation. Read-only.
format: date-time
nullable: true
description:
type: string
description: Description that gives details on the term usage.
nullable: true
displayName:
type: string
description: Name of the group.
nullable: true
parentSiteId:
type: string
description: ID of the parent site of this group.
nullable: true
scope:
$ref: '#/components/schemas/microsoft.graph.termStore.termGroupScope'
sets:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
description: 'All sets under the group in a term [store].'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.termStore.set:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: set
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of set creation. Read-only.
format: date-time
nullable: true
description:
type: string
description: Description that gives details on the term usage.
nullable: true
localizedNames:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.localizedName'
description: Name of the set for each languageTag.
properties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValue'
description: Custom properties for the set.
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
description: 'Children terms of set in term [store].'
x-ms-navigationProperty: true
parentGroup:
$ref: '#/components/schemas/microsoft.graph.termStore.group'
relations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.relation'
description: Indicates which terms have been pinned or reused directly under the set.
x-ms-navigationProperty: true
terms:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
description: All the terms under the set.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.plannerPlanContainer:
title: plannerPlanContainer
type: object
properties:
containerId:
type: string
description: The identifier of the resource that contains the plan. Optional.
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.plannerContainerType'
url:
type: string
description: The full canonical URL of the container. Optional.
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerBucket:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerBucket
type: object
properties:
name:
type: string
description: Name of the bucket.
orderHint:
type: string
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.'
nullable: true
planId:
type: string
description: Plan ID to which the bucket belongs.
nullable: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. The collection of tasks in the bucket.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.plannerPlanDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerPlanDetails
type: object
properties:
categoryDescriptions:
$ref: '#/components/schemas/microsoft.graph.plannerCategoryDescriptions'
sharedWith:
$ref: '#/components/schemas/microsoft.graph.plannerUserIds'
additionalProperties:
type: object
microsoft.graph.plannerTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTask
type: object
properties:
activeChecklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Number of checklist items with value set to false, representing incomplete items.'
format: int32
nullable: true
appliedCategories:
$ref: '#/components/schemas/microsoft.graph.plannerAppliedCategories'
assigneePriority:
type: string
description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
assignments:
$ref: '#/components/schemas/microsoft.graph.plannerAssignments'
bucketId:
type: string
description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. Format validation is done on the service.
nullable: true
checklistItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of checklist items that are present on the task.
format: int32
nullable: true
completedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
completedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
conversationThreadId:
type: string
description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
dueDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
hasDescription:
type: boolean
description: Read-only. Value is true if the details object of the task has a non-empty description and false otherwise.
nullable: true
orderHint:
type: string
description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
percentComplete:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Percentage of task completion. When set to 100, the task is considered completed.'
format: int32
nullable: true
planId:
type: string
description: Plan ID to which the task belongs.
nullable: true
previewType:
$ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
priority:
maximum: 2147483647
minimum: -2147483648
type: integer
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''.'
format: int32
nullable: true
referenceCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Number of external references that exist on the task.
format: int32
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
title:
type: string
description: Title of the task.
assignedToTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat'
bucketTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat'
details:
$ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
progressTaskBoardFormat:
$ref: '#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat'
additionalProperties:
type: object
microsoft.graph.onenoteEntityHierarchyModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- title: onenoteEntityHierarchyModel
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
displayName:
type: string
description: The name of the notebook.
nullable: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.notebookLinks:
title: notebookLinks
type: object
properties:
oneNoteClientUrl:
$ref: '#/components/schemas/microsoft.graph.externalLink'
oneNoteWebUrl:
$ref: '#/components/schemas/microsoft.graph.externalLink'
additionalProperties:
type: object
microsoft.graph.onenoteUserRole:
title: onenoteUserRole
enum:
- None
- Owner
- Contributor
- Reader
type: string
microsoft.graph.operation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: operation
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The start time of the operation.
format: date-time
nullable: true
lastActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The time of the last action of the operation.
format: date-time
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.operationStatus'
additionalProperties:
type: object
microsoft.graph.onenoteOperationError:
title: onenoteOperationError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
message:
type: string
description: The error message.
nullable: true
additionalProperties:
type: object
microsoft.graph.onenoteEntitySchemaObjectModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- title: onenoteEntitySchemaObjectModel
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.pageLinks:
title: pageLinks
type: object
properties:
oneNoteClientUrl:
$ref: '#/components/schemas/microsoft.graph.externalLink'
oneNoteWebUrl:
$ref: '#/components/schemas/microsoft.graph.externalLink'
additionalProperties:
type: object
microsoft.graph.onenoteEntityBaseModel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onenoteEntityBaseModel
type: object
properties:
self:
type: string
description: The endpoint where you can get details about the page. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.sectionLinks:
title: sectionLinks
type: object
properties:
oneNoteClientUrl:
$ref: '#/components/schemas/microsoft.graph.externalLink'
oneNoteWebUrl:
$ref: '#/components/schemas/microsoft.graph.externalLink'
additionalProperties:
type: object
microsoft.graph.giphyRatingType:
title: giphyRatingType
enum:
- strict
- moderate
- unknownFutureValue
type: string
microsoft.graph.channelMembershipType:
title: channelMembershipType
enum:
- standard
- private
- unknownFutureValue
- shared
type: string
microsoft.graph.chatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessage
type: object
properties:
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageAttachment'
description: 'References to attached objects like files, tabs, meetings etc.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
channelIdentity:
$ref: '#/components/schemas/microsoft.graph.channelIdentity'
chatId:
type: string
description: 'If the message was sent in a chat, represents the identity of the chat.'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Timestamp of when the chat message was created.
format: date-time
nullable: true
deletedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read only. Timestamp at which the chat message was deleted, or null if not deleted.'
format: date-time
nullable: true
etag:
type: string
description: Read-only. Version number of the chat message.
nullable: true
eventDetail:
$ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
from:
$ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
importance:
$ref: '#/components/schemas/microsoft.graph.chatMessageImportance'
lastEditedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.'
format: date-time
nullable: true
locale:
type: string
description: Locale of the chat message set by the client. Always set to en-us.
mentions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageMention'
description: 'List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.'
messageHistory:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHistoryItem'
description: 'List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.'
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
policyViolation:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolation'
reactions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
description: 'Reactions for this chat message (for example, Like).'
replyToId:
type: string
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.)'
nullable: true
subject:
type: string
description: 'The subject of the chat message, in plaintext.'
nullable: true
summary:
type: string
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.'
nullable: true
webUrl:
type: string
description: Read-only. Link to the message in Microsoft Teams.
nullable: true
hostedContents:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.'
x-ms-navigationProperty: true
replies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: Replies for a specified message. Supports $expand for channel messages.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.sharedWithChannelTeamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamInfo'
- title: sharedWithChannelTeamInfo
type: object
properties:
isHostTeam:
type: boolean
description: Indicates whether the team is the host of the channel.
nullable: true
allowedMembers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of team members who have access to the shared channel.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsTab:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsTab
type: object
properties:
configuration:
$ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
displayName:
type: string
description: Name of the tab.
nullable: true
webUrl:
type: string
description: Deep link URL of the tab instance. Read only.
nullable: true
teamsApp:
$ref: '#/components/schemas/microsoft.graph.teamsApp'
additionalProperties:
type: object
microsoft.graph.teamsApp:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsApp
type: object
properties:
displayName:
type: string
description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
nullable: true
distributionMethod:
$ref: '#/components/schemas/microsoft.graph.teamsAppDistributionMethod'
externalId:
type: string
description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
nullable: true
appDefinitions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
description: The details for each version of the app.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.teamsAppDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamsAppDefinition
type: object
properties:
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
description:
type: string
description: Verbose description of the application.
nullable: true
displayName:
type: string
description: The name of the app provided by the app developer.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
publishingState:
$ref: '#/components/schemas/microsoft.graph.teamsAppPublishingState'
shortDescription:
type: string
description: Short description of the application.
nullable: true
teamsAppId:
type: string
description: The ID from the Teams app manifest.
nullable: true
version:
type: string
description: The version number of the application.
nullable: true
bot:
$ref: '#/components/schemas/microsoft.graph.teamworkBot'
additionalProperties:
type: object
microsoft.graph.operationError:
title: operationError
type: object
properties:
code:
type: string
description: Operation error code.
nullable: true
message:
type: string
description: Operation error message.
nullable: true
additionalProperties:
type: object
microsoft.graph.teamsAsyncOperationType:
title: teamsAsyncOperationType
enum:
- invalid
- cloneTeam
- archiveTeam
- unarchiveTeam
- createTeam
- unknownFutureValue
- teamifyGroup
- createChannel
type: string
microsoft.graph.teamsAsyncOperationStatus:
title: teamsAsyncOperationStatus
enum:
- invalid
- notStarted
- inProgress
- succeeded
- failed
- unknownFutureValue
type: string
microsoft.graph.teamworkTagType:
title: teamworkTagType
enum:
- standard
- unknownFutureValue
type: string
microsoft.graph.teamworkTagMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkTagMember
type: object
properties:
displayName:
type: string
description: The member's display name.
nullable: true
tenantId:
type: string
description: The ID of the tenant that the tag member is a part of.
nullable: true
userId:
type: string
description: The user ID of the member.
nullable: true
additionalProperties:
type: object
microsoft.graph.operationStatus:
title: operationStatus
enum:
- NotStarted
- Running
- Completed
- Failed
type: string
microsoft.graph.offerShiftRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleChangeRequest'
- title: offerShiftRequest
type: object
properties:
recipientActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
readOnly: true
recipientActionMessage:
type: string
description: Custom message sent by recipient of the offer shift request.
nullable: true
recipientUserId:
type: string
description: User ID of the recipient of the offer shift request.
nullable: true
senderShiftId:
type: string
description: User ID of the sender of the offer shift request.
nullable: true
additionalProperties:
type: object
microsoft.graph.openShiftChangeRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleChangeRequest'
- title: openShiftChangeRequest
type: object
properties:
openShiftId:
type: string
description: ID for the open shift.
nullable: true
additionalProperties:
type: object
microsoft.graph.openShift:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: openShift
type: object
properties:
draftOpenShift:
$ref: '#/components/schemas/microsoft.graph.openShiftItem'
schedulingGroupId:
type: string
description: ID for the scheduling group that the open shift belongs to.
nullable: true
sharedOpenShift:
$ref: '#/components/schemas/microsoft.graph.openShiftItem'
additionalProperties:
type: object
microsoft.graph.schedulingGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: schedulingGroup
type: object
properties:
displayName:
type: string
description: The display name for the schedulingGroup. Required.
nullable: true
isActive:
type: boolean
description: Indicates whether the schedulingGroup can be used when creating new entities or updating existing ones. Required.
nullable: true
readOnly: true
userIds:
type: array
items:
type: string
nullable: true
description: The list of user IDs that are a member of the schedulingGroup. Required.
additionalProperties:
type: object
microsoft.graph.shift:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: shift
type: object
properties:
draftShift:
$ref: '#/components/schemas/microsoft.graph.shiftItem'
schedulingGroupId:
type: string
description: ID of the scheduling group the shift is part of. Required.
nullable: true
sharedShift:
$ref: '#/components/schemas/microsoft.graph.shiftItem'
userId:
type: string
description: ID of the user assigned to the shift. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.swapShiftsChangeRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
- title: swapShiftsChangeRequest
type: object
properties:
recipientShiftId:
type: string
description: ShiftId for the recipient user with whom the request is to swap.
nullable: true
additionalProperties:
type: object
microsoft.graph.timeOffReason:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: timeOffReason
type: object
properties:
displayName:
type: string
description: The name of the timeOffReason. Required.
nullable: true
iconType:
$ref: '#/components/schemas/microsoft.graph.timeOffReasonIconType'
isActive:
type: boolean
description: Indicates whether the timeOffReason can be used when creating new entities or updating existing ones. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.timeOffRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleChangeRequest'
- title: timeOffRequest
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
timeOffReasonId:
type: string
description: The reason for the time off.
nullable: true
additionalProperties:
type: object
microsoft.graph.timeOff:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: timeOff
type: object
properties:
draftTimeOff:
$ref: '#/components/schemas/microsoft.graph.timeOffItem'
sharedTimeOff:
$ref: '#/components/schemas/microsoft.graph.timeOffItem'
userId:
type: string
description: ID of the user assigned to the timeOff. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.attendeeType:
title: attendeeType
enum:
- required
- optional
- resource
type: string
ReferenceNumeric:
enum:
- '-INF'
- INF
- NaN
microsoft.graph.phoneType:
title: phoneType
enum:
- home
- business
- mobile
- other
- assistant
- homeFax
- businessFax
- otherFax
- pager
- radio
type: string
microsoft.graph.signInActivity:
title: signInActivity
type: object
properties:
lastNonInteractiveSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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 to sign into 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 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''. Azure AD 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 Azure AD.'
format: date-time
nullable: true
lastNonInteractiveSignInRequestId:
type: string
description: Request identifier of the last non-interactive sign-in performed by this user.
nullable: true
lastSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The last interactive sign-in date and time for a specific user. You can use this field to calculate the last time a user attempted to sign into the directory with an interactive authentication method. This field can be used to build reports, such as inactive users. 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''. Azure AD 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 Azure AD.'
format: date-time
nullable: true
lastSignInRequestId:
type: string
description: Request identifier of the last interactive sign-in performed by this user.
nullable: true
additionalProperties:
type: object
microsoft.graph.assignedPlan:
title: assignedPlan
type: object
properties:
assignedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
capabilityStatus:
type: string
description: 'Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut. See a detailed description of each value.'
nullable: true
service:
type: string
description: 'The name of the service; for example, exchange.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
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.'
format: uuid
nullable: true
additionalProperties:
type: object
microsoft.graph.authorizationInfo:
title: authorizationInfo
type: object
properties:
certificateUserIds:
type: array
items:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.employeeOrgData:
title: employeeOrgData
type: object
properties:
costCenter:
type: string
description: The cost center associated with the user. Returned only on $select. Supports $filter.
nullable: true
division:
type: string
description: The name of the division in which the user works. Returned only on $select. Supports $filter.
nullable: true
additionalProperties:
type: object
microsoft.graph.objectIdentity:
title: objectIdentity
type: object
properties:
issuer:
type: string
description: 'Specifies the issuer of the identity, for example facebook.com.For local accounts (where signInType is not federated), this property is the local B2C tenant default domain name, for example contoso.onmicrosoft.com.For external users from other Azure AD organization, this will be the domain of the federated organization, for example contoso.com.Supports $filter. 512 character limit.'
nullable: true
issuerAssignedId:
type: string
description: 'Specifies the unique identifier assigned to the user by the issuer. 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 alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or Supports $filter. 64 character limit.'
nullable: true
signInType:
type: string
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 will update 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, will be performed when setting or updating a userPrincipalName identity. Additional 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.'
nullable: true
additionalProperties:
type: object
microsoft.graph.licenseAssignmentState:
title: licenseAssignmentState
type: object
properties:
assignedByGroup:
type: string
nullable: true
disabledPlans:
type: array
items:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
error:
type: string
nullable: true
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
format: uuid
nullable: true
state:
type: string
nullable: true
additionalProperties:
type: object
microsoft.graph.onPremisesExtensionAttributes:
title: onPremisesExtensionAttributes
type: object
properties:
extensionAttribute1:
type: string
description: First customizable extension attribute.
nullable: true
extensionAttribute10:
type: string
description: Tenth customizable extension attribute.
nullable: true
extensionAttribute11:
type: string
description: Eleventh customizable extension attribute.
nullable: true
extensionAttribute12:
type: string
description: Twelfth customizable extension attribute.
nullable: true
extensionAttribute13:
type: string
description: Thirteenth customizable extension attribute.
nullable: true
extensionAttribute14:
type: string
description: Fourteenth customizable extension attribute.
nullable: true
extensionAttribute15:
type: string
description: Fifteenth customizable extension attribute.
nullable: true
extensionAttribute2:
type: string
description: Second customizable extension attribute.
nullable: true
extensionAttribute3:
type: string
description: Third customizable extension attribute.
nullable: true
extensionAttribute4:
type: string
description: Fourth customizable extension attribute.
nullable: true
extensionAttribute5:
type: string
description: Fifth customizable extension attribute.
nullable: true
extensionAttribute6:
type: string
description: Sixth customizable extension attribute.
nullable: true
extensionAttribute7:
type: string
description: Seventh customizable extension attribute.
nullable: true
extensionAttribute8:
type: string
description: Eighth customizable extension attribute.
nullable: true
extensionAttribute9:
type: string
description: Ninth customizable extension attribute.
nullable: true
additionalProperties:
type: object
microsoft.graph.passwordProfile:
title: passwordProfile
type: object
properties:
forceChangePasswordNextSignIn:
type: boolean
description: true if the user must change her password on the next login; otherwise false.
nullable: true
forceChangePasswordNextSignInWithMfa:
type: boolean
description: 'If true, at next sign-in, the user must perform a multi-factor 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 multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.'
nullable: true
password:
type: string
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 login. The password must satisfy minimum requirements as specified by the user’s passwordPolicies property. By default, a strong password is required.'
nullable: true
additionalProperties:
type: object
microsoft.graph.provisionedPlan:
title: provisionedPlan
type: object
properties:
capabilityStatus:
type: string
description: 'For example, ''Enabled''.'
nullable: true
provisioningStatus:
type: string
description: 'For example, ''Success''.'
nullable: true
service:
type: string
description: 'The name of the service; for example, ''AccessControlS2S'''
nullable: true
additionalProperties:
type: object
microsoft.graph.mailboxSettings:
title: mailboxSettings
type: object
properties:
archiveFolder:
type: string
description: Folder ID of an archive folder for the user.
nullable: true
automaticRepliesSetting:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
dateFormat:
type: string
description: The date format for the user's mailbox.
nullable: true
delegateMeetingMessageDeliveryOptions:
$ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions'
language:
$ref: '#/components/schemas/microsoft.graph.localeInfo'
timeFormat:
type: string
description: The time format for the user's mailbox.
nullable: true
timeZone:
type: string
description: The default time zone for the user's mailbox.
nullable: true
userPurpose:
$ref: '#/components/schemas/microsoft.graph.userPurpose'
workingHours:
$ref: '#/components/schemas/microsoft.graph.workingHours'
additionalProperties:
type: object
microsoft.graph.licenseDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: licenseDetails
type: object
properties:
servicePlans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.servicePlanInfo'
description: 'Information about the service plans assigned with the license. Read-only, Not nullable'
skuId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related SubscribedSku object. Read-only
format: uuid
nullable: true
skuPartNumber:
type: string
description: 'Unique SKU display name. Equal to the skuPartNumber on the related SubscribedSku object; for example: ''AAD_Premium''. Read-only'
nullable: true
additionalProperties:
type: object
microsoft.graph.oAuth2PermissionGrant:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: oAuth2PermissionGrant
type: object
properties:
clientId:
type: string
description: The id of the client service principal for the application which is authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).
consentType:
type: string
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. Non-admin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).'
nullable: true
principalId:
type: string
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).'
nullable: true
resourceId:
type: string
description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).
scope:
type: string
description: 'A space-separated list of the claim values for delegated permissions which 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 3850 characters in length.'
nullable: true
additionalProperties:
type: object
microsoft.graph.scopedRoleMembership:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: scopedRoleMembership
type: object
properties:
administrativeUnitId:
type: string
description: Unique identifier for the administrative unit that the directory role is scoped to
roleId:
type: string
description: Unique identifier for the directory role that the member is in.
roleMemberInfo:
$ref: '#/components/schemas/microsoft.graph.identity'
additionalProperties:
type: object
microsoft.graph.calendarGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: calendarGroup
type: object
properties:
changeKey:
type: string
description: 'Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.'
nullable: true
classId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The class identifier. Read-only.
format: uuid
nullable: true
name:
type: string
description: The group name.
nullable: true
calendars:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.calendar'
description: The calendars in the calendar group. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: contactFolder
type: object
properties:
displayName:
type: string
description: The folder's display name.
nullable: true
parentFolderId:
type: string
description: The ID of the folder's parent folder.
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contactFolder'
description: The collection of child folders in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
contacts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The contacts in the folder. Navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.contact:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: contact
type: object
properties:
assistantName:
type: string
description: The name of the contact's assistant.
nullable: true
birthday:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
businessAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
businessHomePage:
type: string
description: The business home page of the contact.
nullable: true
businessPhones:
type: array
items:
type: string
nullable: true
description: The contact's business phone numbers.
children:
type: array
items:
type: string
nullable: true
description: The names of the contact's children.
companyName:
type: string
description: The name of the contact's company.
nullable: true
department:
type: string
description: The contact's department.
nullable: true
displayName:
type: string
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.'
nullable: true
emailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
description: The contact's email addresses.
fileAs:
type: string
description: The name the contact is filed under.
nullable: true
generation:
type: string
description: The contact's generation.
nullable: true
givenName:
type: string
description: The contact's given name.
nullable: true
homeAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
homePhones:
type: array
items:
type: string
nullable: true
description: The contact's home phone numbers.
imAddresses:
type: array
items:
type: string
nullable: true
initials:
type: string
nullable: true
jobTitle:
type: string
nullable: true
manager:
type: string
nullable: true
middleName:
type: string
nullable: true
mobilePhone:
type: string
nullable: true
nickName:
type: string
nullable: true
officeLocation:
type: string
nullable: true
otherAddress:
$ref: '#/components/schemas/microsoft.graph.physicalAddress'
parentFolderId:
type: string
nullable: true
personalNotes:
type: string
nullable: true
profession:
type: string
nullable: true
spouseName:
type: string
nullable: true
surname:
type: string
nullable: true
title:
type: string
nullable: true
yomiCompanyName:
type: string
nullable: true
yomiGivenName:
type: string
nullable: true
yomiSurname:
type: string
nullable: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
photo:
$ref: '#/components/schemas/microsoft.graph.profilePhoto'
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the contact. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassification
type: object
properties:
overrides:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: mailFolder
type: object
properties:
childFolderCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of immediate child mailFolders in the current mailFolder.
format: int32
nullable: true
displayName:
type: string
description: The mailFolder's display name.
nullable: true
isHidden:
type: boolean
description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
nullable: true
parentFolderId:
type: string
description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
totalItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of items in the mailFolder.
format: int32
nullable: true
unreadItemCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of items in the mailFolder marked as unread.
format: int32
nullable: true
childFolders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.mailFolder'
description: The collection of child folders in the mailFolder.
x-ms-navigationProperty: true
messageRules:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.messageRule'
description: The collection of rules that apply to the user's Inbox folder.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.message'
description: The collection of messages in the mailFolder.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.message:
allOf:
- $ref: '#/components/schemas/microsoft.graph.outlookItem'
- title: message
type: object
properties:
bccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Bcc: recipients for the message.'
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyPreview:
type: string
description: The first 255 characters of the message body. It is in text format.
nullable: true
ccRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: 'The Cc: recipients for the message.'
conversationId:
type: string
description: The ID of the conversation the email belongs to.
nullable: true
conversationIndex:
type: string
description: Indicates the position of the message within the conversation.
format: base64url
nullable: true
flag:
$ref: '#/components/schemas/microsoft.graph.followupFlag'
from:
$ref: '#/components/schemas/microsoft.graph.recipient'
hasAttachments:
type: boolean
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 <IMG src=''cid:[email protected]''>.'
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
inferenceClassification:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
internetMessageHeaders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
internetMessageId:
type: string
nullable: true
isDeliveryReceiptRequested:
type: boolean
nullable: true
isDraft:
type: boolean
nullable: true
isRead:
type: boolean
nullable: true
isReadReceiptRequested:
type: boolean
nullable: true
parentFolderId:
type: string
nullable: true
receivedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
replyTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
sender:
$ref: '#/components/schemas/microsoft.graph.recipient'
sentDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
subject:
type: string
nullable: true
toRecipients:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
uniqueBody:
$ref: '#/components/schemas/microsoft.graph.itemBody'
webLink:
type: string
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachment'
description: The fileAttachment and itemAttachment attachments for the message.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the message. Nullable.
x-ms-navigationProperty: true
multiValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
description: The collection of multi-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
singleValueExtendedProperties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
description: The collection of single-value extended properties defined for the message. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.outlookUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookUser
type: object
properties:
masterCategories:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.outlookCategory'
description: A list of categories defined for the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.person:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: person
type: object
properties:
birthday:
type: string
description: The person's birthday.
nullable: true
companyName:
type: string
description: The name of the person's company.
nullable: true
department:
type: string
description: The person's department.
nullable: true
displayName:
type: string
description: The person's display name.
nullable: true
givenName:
type: string
description: The person's given name.
nullable: true
imAddress:
type: string
description: The instant message voice over IP (VOIP) session initiation protocol (SIP) address for the user. Read-only.
nullable: true
isFavorite:
type: boolean
description: true if the user has flagged this person as a favorite.
nullable: true
jobTitle:
type: string
description: The person's job title.
nullable: true
officeLocation:
type: string
description: The location of the person's office.
nullable: true
personNotes:
type: string
description: Free-form notes that the user has taken about this person.
nullable: true
personType:
$ref: '#/components/schemas/microsoft.graph.personType'
phones:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phone'
description: The person's phone numbers.
postalAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.location'
description: The person's addresses.
profession:
type: string
description: The person's profession.
nullable: true
scoredEmailAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.scoredEmailAddress'
description: The person's email addresses.
surname:
type: string
description: The person's surname.
nullable: true
userPrincipalName:
type: string
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.'
nullable: true
websites:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.website'
description: The person's websites.
yomiCompany:
type: string
description: The phonetic Japanese name of the person's company.
nullable: true
additionalProperties:
type: object
microsoft.graph.managedDevice:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedDevice
type: object
properties:
activationLockBypassCode:
type: string
description: 'The code that allows the Activation Lock on managed device to be bypassed. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity in LIST call. Individual GET call with select query options is needed to retrieve actual values. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
androidSecurityPatchLevel:
type: string
description: Android security patch level. This property is read-only.
nullable: true
readOnly: true
azureADDeviceId:
type: string
description: The unique identifier for the Azure Active Directory device. Read only. This property is read-only.
nullable: true
readOnly: true
azureADRegistered:
type: boolean
description: Whether the device is Azure Active Directory registered. This property is read-only.
nullable: true
readOnly: true
complianceGracePeriodExpirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime when device compliance grace period expires. This property is read-only.
format: date-time
readOnly: true
complianceState:
$ref: '#/components/schemas/microsoft.graph.complianceState'
configurationManagerClientEnabledFeatures:
$ref: '#/components/schemas/microsoft.graph.configurationManagerClientEnabledFeatures'
deviceActionResults:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceActionResult'
description: List of ComplexType deviceActionResult objects. This property is read-only.
readOnly: true
deviceCategoryDisplayName:
type: string
description: Device category display name. This property is read-only.
nullable: true
readOnly: true
deviceEnrollmentType:
$ref: '#/components/schemas/microsoft.graph.deviceEnrollmentType'
deviceHealthAttestationState:
$ref: '#/components/schemas/microsoft.graph.deviceHealthAttestationState'
deviceName:
type: string
description: Name of the device. This property is read-only.
nullable: true
readOnly: true
deviceRegistrationState:
$ref: '#/components/schemas/microsoft.graph.deviceRegistrationState'
easActivated:
type: boolean
description: Whether the device is Exchange ActiveSync activated. This property is read-only.
readOnly: true
easActivationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Exchange ActivationSync activation time of the device. This property is read-only.
format: date-time
readOnly: true
easDeviceId:
type: string
description: Exchange ActiveSync Id of the device. This property is read-only.
nullable: true
readOnly: true
emailAddress:
type: string
description: Email(s) for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
enrolledDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Enrollment time of the device. This property is read-only.
format: date-time
readOnly: true
ethernetMacAddress:
type: string
description: 'Indicates Ethernet MAC Address of the device. Default, is Null (Non-Default property) for this property when returned as part of managedDevice entity. Individual get call with select query options is needed to retrieve actual values. Example: deviceManagement/managedDevices({managedDeviceId})?$select=ethernetMacAddress Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
exchangeAccessState:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessState'
exchangeAccessStateReason:
$ref: '#/components/schemas/microsoft.graph.deviceManagementExchangeAccessStateReason'
exchangeLastSuccessfulSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last time the device contacted Exchange. This property is read-only.
format: date-time
readOnly: true
freeStorageSpaceInBytes:
type: integer
description: Free Storage in Bytes. Default value is 0. Read-only. This property is read-only.
format: int64
readOnly: true
iccid:
type: string
description: 'Integrated Circuit Card Identifier, it is A SIM card''s unique identification number. Return default value null in LIST managedDevices. Real value only returned in singel device GET call with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
imei:
type: string
description: IMEI. This property is read-only.
nullable: true
readOnly: true
isEncrypted:
type: boolean
description: Device encryption status. This property is read-only.
readOnly: true
isSupervised:
type: boolean
description: Device supervised status. This property is read-only.
readOnly: true
jailBroken:
type: string
description: whether the device is jail broken or rooted. This property is read-only.
nullable: true
readOnly: true
lastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time that the device last completed a successful sync with Intune. This property is read-only.
format: date-time
readOnly: true
managedDeviceName:
type: string
description: Automatically generated name to identify a device. Can be overwritten to a user friendly name.
nullable: true
managedDeviceOwnerType:
$ref: '#/components/schemas/microsoft.graph.managedDeviceOwnerType'
managementAgent:
$ref: '#/components/schemas/microsoft.graph.managementAgentType'
managementCertificateExpirationDate:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Reports device management certificate expiration date. This property is read-only.
format: date-time
readOnly: true
manufacturer:
type: string
description: Manufacturer of the device. This property is read-only.
nullable: true
readOnly: true
meid:
type: string
description: MEID. This property is read-only.
nullable: true
readOnly: true
model:
type: string
description: Model of the device. This property is read-only.
nullable: true
readOnly: true
notes:
type: string
description: 'Notes on the device created by IT Admin. Return default value null in LIST managedDevices. Real value only returned in singel device GET call with device id and included in select parameter. Supports: $select. $Search is not supported.'
nullable: true
operatingSystem:
type: string
description: 'Operating system of the device. Windows, iOS, etc. This property is read-only.'
nullable: true
readOnly: true
osVersion:
type: string
description: Operating system version of the device. This property is read-only.
nullable: true
readOnly: true
partnerReportedThreatState:
$ref: '#/components/schemas/microsoft.graph.managedDevicePartnerReportedHealthState'
phoneNumber:
type: string
description: Phone number of the device. This property is read-only.
nullable: true
readOnly: true
physicalMemoryInBytes:
type: integer
description: 'Total Memory in Bytes. Return default value 0 in LIST managedDevices. Real value only returned in singel device GET call with device id and included in select parameter. Supports: $select. Default value is 0. Read-only. This property is read-only.'
format: int64
readOnly: true
remoteAssistanceSessionErrorDetails:
type: string
description: An error string that identifies issues when creating Remote Assistance session objects. This property is read-only.
nullable: true
readOnly: true
remoteAssistanceSessionUrl:
type: string
description: Url that allows a Remote Assistance session to be established with the device. This property is read-only.
nullable: true
readOnly: true
requireUserEnrollmentApproval:
type: boolean
description: Reports if the managed iOS device is user approval enrollment. This property is read-only.
nullable: true
readOnly: true
serialNumber:
type: string
description: SerialNumber. This property is read-only.
nullable: true
readOnly: true
subscriberCarrier:
type: string
description: Subscriber Carrier. This property is read-only.
nullable: true
readOnly: true
totalStorageSpaceInBytes:
type: integer
description: Total Storage in Bytes. This property is read-only.
format: int64
readOnly: true
udid:
type: string
description: 'Unique Device Identifier for iOS and macOS devices. Return default value null in LIST managedDevices. Real value only returned in singel device GET call with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.'
nullable: true
readOnly: true
userDisplayName:
type: string
description: User display name. This property is read-only.
nullable: true
readOnly: true
userId:
type: string
description: Unique Identifier for the user associated with the device. This property is read-only.
nullable: true
readOnly: true
userPrincipalName:
type: string
description: Device user principal name. This property is read-only.
nullable: true
readOnly: true
wiFiMacAddress:
type: string
description: Wi-Fi MAC. This property is read-only.
nullable: true
readOnly: true
deviceCompliancePolicyStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicyState'
description: Device compliance policy states for this device.
x-ms-navigationProperty: true
deviceConfigurationStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
description: Device configuration states for this device.
x-ms-navigationProperty: true
deviceCategory:
$ref: '#/components/schemas/microsoft.graph.deviceCategory'
users:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.user'
description: The primary users associated with the managed device.
x-ms-navigationProperty: true
additionalProperties:
type: object
description: Devices that are managed or pre-enrolled through Intune
microsoft.graph.managedAppRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppRegistration
type: object
properties:
appIdentifier:
$ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
applicationVersion:
type: string
description: App version
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of creation
format: date-time
deviceName:
type: string
description: Host device name
nullable: true
deviceTag:
type: string
description: 'App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.'
nullable: true
deviceType:
type: string
description: Host device type
nullable: true
flaggedReasons:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
lastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of last the app synced with management service.
format: date-time
managementSdkVersion:
type: string
description: App management SDK version
nullable: true
platformVersion:
type: string
description: Operating System version
nullable: true
userId:
type: string
description: The user Id to who this app registration belongs.
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
appliedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
x-ms-navigationProperty: true
intendedPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
description: Zero or more policies admin intended for the app as of now.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.managedAppOperation'
description: Zero or more long running operations triggered on the app registration.
x-ms-navigationProperty: true
additionalProperties:
type: object
description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
microsoft.graph.deviceManagementTroubleshootingEvent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceManagementTroubleshootingEvent
type: object
properties:
correlationId:
type: string
description: Id used for tracing the failure in the service.
nullable: true
eventDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time when the event occurred .
format: date-time
additionalProperties:
type: object
description: Event representing an general failure.
microsoft.graph.plannerUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerUser
type: object
properties:
plans:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerPlan'
description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.plannerTask'
description: Read-only. Nullable. Returns the plannerPlans shared with the user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.officeGraphInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: officeGraphInsights
type: object
properties:
shared:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharedInsight'
description: 'Calculated relationship identifying documents shared with or by the user. This includes URLs, file attachments, and reference attachments to OneDrive for Business and SharePoint files found in Outlook messages and meetings. This also includes URLs and reference attachments to Teams conversations. Ordered by recency of share.'
x-ms-navigationProperty: true
trending:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.trending'
description: 'Calculated relationship identifying 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 Business and SharePoint. Trending insights help the user to discover potentially useful content that the user has access to, but has never viewed before.'
x-ms-navigationProperty: true
used:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.usedInsight'
description: 'Calculated relationship identifying the latest documents viewed or modified by a user, including OneDrive for Business and SharePoint documents, ranked by recency of use.'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userSettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userSettings
type: object
properties:
contributionToContentDiscoveryAsOrganizationDisabled:
type: boolean
contributionToContentDiscoveryDisabled:
type: boolean
shiftPreferences:
$ref: '#/components/schemas/microsoft.graph.shiftPreferences'
additionalProperties:
type: object
microsoft.graph.userActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userActivity
type: object
properties:
activationUrl:
type: string
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.
activitySourceHost:
type: string
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.'
appActivityId:
type: string
description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
appDisplayName:
type: string
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.
nullable: true
contentInfo:
$ref: '#/components/schemas/microsoft.graph.Json'
contentUrl:
type: string
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).'
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object expired on the server.
format: date-time
nullable: true
fallbackUrl:
type: string
description: 'Optional. URL used to launch the activity in a web-based app, if available.'
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
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.
nullable: true
visualElements:
$ref: '#/components/schemas/microsoft.graph.visualInfo'
historyItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
description: Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.onlineMeeting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: onlineMeeting
type: object
properties:
allowAttendeeToEnableCamera:
type: boolean
description: Indicates whether attendees can turn on their camera.
nullable: true
allowAttendeeToEnableMic:
type: boolean
description: Indicates whether attendees can turn on their microphone.
nullable: true
allowedPresenters:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingPresenters'
allowMeetingChat:
$ref: '#/components/schemas/microsoft.graph.meetingChatMode'
allowTeamworkReactions:
type: boolean
description: Indicates whether Teams reactions are enabled for the meeting.
nullable: true
attendeeReport:
type: string
description: The content stream of the attendee report of a Microsoft Teams live event. Read-only.
format: base64url
nullable: true
audioConferencing:
$ref: '#/components/schemas/microsoft.graph.audioConferencing'
broadcastSettings:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingSettings'
chatInfo:
$ref: '#/components/schemas/microsoft.graph.chatInfo'
creationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The meeting creation time in UTC. Read-only.
format: date-time
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The meeting end time in UTC.
format: date-time
nullable: true
externalId:
type: string
nullable: true
isBroadcast:
type: boolean
description: Indicates if this is a Teams live event.
nullable: true
isEntryExitAnnounced:
type: boolean
description: Indicates whether to announce when callers join or leave.
nullable: true
joinInformation:
$ref: '#/components/schemas/microsoft.graph.itemBody'
joinMeetingIdSettings:
$ref: '#/components/schemas/microsoft.graph.joinMeetingIdSettings'
joinWebUrl:
type: string
description: The join URL of the online meeting. Read-only.
nullable: true
lobbyBypassSettings:
$ref: '#/components/schemas/microsoft.graph.lobbyBypassSettings'
participants:
$ref: '#/components/schemas/microsoft.graph.meetingParticipants'
recordAutomatically:
type: boolean
description: Indicates whether to record the meeting automatically.
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The meeting start time in UTC.
format: date-time
nullable: true
subject:
type: string
description: The subject of the online meeting.
nullable: true
videoTeleconferenceId:
type: string
description: The video teleconferencing ID. Read-only.
nullable: true
watermarkProtection:
$ref: '#/components/schemas/microsoft.graph.watermarkProtectionValues'
attendanceReports:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
description: The attendance reports of an online meeting. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.presence:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: presence
type: object
properties:
activity:
type: string
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.'
nullable: true
availability:
type: string
description: 'The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown'
nullable: true
additionalProperties:
type: object
microsoft.graph.authentication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authentication
type: object
properties:
emailMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
description: The email address registered to a user for authentication.
x-ms-navigationProperty: true
fido2Methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
description: Represents the FIDO2 security keys registered to a user for authentication.
x-ms-navigationProperty: true
methods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.authenticationMethod'
description: Represents all authentication methods registered to a user.
x-ms-navigationProperty: true
microsoftAuthenticatorMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
description: The details of the Microsoft Authenticator app registered to a user for authentication.
x-ms-navigationProperty: true
operations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.longRunningOperation'
description: Represents the status of a long-running operation.
x-ms-navigationProperty: true
passwordMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
description: 'Represents the password that''s registered to a user for authentication. For security, the password itself will never be returned in the object, but action can be taken to reset a password.'
x-ms-navigationProperty: true
phoneMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
description: The phone numbers registered to a user for authentication.
x-ms-navigationProperty: true
softwareOathMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
description: The software OATH TOTP applications registered to a user for authentication.
x-ms-navigationProperty: true
temporaryAccessPassMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
x-ms-navigationProperty: true
windowsHelloForBusinessMethods:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.chat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chat
type: object
properties:
chatType:
$ref: '#/components/schemas/microsoft.graph.chatType'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time at which the chat was created. Read-only.
format: date-time
nullable: true
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time at which the chat was renamed or list of members were last changed. Read-only.
format: date-time
nullable: true
onlineMeetingInfo:
$ref: '#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo'
tenantId:
type: string
description: The identifier of the tenant in which the chat was created. Read-only.
nullable: true
topic:
type: string
description: (Optional) Subject or topic for the chat. Only available for group chats.
nullable: true
viewpoint:
$ref: '#/components/schemas/microsoft.graph.chatViewpoint'
webUrl:
type: string
description: 'The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
description: A collection of all the apps in the chat. Nullable.
x-ms-navigationProperty: true
lastMessagePreview:
$ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.conversationMember'
description: A collection of all the members in the chat. Nullable.
x-ms-navigationProperty: true
messages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
description: A collection of all the messages in the chat. Nullable.
x-ms-navigationProperty: true
pinnedMessages:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
description: A collection of all the pinned messages in the chat. Nullable.
x-ms-navigationProperty: true
tabs:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.teamsTab'
description: A collection of all the tabs in the chat. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.userTeamwork:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: userTeamwork
type: object
properties:
associatedTeams:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
description: The list of associatedTeamInfo objects that a user is associated with.
x-ms-navigationProperty: true
installedApps:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
description: The apps installed in the personal scope of this user.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.todo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todo
type: object
properties:
lists:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTaskList'
description: The task lists in the users mailbox.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.album:
title: album
type: object
properties:
coverImageItemId:
type: string
description: 'Unique identifier of the [driveItem][] that is the cover of the album.'
nullable: true
additionalProperties:
type: object
microsoft.graph.hashes:
title: hashes
type: object
properties:
crc32Hash:
type: string
description: The CRC32 value of the file in little endian (if available). Read-only.
nullable: true
quickXorHash:
type: string
description: A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available). Read-only.
nullable: true
sha1Hash:
type: string
description: SHA1 hash for the contents of the file (if available). Read-only.
nullable: true
sha256Hash:
type: string
description: SHA256 hash for the contents of the file (if available). Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.folderView:
title: folderView
type: object
properties:
sortBy:
type: string
description: The method by which the folder should be sorted.
nullable: true
sortOrder:
type: string
description: 'If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending.'
nullable: true
viewType:
type: string
description: The type of view that should be used to represent the folder.
nullable: true
additionalProperties:
type: object
microsoft.graph.pendingContentUpdate:
title: pendingContentUpdate
type: object
properties:
queuedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time the pending binary operation was queued in UTC time. Read-only.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.workbookApplication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookApplication
type: object
properties:
calculationMode:
type: string
description: 'Returns the calculation mode used in the workbook. Possible values are: Automatic, AutomaticExceptTables, Manual.'
additionalProperties:
type: object
microsoft.graph.workbookComment:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookComment
type: object
properties:
content:
type: string
description: The content of comment.
nullable: true
contentType:
type: string
description: Indicates the type for the comment.
replies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookCommentReply'
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workbookFunctions:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookFunctions
type: object
additionalProperties:
type: object
microsoft.graph.workbookNamedItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookNamedItem
type: object
properties:
comment:
type: string
description: Represents the comment associated with this name.
nullable: true
name:
type: string
description: The name of the object. Read-only.
nullable: true
scope:
type: string
description: Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.
type:
type: string
description: 'Indicates what type of reference is associated with the name. The possible values are: String, Integer, Double, Boolean, Range. Read-only.'
nullable: true
value:
$ref: '#/components/schemas/microsoft.graph.Json'
visible:
type: boolean
description: Specifies whether the object is visible or not.
worksheet:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
additionalProperties:
type: object
microsoft.graph.workbookOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookOperation
type: object
properties:
error:
$ref: '#/components/schemas/microsoft.graph.workbookOperationError'
resourceLocation:
type: string
description: The resource URI for the result.
nullable: true
status:
$ref: '#/components/schemas/microsoft.graph.workbookOperationStatus'
additionalProperties:
type: object
microsoft.graph.workbookTable:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTable
type: object
properties:
highlightFirstColumn:
type: boolean
description: Indicates whether the first column contains special formatting.
highlightLastColumn:
type: boolean
description: Indicates whether the last column contains special formatting.
legacyId:
type: string
description: Legacy Id used in older Excle clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and should not be parsed to any other type. Read-only.
nullable: true
name:
type: string
description: Name of the table.
nullable: true
showBandedColumns:
type: boolean
description: Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.
showBandedRows:
type: boolean
description: Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.
showFilterButton:
type: boolean
description: Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.
showHeaders:
type: boolean
description: Indicates whether the header row is visible or not. This value can be set to show or remove the header row.
showTotals:
type: boolean
description: Indicates whether the total row is visible or not. This value can be set to show or remove the total row.
style:
type: string
description: 'Constant value that represents the Table style. The possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.'
nullable: true
columns:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTableColumn'
description: Represents a collection of all the columns in the table. Read-only.
x-ms-navigationProperty: true
rows:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTableRow'
description: Represents a collection of all the rows in the table. Read-only.
x-ms-navigationProperty: true
sort:
$ref: '#/components/schemas/microsoft.graph.workbookTableSort'
worksheet:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
additionalProperties:
type: object
microsoft.graph.workbookWorksheet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheet
type: object
properties:
name:
type: string
description: The display name of the worksheet.
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The zero-based position of the worksheet within the workbook.
format: int32
visibility:
type: string
description: 'The Visibility of the worksheet. The possible values are: Visible, Hidden, VeryHidden.'
charts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChart'
description: Returns collection of charts that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: Returns collection of names that are associated with the worksheet. Read-only.
x-ms-navigationProperty: true
pivotTables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookPivotTable'
description: Collection of PivotTables that are part of the worksheet.
x-ms-navigationProperty: true
protection:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtection'
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: Collection of tables that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.documentSetVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.listItemVersion'
- title: documentSetVersion
type: object
properties:
comment:
type: string
description: Comment about the captured version.
nullable: true
createdBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time when this version was created.
format: date-time
nullable: true
items:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.documentSetVersionItem'
description: Items within the document set that are captured as part of this version.
shouldCaptureMinorVersion:
type: boolean
description: 'If true, minor versions of items are also captured; otherwise, only major versions will be captured. Default value is false.'
nullable: true
additionalProperties:
type: object
microsoft.graph.fieldValueSet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: fieldValueSet
type: object
additionalProperties:
type: object
microsoft.graph.listItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- title: listItemVersion
type: object
properties:
fields:
$ref: '#/components/schemas/microsoft.graph.fieldValueSet'
additionalProperties:
type: object
microsoft.graph.thumbnail:
title: thumbnail
type: object
properties:
content:
type: string
description: The content stream for the thumbnail.
format: base64url
nullable: true
height:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'The height of the thumbnail, in pixels.'
format: int32
nullable: true
sourceItemId:
type: string
description: The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested.
nullable: true
url:
type: string
description: The URL used to fetch the thumbnail content.
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'The width of the thumbnail, in pixels.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.baseItemVersion:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: baseItemVersion
type: object
properties:
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time the version was last modified. Read-only.
format: date-time
nullable: true
publication:
$ref: '#/components/schemas/microsoft.graph.publicationFacet'
additionalProperties:
type: object
microsoft.graph.itemActionStat:
title: itemActionStat
type: object
properties:
actionCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of times the action took place. Read-only.
format: int32
nullable: true
actorCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The number of distinct actors that performed the action. Read-only.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.incompleteData:
title: incompleteData
type: object
properties:
missingDataBeforeDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The service does not have source data before the specified time.
format: date-time
nullable: true
wasThrottled:
type: boolean
description: Some data was not recorded due to excessive activity.
nullable: true
additionalProperties:
type: object
microsoft.graph.itemActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: itemActivity
type: object
properties:
access:
$ref: '#/components/schemas/microsoft.graph.accessAction'
activityDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Details about when the activity took place. Read-only.
format: date-time
nullable: true
actor:
$ref: '#/components/schemas/microsoft.graph.identitySet'
driveItem:
$ref: '#/components/schemas/microsoft.graph.driveItem'
additionalProperties:
type: object
microsoft.graph.termStore.term:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: term
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date and time of term creation. Read-only.
format: date-time
nullable: true
descriptions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.localizedDescription'
description: Description about term that is dependent on the languageTag.
labels:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.localizedLabel'
description: Label metadata for a term.
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last date and time of term modification. Read-only.
format: date-time
nullable: true
properties:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.keyValue'
description: Collection of properties on the term.
children:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
description: Children of current term.
x-ms-navigationProperty: true
relations:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.termStore.relation'
description: To indicate which terms are related to the current term as either pinned or reused.
x-ms-navigationProperty: true
set:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
additionalProperties:
type: object
microsoft.graph.displayNameLocalization:
title: displayNameLocalization
type: object
properties:
displayName:
type: string
description: 'If present, the value of this field contains the displayName string that has been set for the language present in the languageTag field.'
nullable: true
languageTag:
type: string
description: Provides the language culture-code and friendly name of the language that the displayName field has been provided in.
nullable: true
additionalProperties:
type: object
microsoft.graph.longRunningOperationStatus:
title: longRunningOperationStatus
enum:
- notStarted
- running
- succeeded
- failed
- unknownFutureValue
type: string
microsoft.graph.sharePointIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: sharePointIdentity
type: object
properties:
loginName:
type: string
description: The sign in name of the SharePoint identity.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.termGroupScope:
title: termGroupScope
enum:
- global
- system
- siteCollection
- unknownFutureValue
type: string
microsoft.graph.termStore.localizedName:
title: localizedName
type: object
properties:
languageTag:
type: string
description: The language tag for the label.
nullable: true
name:
type: string
description: The name in the localized language.
nullable: true
additionalProperties:
type: object
microsoft.graph.keyValue:
title: keyValue
type: object
properties:
key:
type: string
description: Key for the key-value pair.
nullable: true
value:
type: string
description: Value for the key-value pair.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.relation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: relation
type: object
properties:
relationship:
$ref: '#/components/schemas/microsoft.graph.termStore.relationType'
fromTerm:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
set:
$ref: '#/components/schemas/microsoft.graph.termStore.set'
toTerm:
$ref: '#/components/schemas/microsoft.graph.termStore.term'
additionalProperties:
type: object
microsoft.graph.plannerContainerType:
title: plannerContainerType
enum:
- group
- unknownFutureValue
- roster
type: string
microsoft.graph.plannerCategoryDescriptions:
title: plannerCategoryDescriptions
type: object
properties:
category1:
type: string
description: The label associated with Category 1
nullable: true
category10:
type: string
description: The label associated with Category 10
nullable: true
category11:
type: string
description: The label associated with Category 11
nullable: true
category12:
type: string
description: The label associated with Category 12
nullable: true
category13:
type: string
description: The label associated with Category 13
nullable: true
category14:
type: string
description: The label associated with Category 14
nullable: true
category15:
type: string
description: The label associated with Category 15
nullable: true
category16:
type: string
description: The label associated with Category 16
nullable: true
category17:
type: string
description: The label associated with Category 17
nullable: true
category18:
type: string
description: The label associated with Category 18
nullable: true
category19:
type: string
description: The label associated with Category 19
nullable: true
category2:
type: string
description: The label associated with Category 2
nullable: true
category20:
type: string
description: The label associated with Category 20
nullable: true
category21:
type: string
description: The label associated with Category 21
nullable: true
category22:
type: string
description: The label associated with Category 22
nullable: true
category23:
type: string
description: The label associated with Category 23
nullable: true
category24:
type: string
description: The label associated with Category 24
nullable: true
category25:
type: string
description: The label associated with Category 25
nullable: true
category3:
type: string
description: The label associated with Category 3
nullable: true
category4:
type: string
description: The label associated with Category 4
nullable: true
category5:
type: string
description: The label associated with Category 5
nullable: true
category6:
type: string
description: The label associated with Category 6
nullable: true
category7:
type: string
description: The label associated with Category 7
nullable: true
category8:
type: string
description: The label associated with Category 8
nullable: true
category9:
type: string
description: The label associated with Category 9
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerUserIds:
title: plannerUserIds
type: object
additionalProperties:
type: object
microsoft.graph.plannerAppliedCategories:
title: plannerAppliedCategories
type: object
additionalProperties:
type: object
microsoft.graph.plannerAssignments:
title: plannerAssignments
type: object
additionalProperties:
type: object
microsoft.graph.plannerPreviewType:
title: plannerPreviewType
enum:
- automatic
- noPreview
- checklist
- description
- reference
type: string
microsoft.graph.plannerAssignedToTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerAssignedToTaskBoardTaskFormat
type: object
properties:
orderHintsByAssignee:
$ref: '#/components/schemas/microsoft.graph.plannerOrderHintsByAssignee'
unassignedOrderHint:
type: string
description: 'Hint value used to order the task on the AssignedTo view of the Task Board when the task is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined here.'
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerBucketTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerBucketTaskBoardTaskFormat
type: object
properties:
orderHint:
type: string
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.'
nullable: true
additionalProperties:
type: object
microsoft.graph.plannerTaskDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerTaskDetails
type: object
properties:
checklist:
$ref: '#/components/schemas/microsoft.graph.plannerChecklistItems'
description:
type: string
description: Description of the task.
nullable: true
previewType:
$ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
references:
$ref: '#/components/schemas/microsoft.graph.plannerExternalReferences'
additionalProperties:
type: object
microsoft.graph.plannerProgressTaskBoardTaskFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: plannerProgressTaskBoardTaskFormat
type: object
properties:
orderHint:
type: string
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.'
nullable: true
additionalProperties:
type: object
microsoft.graph.externalLink:
title: externalLink
type: object
properties:
href:
type: string
description: The URL of the link.
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageAttachment:
title: chatMessageAttachment
type: object
properties:
content:
type: string
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.'
nullable: true
contentType:
type: string
description: 'The media type of the content attachment. It can have the following values: reference: Attachment is a link to another file. Populate the contentURL with the link to the object.Any contentTypes supported by the Bot Framework''s Attachment objectapplication/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.'
nullable: true
contentUrl:
type: string
description: 'URL for the content of the attachment. Supported protocols: http, https, file and data.'
nullable: true
id:
type: string
description: Read-only. Unique id of the attachment.
nullable: true
name:
type: string
description: Name of the attachment.
nullable: true
teamsAppId:
type: string
description: The ID of the Teams app that is associated with the attachment. The property is specifically used to attribute a Teams message card to the specified app.
nullable: true
thumbnailUrl:
type: string
description: '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 clicks the image, the channel would open the document.'
nullable: true
additionalProperties:
type: object
microsoft.graph.channelIdentity:
title: channelIdentity
type: object
properties:
channelId:
type: string
description: The identity of the channel in which the message was posted.
nullable: true
teamId:
type: string
description: The identity of the team in which the message was posted.
nullable: true
additionalProperties:
type: object
microsoft.graph.eventMessageDetail:
title: eventMessageDetail
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageFromIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: chatMessageFromIdentitySet
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageImportance:
title: chatMessageImportance
enum:
- normal
- high
- urgent
- unknownFutureValue
type: string
microsoft.graph.chatMessageMention:
title: chatMessageMention
type: object
properties:
id:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding <at id=''{index}''> tag in the message body.'
format: int32
nullable: true
mentioned:
$ref: '#/components/schemas/microsoft.graph.chatMessageMentionedIdentitySet'
mentionText:
type: string
description: 'String used to represent the mention. For example, a user''s display name, a team name.'
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageHistoryItem:
title: chatMessageHistoryItem
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.chatMessageActions'
modifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the message was modified.
format: date-time
reaction:
$ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
additionalProperties:
type: object
microsoft.graph.chatMessageType:
title: chatMessageType
enum:
- message
- chatEvent
- typing
- unknownFutureValue
- systemEventMessage
type: string
microsoft.graph.chatMessagePolicyViolation:
title: chatMessagePolicyViolation
type: object
properties:
dlpAction:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationDlpActionTypes'
justificationText:
type: string
description: Justification text provided by the sender of the message when overriding a policy violation.
nullable: true
policyTip:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationPolicyTip'
userAction:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationUserActionTypes'
verdictDetails:
$ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationVerdictDetailsTypes'
additionalProperties:
type: object
microsoft.graph.chatMessageReaction:
title: chatMessageReaction
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
reactionType:
type: string
description: 'Supported values are like, angry, sad, laugh, heart, surprised.'
user:
$ref: '#/components/schemas/microsoft.graph.chatMessageReactionIdentitySet'
additionalProperties:
type: object
microsoft.graph.chatMessageHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamworkHostedContent'
- title: chatMessageHostedContent
type: object
additionalProperties:
type: object
microsoft.graph.teamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamInfo
type: object
properties:
displayName:
type: string
description: The name of the team.
nullable: true
tenantId:
type: string
description: The ID of the Azure Active Directory tenant.
nullable: true
team:
$ref: '#/components/schemas/microsoft.graph.team'
additionalProperties:
type: object
microsoft.graph.teamsTabConfiguration:
title: teamsTabConfiguration
type: object
properties:
contentUrl:
type: string
description: Url used for rendering tab contents in Teams. Required.
nullable: true
entityId:
type: string
description: Identifier for the entity hosted by the tab provider.
nullable: true
removeUrl:
type: string
description: Url called by Teams client when a Tab is removed using the Teams Client.
nullable: true
websiteUrl:
type: string
description: Url for showing tab contents outside of Teams.
nullable: true
additionalProperties:
type: object
microsoft.graph.teamsAppDistributionMethod:
title: teamsAppDistributionMethod
enum:
- store
- organization
- sideloaded
- unknownFutureValue
type: string
microsoft.graph.teamsAppPublishingState:
title: teamsAppPublishingState
enum:
- submitted
- rejected
- published
- unknownFutureValue
type: string
microsoft.graph.teamworkBot:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkBot
type: object
additionalProperties:
type: object
microsoft.graph.scheduleChangeRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: scheduleChangeRequest
type: object
properties:
assignedTo:
$ref: '#/components/schemas/microsoft.graph.scheduleChangeRequestActor'
managerActionDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
readOnly: true
managerActionMessage:
type: string
nullable: true
managerUserId:
type: string
nullable: true
readOnly: true
senderDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
readOnly: true
senderMessage:
type: string
nullable: true
senderUserId:
type: string
nullable: true
readOnly: true
state:
$ref: '#/components/schemas/microsoft.graph.scheduleChangeState'
additionalProperties:
type: object
microsoft.graph.changeTrackedEntity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: changeTrackedEntity
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
readOnly: true
lastModifiedBy:
$ref: '#/components/schemas/microsoft.graph.identitySet'
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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'
format: date-time
nullable: true
readOnly: true
additionalProperties:
type: object
microsoft.graph.openShiftItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.shiftItem'
- title: openShiftItem
type: object
properties:
openSlotCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Count of the number of slots for the given open shift.
format: int32
additionalProperties:
type: object
microsoft.graph.shiftItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleEntity'
- title: shiftItem
type: object
properties:
activities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shiftActivity'
description: 'An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. Required.'
displayName:
type: string
description: The shift label of the shiftItem.
nullable: true
notes:
type: string
description: The shift notes for the shiftItem.
nullable: true
additionalProperties:
type: object
microsoft.graph.timeOffReasonIconType:
title: timeOffReasonIconType
enum:
- none
- car
- calendar
- running
- plane
- firstAid
- doctor
- notWorking
- clock
- juryDuty
- globe
- cup
- phone
- weather
- umbrella
- piggyBank
- dog
- cake
- trafficCone
- pin
- sunny
- unknownFutureValue
type: string
microsoft.graph.timeOffItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.scheduleEntity'
- title: timeOffItem
type: object
properties:
timeOffReasonId:
type: string
description: ID of the timeOffReason for this timeOffItem. Required.
nullable: true
additionalProperties:
type: object
microsoft.graph.automaticRepliesSetting:
title: automaticRepliesSetting
type: object
properties:
externalAudience:
$ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
externalReplyMessage:
type: string
description: 'The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.'
nullable: true
internalReplyMessage:
type: string
description: 'The automatic reply to send to the audience internal to the signed-in user''s organization, if Status is AlwaysEnabled or Scheduled.'
nullable: true
scheduledEndDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
scheduledStartDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
status:
$ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
additionalProperties:
type: object
microsoft.graph.delegateMeetingMessageDeliveryOptions:
title: delegateMeetingMessageDeliveryOptions
enum:
- sendToDelegateAndInformationToPrincipal
- sendToDelegateAndPrincipal
- sendToDelegateOnly
type: string
microsoft.graph.localeInfo:
title: localeInfo
type: object
properties:
displayName:
type: string
description: 'A name representing the user''s locale in natural language, for example, ''English (United States)''.'
nullable: true
locale:
type: string
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.'
nullable: true
additionalProperties:
type: object
microsoft.graph.userPurpose:
title: userPurpose
enum:
- user
- linked
- shared
- room
- equipment
- others
- unknownFutureValue
type: string
microsoft.graph.workingHours:
title: workingHours
type: object
properties:
daysOfWeek:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.dayOfWeek'
description: The days of the week on which the user works.
endTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user stops working.
format: time
nullable: true
startTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: The time of the day that the user starts working.
format: time
nullable: true
timeZone:
$ref: '#/components/schemas/microsoft.graph.timeZoneBase'
additionalProperties:
type: object
microsoft.graph.servicePlanInfo:
title: servicePlanInfo
type: object
properties:
appliesTo:
type: string
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.
nullable: true
provisioningStatus:
type: string
description: 'The provisioning status of the service plan. The possible values are:Success - Service is fully provisioned.Disabled - Service has been disabled.ErrorStatus - The service plan has not been provisioned and is in an error state.PendingInput - Service is not yet provisioned; awaiting service confirmation.PendingActivation - Service is provisioned but requires explicit activation by administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it has not been activated in the tenant, yet.'
nullable: true
servicePlanId:
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
type: string
description: The unique identifier of the service plan.
format: uuid
nullable: true
servicePlanName:
type: string
description: The name of the service plan.
nullable: true
additionalProperties:
type: object
microsoft.graph.inferenceClassificationOverride:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: inferenceClassificationOverride
type: object
properties:
classifyAs:
$ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
senderEmailAddress:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
microsoft.graph.messageRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: messageRule
type: object
properties:
actions:
$ref: '#/components/schemas/microsoft.graph.messageRuleActions'
conditions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
displayName:
type: string
description: The display name of the rule.
nullable: true
exceptions:
$ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
hasError:
type: boolean
description: Indicates whether the rule is in an error condition. Read-only.
nullable: true
isEnabled:
type: boolean
description: Indicates whether the rule is enabled to be applied to messages.
nullable: true
isReadOnly:
type: boolean
description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
nullable: true
sequence:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Indicates the order in which the rule is executed, among other rules.'
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.followupFlag:
title: followupFlag
type: object
properties:
completedDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
dueDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
flagStatus:
$ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
startDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
additionalProperties:
type: object
microsoft.graph.inferenceClassificationType:
title: inferenceClassificationType
enum:
- focused
- other
type: string
microsoft.graph.internetMessageHeader:
title: internetMessageHeader
type: object
properties:
name:
type: string
description: Represents the key in a key-value pair.
nullable: true
value:
type: string
description: The value in a key-value pair.
nullable: true
additionalProperties:
type: object
microsoft.graph.outlookCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: outlookCategory
type: object
properties:
color:
$ref: '#/components/schemas/microsoft.graph.categoryColor'
displayName:
type: string
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.'
nullable: true
additionalProperties:
type: object
microsoft.graph.personType:
title: personType
type: object
properties:
class:
type: string
description: 'The type of data source, such as Person.'
nullable: true
subclass:
type: string
description: 'The secondary type of data source, such as OrganizationUser.'
nullable: true
additionalProperties:
type: object
microsoft.graph.scoredEmailAddress:
title: scoredEmailAddress
type: object
properties:
address:
type: string
description: The email address.
nullable: true
itemId:
type: string
nullable: true
relevanceScore:
type: number
description: 'The relevance score of the email address. A relevance score is used as a sort key, in relation to the other returned results. A higher relevance score value corresponds to a more relevant result. Relevance is determined by the user’s communication and collaboration patterns and business relationships.'
format: double
nullable: true
selectionLikelihood:
$ref: '#/components/schemas/microsoft.graph.selectionLikelihoodInfo'
additionalProperties:
type: object
microsoft.graph.website:
title: website
type: object
properties:
address:
type: string
description: The URL of the website.
nullable: true
displayName:
type: string
description: The display name of the web site.
nullable: true
type:
$ref: '#/components/schemas/microsoft.graph.websiteType'
additionalProperties:
type: object
microsoft.graph.complianceState:
title: complianceState
enum:
- unknown
- compliant
- noncompliant
- conflict
- error
- inGracePeriod
- configManager
type: string
description: Compliance state.
x-ms-enum:
name: complianceState
modelAsString: false
values:
- value: unknown
description: Unknown.
name: unknown
- value: compliant
description: Compliant.
name: compliant
- value: noncompliant
description: Device is non-compliant and is blocked from corporate resources.
name: noncompliant
- value: conflict
description: Conflict with other rules.
name: conflict
- value: error
description: Error.
name: error
- value: inGracePeriod
description: Device is non-compliant but still has access to corporate resources
name: inGracePeriod
- value: configManager
description: Managed by Config Manager
name: configManager
microsoft.graph.configurationManagerClientEnabledFeatures:
title: configurationManagerClientEnabledFeatures
type: object
properties:
compliancePolicy:
type: boolean
description: Whether compliance policy is managed by Intune
deviceConfiguration:
type: boolean
description: Whether device configuration is managed by Intune
inventory:
type: boolean
description: Whether inventory is managed by Intune
modernApps:
type: boolean
description: Whether modern application is managed by Intune
resourceAccess:
type: boolean
description: Whether resource access is managed by Intune
windowsUpdateForBusiness:
type: boolean
description: Whether Windows Update for Business is managed by Intune
additionalProperties:
type: object
description: configuration Manager client enabled features
microsoft.graph.deviceActionResult:
title: deviceActionResult
type: object
properties:
actionName:
type: string
description: Action name
nullable: true
actionState:
$ref: '#/components/schemas/microsoft.graph.actionState'
lastUpdatedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time the action state was last updated
format: date-time
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Time the action was initiated
format: date-time
additionalProperties:
type: object
description: Device action result
microsoft.graph.deviceEnrollmentType:
title: deviceEnrollmentType
enum:
- unknown
- userEnrollment
- deviceEnrollmentManager
- appleBulkWithUser
- appleBulkWithoutUser
- windowsAzureADJoin
- windowsBulkUserless
- windowsAutoEnrollment
- windowsBulkAzureDomainJoin
- windowsCoManagement
- windowsAzureADJoinUsingDeviceAuth
- appleUserEnrollment
- appleUserEnrollmentWithServiceAccount
type: string
description: Possible ways of adding a mobile device to management.
x-ms-enum:
name: deviceEnrollmentType
modelAsString: false
values:
- value: unknown
description: 'Default value, enrollment type was not collected.'
name: unknown
- value: userEnrollment
description: User driven enrollment through BYOD channel.
name: userEnrollment
- value: deviceEnrollmentManager
description: User enrollment with a device enrollment manager account.
name: deviceEnrollmentManager
- value: appleBulkWithUser
description: 'Apple bulk enrollment with user challenge. (DEP, Apple Configurator)'
name: appleBulkWithUser
- value: appleBulkWithoutUser
description: 'Apple bulk enrollment without user challenge. (DEP, Apple Configurator, Mobile Config)'
name: appleBulkWithoutUser
- value: windowsAzureADJoin
description: Windows 10 Azure AD Join.
name: windowsAzureADJoin
- value: windowsBulkUserless
description: Windows 10 Bulk enrollment through ICD with certificate.
name: windowsBulkUserless
- value: windowsAutoEnrollment
description: Windows 10 automatic enrollment. (Add work account)
name: windowsAutoEnrollment
- value: windowsBulkAzureDomainJoin
description: Windows 10 bulk Azure AD Join.
name: windowsBulkAzureDomainJoin
- value: windowsCoManagement
description: Windows 10 Co-Management triggered by AutoPilot or Group Policy.
name: windowsCoManagement
- value: windowsAzureADJoinUsingDeviceAuth
description: Windows 10 Azure AD Join using Device Auth.
name: windowsAzureADJoinUsingDeviceAuth
- value: appleUserEnrollment
description: Device managed by Apple user enrollment
name: appleUserEnrollment
- value: appleUserEnrollmentWithServiceAccount
description: Device managed by Apple user enrollment with service account
name: appleUserEnrollmentWithServiceAccount
microsoft.graph.deviceHealthAttestationState:
title: deviceHealthAttestationState
type: object
properties:
attestationIdentityKey:
type: string
description: 'TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.'
nullable: true
bitLockerStatus:
type: string
description: On or Off of BitLocker Drive Encryption
nullable: true
bootAppSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootDebugging:
type: string
description: 'When bootDebugging is enabled, the device is used in development and testing'
nullable: true
bootManagerSecurityVersion:
type: string
description: The security version number of the Boot Application
nullable: true
bootManagerVersion:
type: string
description: The version of the Boot Manager
nullable: true
bootRevisionListInfo:
type: string
description: The Boot Revision List that was loaded during initial boot on the attested device
nullable: true
codeIntegrity:
type: string
description: 'When code integrity is enabled, code execution is restricted to integrity verified code'
nullable: true
codeIntegrityCheckVersion:
type: string
description: The version of the Boot Manager
nullable: true
codeIntegrityPolicy:
type: string
description: The Code Integrity policy that is controlling the security of the boot environment
nullable: true
contentNamespaceUrl:
type: string
description: The DHA report version. (Namespace version)
nullable: true
contentVersion:
type: string
description: The HealthAttestation state schema version
nullable: true
dataExcutionPolicy:
type: string
description: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory
nullable: true
deviceHealthAttestationStatus:
type: string
description: The DHA report version. (Namespace version)
nullable: true
earlyLaunchAntiMalwareDriverProtection:
type: string
description: ELAM provides protection for the computers in your network when they start up
nullable: true
healthAttestationSupportedStatus:
type: string
description: This attribute indicates if DHA is supported for the device
nullable: true
healthStatusMismatchInfo:
type: string
description: This attribute appears if DHA-Service detects an integrity issue
nullable: true
issuedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The DateTime when device was evaluated or issued to MDM
format: date-time
lastUpdateDateTime:
type: string
description: The Timestamp of the last update.
nullable: true
operatingSystemKernelDebugging:
type: string
description: 'When operatingSystemKernelDebugging is enabled, the device is used in development and testing'
nullable: true
operatingSystemRevListInfo:
type: string
description: The Operating System Revision List that was loaded during initial boot on the attested device
nullable: true
pcr0:
type: string
description: 'The measurement that is captured in PCR[0]'
nullable: true
pcrHashAlgorithm:
type: string
description: Informational attribute that identifies the HASH algorithm that was used by TPM
nullable: true
resetCount:
type: integer
description: The number of times a PC device has hibernated or resumed
format: int64
restartCount:
type: integer
description: The number of times a PC device has rebooted
format: int64
safeMode:
type: string
description: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state
nullable: true
secureBoot:
type: string
description: 'When Secure Boot is enabled, the core components must have the correct cryptographic signatures'
nullable: true
secureBootConfigurationPolicyFingerPrint:
type: string
description: Fingerprint of the Custom Secure Boot Configuration Policy
nullable: true
testSigning:
type: string
description: 'When test signing is allowed, the device does not enforce signature validation during boot'
nullable: true
tpmVersion:
type: string
description: The security version number of the Boot Application
nullable: true
virtualSecureMode:
type: string
description: VSM is a container that protects high value assets from a compromised kernel
nullable: true
windowsPE:
type: string
description: Operating system running with limited services that is used to prepare a computer for Windows
nullable: true
additionalProperties:
type: object
microsoft.graph.deviceRegistrationState:
title: deviceRegistrationState
enum:
- notRegistered
- registered
- revoked
- keyConflict
- approvalPending
- certificateReset
- notRegisteredPendingEnrollment
- unknown
type: string
description: Device registration status.
x-ms-enum:
name: deviceRegistrationState
modelAsString: false
values:
- value: notRegistered
description: The device is not registered.
name: notRegistered
- value: registered
description: The device is registered.
name: registered
- value: revoked
description: 'The device has been blocked, wiped or retired.'
name: revoked
- value: keyConflict
description: The device has a key conflict.
name: keyConflict
- value: approvalPending
description: The device is pending approval.
name: approvalPending
- value: certificateReset
description: The device certificate has been reset.
name: certificateReset
- value: notRegisteredPendingEnrollment
description: The device is not registered and pending enrollment.
name: notRegisteredPendingEnrollment
- value: unknown
description: The device registration status is unknown.
name: unknown
microsoft.graph.deviceManagementExchangeAccessState:
title: deviceManagementExchangeAccessState
enum:
- none
- unknown
- allowed
- blocked
- quarantined
type: string
description: Device Exchange Access State.
x-ms-enum:
name: deviceManagementExchangeAccessState
modelAsString: false
values:
- value: none
description: No access state discovered from Exchange
name: none
- value: unknown
description: Device access state to Exchange is unknown
name: unknown
- value: allowed
description: Device has access to Exchange
name: allowed
- value: blocked
description: Device is Blocked in Exchange
name: blocked
- value: quarantined
description: Device is Quarantined in Exchange
name: quarantined
microsoft.graph.deviceManagementExchangeAccessStateReason:
title: deviceManagementExchangeAccessStateReason
enum:
- none
- unknown
- exchangeGlobalRule
- exchangeIndividualRule
- exchangeDeviceRule
- exchangeUpgrade
- exchangeMailboxPolicy
- other
- compliant
- notCompliant
- notEnrolled
- unknownLocation
- mfaRequired
- azureADBlockDueToAccessPolicy
- compromisedPassword
- deviceNotKnownWithManagedApp
type: string
description: Device Exchange Access State Reason.
x-ms-enum:
name: deviceManagementExchangeAccessStateReason
modelAsString: false
values:
- value: none
description: No access state reason discovered from Exchange
name: none
- value: unknown
description: Unknown access state reason
name: unknown
- value: exchangeGlobalRule
description: Access state determined by Exchange Global rule
name: exchangeGlobalRule
- value: exchangeIndividualRule
description: Access state determined by Exchange Individual rule
name: exchangeIndividualRule
- value: exchangeDeviceRule
description: Access state determined by Exchange Device rule
name: exchangeDeviceRule
- value: exchangeUpgrade
description: Access state due to Exchange upgrade
name: exchangeUpgrade
- value: exchangeMailboxPolicy
description: Access state determined by Exchange Mailbox Policy
name: exchangeMailboxPolicy
- value: other
description: Access state determined by Exchange
name: other
- value: compliant
description: Access state granted by compliance challenge
name: compliant
- value: notCompliant
description: Access state revoked by compliance challenge
name: notCompliant
- value: notEnrolled
description: Access state revoked by management challenge
name: notEnrolled
- value: unknownLocation
description: Access state due to unknown location
name: unknownLocation
- value: mfaRequired
description: Access state due to MFA challenge
name: mfaRequired
- value: azureADBlockDueToAccessPolicy
description: Access State revoked by AAD Access Policy
name: azureADBlockDueToAccessPolicy
- value: compromisedPassword
description: Access State revoked by compromised password
name: compromisedPassword
- value: deviceNotKnownWithManagedApp
description: Access state revoked by managed application challenge
name: deviceNotKnownWithManagedApp
microsoft.graph.managedDeviceOwnerType:
title: managedDeviceOwnerType
enum:
- unknown
- company
- personal
type: string
description: Owner type of device.
x-ms-enum:
name: managedDeviceOwnerType
modelAsString: false
values:
- value: unknown
description: Unknown.
name: unknown
- value: company
description: Owned by company.
name: company
- value: personal
description: Owned by person.
name: personal
microsoft.graph.managementAgentType:
title: managementAgentType
enum:
- eas
- mdm
- easMdm
- intuneClient
- easIntuneClient
- configurationManagerClient
- configurationManagerClientMdm
- configurationManagerClientMdmEas
- unknown
- jamf
- googleCloudDevicePolicyController
- microsoft365ManagedMdm
- msSense
type: string
x-ms-enum:
name: managementAgentType
modelAsString: false
values:
- value: eas
description: The device is managed by Exchange server.
name: eas
- value: mdm
description: The device is managed by Intune MDM.
name: mdm
- value: easMdm
description: The device is managed by both Exchange server and Intune MDM.
name: easMdm
- value: intuneClient
description: Intune client managed.
name: intuneClient
- value: easIntuneClient
description: The device is EAS and Intune client dual managed.
name: easIntuneClient
- value: configurationManagerClient
description: The device is managed by Configuration Manager.
name: configurationManagerClient
- value: configurationManagerClientMdm
description: The device is managed by Configuration Manager and MDM.
name: configurationManagerClientMdm
- value: configurationManagerClientMdmEas
description: 'The device is managed by Configuration Manager, MDM and Eas.'
name: configurationManagerClientMdmEas
- value: unknown
description: Unknown management agent type.
name: unknown
- value: jamf
description: The device attributes are fetched from Jamf.
name: jamf
- value: googleCloudDevicePolicyController
description: The device is managed by Google's CloudDPC.
name: googleCloudDevicePolicyController
- value: microsoft365ManagedMdm
description: This device is managed by Microsoft 365 through Intune.
name: microsoft365ManagedMdm
microsoft.graph.managedDevicePartnerReportedHealthState:
title: managedDevicePartnerReportedHealthState
enum:
- unknown
- activated
- deactivated
- secured
- lowSeverity
- mediumSeverity
- highSeverity
- unresponsive
- compromised
- misconfigured
type: string
description: Available health states for the Device Health API
x-ms-enum:
name: managedDevicePartnerReportedHealthState
modelAsString: false
values:
- value: unknown
description: Device health state is not yet reported
name: unknown
- value: activated
description: 'Device has been activated by a mobile threat defense partner, but has not yet reported health.'
name: activated
- value: deactivated
description: Device has been deactivated by a mobile threat defense partner. The device health is not known.
name: deactivated
- value: secured
description: Device is considered secured by the mobile threat defense partner.
name: secured
- value: lowSeverity
description: Device is considered low threat by the mobile threat defense partner.
name: lowSeverity
- value: mediumSeverity
description: Device is considered medium threat by the mobile threat defense partner.
name: mediumSeverity
- value: highSeverity
description: Device is considered high threat by the mobile threat defense partner.
name: highSeverity
- value: unresponsive
description: Device is considered unresponsive by the mobile threat defense partner. The device health is not known.
name: unresponsive
- value: compromised
description: Device is considered compromised by the Threat Defense partner. This means the device has an active Threat or Risk which cannot be easily remediated by the end user and the user should contact their IT Admin.
name: compromised
- value: misconfigured
description: Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.
name: misconfigured
microsoft.graph.deviceCompliancePolicyState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCompliancePolicyState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.policyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicySettingState'
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The version of the policy
format: int32
additionalProperties:
type: object
description: Device Compliance Policy State for a given device.
microsoft.graph.deviceConfigurationState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceConfigurationState
type: object
properties:
displayName:
type: string
description: The name of the policy for this policyBase
nullable: true
platformType:
$ref: '#/components/schemas/microsoft.graph.policyPlatformType'
settingCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Count of how many setting a policy holds
format: int32
settingStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationSettingState'
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
version:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The version of the policy
format: int32
additionalProperties:
type: object
description: Device Configuration State for a given device.
microsoft.graph.deviceCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: deviceCategory
type: object
properties:
description:
type: string
description: Optional description for the device category.
nullable: true
displayName:
type: string
description: Display name for the device category.
nullable: true
additionalProperties:
type: object
description: 'Device categories provides a way to organize your devices. Using device categories, company administrators can define their own categories that make sense to their company. These categories can then be applied to a device in the Intune Azure console or selected by a user during device enrollment. You can filter reports and create dynamic Azure Active Directory device groups based on device categories.'
microsoft.graph.mobileAppIdentifier:
title: mobileAppIdentifier
type: object
additionalProperties:
type: object
description: The identifier for a mobile app.
microsoft.graph.managedAppFlaggedReason:
title: managedAppFlaggedReason
enum:
- none
- rootedDevice
type: string
description: The reason for which a user has been flagged
x-ms-enum:
name: managedAppFlaggedReason
modelAsString: false
values:
- value: none
description: No issue.
name: none
- value: rootedDevice
description: The app registration is running on a rooted/unlocked device.
name: rootedDevice
microsoft.graph.managedAppPolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppPolicy
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time the policy was created.
format: date-time
description:
type: string
description: The policy's description.
nullable: true
displayName:
type: string
description: Policy display name.
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Last time the policy was modified.
format: date-time
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties:
type: object
description: The ManagedAppPolicy resource represents a base type for platform specific policies.
microsoft.graph.managedAppOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedAppOperation
type: object
properties:
displayName:
type: string
description: The operation name.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The last time the app operation was modified.
format: date-time
state:
type: string
description: The current state of the operation
nullable: true
version:
type: string
description: Version of the entity.
nullable: true
additionalProperties:
type: object
description: Represents an operation applied against an app registration.
microsoft.graph.sharedInsight:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: sharedInsight
type: object
properties:
lastShared:
$ref: '#/components/schemas/microsoft.graph.sharingDetail'
resourceReference:
$ref: '#/components/schemas/microsoft.graph.resourceReference'
resourceVisualization:
$ref: '#/components/schemas/microsoft.graph.resourceVisualization'
sharingHistory:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.sharingDetail'
lastSharedMethod:
$ref: '#/components/schemas/microsoft.graph.entity'
resource:
$ref: '#/components/schemas/microsoft.graph.entity'
additionalProperties:
type: object
microsoft.graph.trending:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: trending
type: object
properties:
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
resourceReference:
$ref: '#/components/schemas/microsoft.graph.resourceReference'
resourceVisualization:
$ref: '#/components/schemas/microsoft.graph.resourceVisualization'
weight:
type: number
description: 'Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value.'
format: double
resource:
$ref: '#/components/schemas/microsoft.graph.entity'
additionalProperties:
type: object
microsoft.graph.usedInsight:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: usedInsight
type: object
properties:
lastUsed:
$ref: '#/components/schemas/microsoft.graph.usageDetails'
resourceReference:
$ref: '#/components/schemas/microsoft.graph.resourceReference'
resourceVisualization:
$ref: '#/components/schemas/microsoft.graph.resourceVisualization'
resource:
$ref: '#/components/schemas/microsoft.graph.entity'
additionalProperties:
type: object
microsoft.graph.shiftPreferences:
allOf:
- $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- title: shiftPreferences
type: object
properties:
availability:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.shiftAvailability'
description: Availability of the user to be scheduled for work and its recurrence pattern.
additionalProperties:
type: object
microsoft.graph.Json:
title: Json
type: object
additionalProperties:
type: object
microsoft.graph.status:
title: status
enum:
- active
- updated
- deleted
- ignored
- unknownFutureValue
type: string
microsoft.graph.visualInfo:
title: visualInfo
type: object
properties:
attribution:
$ref: '#/components/schemas/microsoft.graph.imageInfo'
backgroundColor:
type: string
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
nullable: true
content:
$ref: '#/components/schemas/microsoft.graph.Json'
description:
type: string
description: 'Optional. Longer text description of the user''s unique activity (example: document name, first sentence, and/or metadata)'
nullable: true
displayText:
type: string
description: 'Required. Short text description of the user''s unique activity (for example, document name in cases where an activity refers to document creation)'
additionalProperties:
type: object
microsoft.graph.activityHistoryItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: activityHistoryItem
type: object
properties:
activeDurationSeconds:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.'
format: int32
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was created on the server.
format: date-time
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Optional. UTC DateTime when the historyItem will undergo hard-delete. Can be set by the client.
format: date-time
nullable: true
lastActiveDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'Optional. UTC DateTime when the historyItem (activity session) was last understood as active or finished - if null, historyItem status should be Ongoing.'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Set by the server. DateTime in UTC when the object was modified on the server.
format: date-time
nullable: true
startedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Required. UTC DateTime when the historyItem (activity session) was started. Required for timeline history.
format: date-time
status:
$ref: '#/components/schemas/microsoft.graph.status'
userTimezone:
type: string
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.
nullable: true
activity:
$ref: '#/components/schemas/microsoft.graph.userActivity'
additionalProperties:
type: object
microsoft.graph.onlineMeetingPresenters:
title: onlineMeetingPresenters
enum:
- everyone
- organization
- roleIsPresenter
- organizer
- unknownFutureValue
type: string
microsoft.graph.meetingChatMode:
title: meetingChatMode
enum:
- enabled
- disabled
- limited
- unknownFutureValue
type: string
microsoft.graph.audioConferencing:
title: audioConferencing
type: object
properties:
conferenceId:
type: string
description: The conference id of the online meeting.
nullable: true
dialinUrl:
type: string
description: A URL to the externally-accessible web page that contains dial-in information.
nullable: true
tollFreeNumber:
type: string
nullable: true
tollFreeNumbers:
type: array
items:
type: string
nullable: true
description: List of toll-free numbers that are displayed in the meeting invite.
tollNumber:
type: string
nullable: true
tollNumbers:
type: array
items:
type: string
nullable: true
description: List of toll numbers that are displayed in the meeting invite.
additionalProperties:
type: object
microsoft.graph.broadcastMeetingSettings:
title: broadcastMeetingSettings
type: object
properties:
allowedAudience:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingAudience'
captions:
$ref: '#/components/schemas/microsoft.graph.broadcastMeetingCaptionSettings'
isAttendeeReportEnabled:
type: boolean
description: Indicates whether attendee report is enabled for this Teams live event. Default value is false.
nullable: true
isQuestionAndAnswerEnabled:
type: boolean
description: Indicates whether Q&A is enabled for this Teams live event. Default value is false.
nullable: true
isRecordingEnabled:
type: boolean
description: Indicates whether recording is enabled for this Teams live event. Default value is false.
nullable: true
isVideoOnDemandEnabled:
type: boolean
description: Indicates whether video on demand is enabled for this Teams live event. Default value is false.
nullable: true
additionalProperties:
type: object
microsoft.graph.chatInfo:
title: chatInfo
type: object
properties:
messageId:
type: string
description: The unique identifier of a message in a Microsoft Teams channel.
nullable: true
replyChainMessageId:
type: string
description: The ID of the reply message.
nullable: true
threadId:
type: string
description: The unique identifier for a thread in Microsoft Teams.
nullable: true
additionalProperties:
type: object
microsoft.graph.joinMeetingIdSettings:
title: joinMeetingIdSettings
type: object
properties:
isPasscodeRequired:
type: boolean
description: Indicates whether a passcode is required to join a meeting when using joinMeetingId. Optional.
nullable: true
joinMeetingId:
type: string
description: The meeting ID to be used to join a meeting. Optional. Read-only.
nullable: true
passcode:
type: string
description: The passcode to join a meeting. Optional. Read-only.
nullable: true
additionalProperties:
type: object
microsoft.graph.lobbyBypassSettings:
title: lobbyBypassSettings
type: object
properties:
isDialInBypassEnabled:
type: boolean
description: Specifies whether or not to always let dial-in callers bypass the lobby. Optional.
nullable: true
scope:
$ref: '#/components/schemas/microsoft.graph.lobbyBypassScope'
additionalProperties:
type: object
microsoft.graph.meetingParticipants:
title: meetingParticipants
type: object
properties:
attendees:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
organizer:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
additionalProperties:
type: object
microsoft.graph.watermarkProtectionValues:
title: watermarkProtectionValues
type: object
properties:
isEnabledForContentSharing:
type: boolean
description: Indicates whether to apply a watermark to any shared content.
nullable: true
isEnabledForVideo:
type: boolean
description: Indicates whether to apply a watermark to everyone's video feed.
nullable: true
additionalProperties:
type: object
microsoft.graph.meetingAttendanceReport:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: meetingAttendanceReport
type: object
properties:
meetingEndDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: UTC time when the meeting ended. Read-only.
format: date-time
nullable: true
meetingStartDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: UTC time when the meeting started. Read-only.
format: date-time
nullable: true
totalParticipantCount:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Total number of participants. Read-only.
format: int32
nullable: true
attendanceRecords:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendanceRecord'
description: List of attendance records of an attendance report. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.emailAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: emailAuthenticationMethod
type: object
properties:
emailAddress:
type: string
description: The email address registered to this user.
nullable: true
additionalProperties:
type: object
microsoft.graph.fido2AuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: fido2AuthenticationMethod
type: object
properties:
aaGuid:
type: string
description: 'Authenticator Attestation GUID, an identifier that indicates the type (e.g. make and model) of the authenticator.'
nullable: true
attestationCertificates:
type: array
items:
type: string
nullable: true
description: The attestation certificate(s) attached to this security key.
attestationLevel:
$ref: '#/components/schemas/microsoft.graph.attestationLevel'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The timestamp when this key was registered to the user.
format: date-time
nullable: true
displayName:
type: string
description: The display name of the key as given by the user.
nullable: true
model:
type: string
description: The manufacturer-assigned model of the FIDO2 security key.
nullable: true
additionalProperties:
type: object
microsoft.graph.authenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: authenticationMethod
type: object
additionalProperties:
type: object
microsoft.graph.microsoftAuthenticatorAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: microsoftAuthenticatorAuthenticationMethod
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time that this app was registered. This property is null if the device is not registered for passwordless Phone Sign-In.
format: date-time
nullable: true
deviceTag:
type: string
description: Tags containing app metadata.
nullable: true
displayName:
type: string
description: The name of the device on which this app is registered.
nullable: true
phoneAppVersion:
type: string
description: Numerical version of this instance of the Authenticator app.
nullable: true
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.passwordAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: passwordAuthenticationMethod
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
password:
type: string
description: 'For security, the password is always returned as null from a LIST or GET operation.'
nullable: true
additionalProperties:
type: object
microsoft.graph.phoneAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: phoneAuthenticationMethod
type: object
properties:
phoneNumber:
type: string
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 do not match the required format.'
nullable: true
phoneType:
$ref: '#/components/schemas/microsoft.graph.authenticationPhoneType'
smsSignInState:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodSignInState'
additionalProperties:
type: object
microsoft.graph.softwareOathAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: softwareOathAuthenticationMethod
type: object
properties:
secretKey:
type: string
description: The secret key of the method. Always returns null.
nullable: true
additionalProperties:
type: object
microsoft.graph.temporaryAccessPassAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: temporaryAccessPassAuthenticationMethod
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the Temporary Access Pass was created.
format: date-time
nullable: true
isUsable:
type: boolean
description: The state of the authentication method that indicates whether it's currently usable by the user.
nullable: true
isUsableOnce:
type: boolean
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.'
nullable: true
lifetimeInMinutes:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
format: int32
nullable: true
methodUsabilityReason:
type: string
description: 'Details about the usability state (isUsable). Reasons can include: EnabledByPolicy, DisabledByPolicy, Expired, NotYetValid, OneTimeUsed.'
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
format: date-time
nullable: true
temporaryAccessPass:
type: string
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.
nullable: true
additionalProperties:
type: object
microsoft.graph.windowsHelloForBusinessAuthenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- title: windowsHelloForBusinessAuthenticationMethod
type: object
properties:
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time that this Windows Hello for Business key was registered.
format: date-time
nullable: true
displayName:
type: string
description: The name of the device on which Windows Hello for Business is registered
nullable: true
keyStrength:
$ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
device:
$ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
microsoft.graph.chatType:
title: chatType
enum:
- oneOnOne
- group
- meeting
- unknownFutureValue
type: string
microsoft.graph.teamworkOnlineMeetingInfo:
title: teamworkOnlineMeetingInfo
type: object
properties:
calendarEventId:
type: string
description: The identifier of the calendar event associated with the meeting.
nullable: true
joinWebUrl:
type: string
description: The URL that users click to join or uniquely identify the meeting.
nullable: true
organizer:
$ref: '#/components/schemas/microsoft.graph.teamworkUserIdentity'
additionalProperties:
type: object
microsoft.graph.chatViewpoint:
title: chatViewpoint
type: object
properties:
isHidden:
type: boolean
description: Indicates whether the chat is hidden for the current user.
nullable: true
lastMessageReadDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.chatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: chatMessageInfo
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: Date time object representing the time at which message was created.
format: date-time
nullable: true
eventDetail:
$ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
from:
$ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
isDeleted:
type: boolean
description: 'If set to true, the original message has been deleted.'
nullable: true
messageType:
$ref: '#/components/schemas/microsoft.graph.chatMessageType'
additionalProperties:
type: object
microsoft.graph.pinnedChatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: pinnedChatMessageInfo
type: object
properties:
message:
$ref: '#/components/schemas/microsoft.graph.chatMessage'
additionalProperties:
type: object
microsoft.graph.associatedTeamInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamInfo'
- title: associatedTeamInfo
type: object
additionalProperties:
type: object
microsoft.graph.userScopeTeamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
- title: userScopeTeamsAppInstallation
type: object
properties:
chat:
$ref: '#/components/schemas/microsoft.graph.chat'
additionalProperties:
type: object
microsoft.graph.todoTaskList:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todoTaskList
type: object
properties:
displayName:
type: string
description: The name of the task list.
nullable: true
isOwner:
type: boolean
description: True if the user is owner of the given task list.
isShared:
type: boolean
description: True if the task list is shared with other users
wellknownListName:
$ref: '#/components/schemas/microsoft.graph.wellknownListName'
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the task list. Nullable.
x-ms-navigationProperty: true
tasks:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.todoTask'
description: The tasks in this task list. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workbookCommentReply:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookCommentReply
type: object
properties:
content:
type: string
description: The content of a comment reply.
nullable: true
contentType:
type: string
description: Indicates the type for the comment reply.
additionalProperties:
type: object
microsoft.graph.workbookOperationError:
title: workbookOperationError
type: object
properties:
code:
type: string
description: The error code.
nullable: true
innerError:
$ref: '#/components/schemas/microsoft.graph.workbookOperationError'
message:
type: string
description: The error message.
nullable: true
additionalProperties:
type: object
microsoft.graph.workbookOperationStatus:
title: workbookOperationStatus
enum:
- notStarted
- running
- succeeded
- failed
type: string
microsoft.graph.workbookTableColumn:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTableColumn
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only.
format: int32
name:
type: string
description: Returns the name of the table column.
nullable: true
values:
$ref: '#/components/schemas/microsoft.graph.Json'
filter:
$ref: '#/components/schemas/microsoft.graph.workbookFilter'
additionalProperties:
type: object
microsoft.graph.workbookTableRow:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTableRow
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only.
format: int32
values:
$ref: '#/components/schemas/microsoft.graph.Json'
additionalProperties:
type: object
microsoft.graph.workbookTableSort:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookTableSort
type: object
properties:
fields:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookSortField'
description: Represents the current conditions used to last sort the table. Read-only.
matchCase:
type: boolean
description: Represents whether the casing impacted the last sort of the table. Read-only.
method:
type: string
description: 'Represents Chinese character ordering method last used to sort the table. The possible values are: PinYin, StrokeCount. Read-only.'
additionalProperties:
type: object
microsoft.graph.workbookChart:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChart
type: object
properties:
height:
type: number
description: 'Represents the height, in points, of the chart object.'
format: double
left:
type: number
description: 'The distance, in points, from the left side of the chart to the worksheet origin.'
format: double
name:
type: string
description: Represents the name of a chart object.
nullable: true
top:
type: number
description: 'Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).'
format: double
width:
type: number
description: 'Represents the width, in points, of the chart object.'
format: double
axes:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxes'
dataLabels:
$ref: '#/components/schemas/microsoft.graph.workbookChartDataLabels'
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartAreaFormat'
legend:
$ref: '#/components/schemas/microsoft.graph.workbookChartLegend'
series:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChartSeries'
description: Represents either a single series or collection of series in the chart. Read-only.
x-ms-navigationProperty: true
title:
$ref: '#/components/schemas/microsoft.graph.workbookChartTitle'
worksheet:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
additionalProperties:
type: object
microsoft.graph.workbookPivotTable:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookPivotTable
type: object
properties:
name:
type: string
description: Name of the PivotTable.
nullable: true
worksheet:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
additionalProperties:
type: object
microsoft.graph.workbookWorksheetProtection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheetProtection
type: object
properties:
options:
$ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtectionOptions'
protected:
type: boolean
description: Indicates if the worksheet is protected. Read-only.
additionalProperties:
type: object
microsoft.graph.documentSetVersionItem:
title: documentSetVersionItem
type: object
properties:
itemId:
type: string
description: The unique identifier for the item.
nullable: true
title:
type: string
description: The title of the item.
nullable: true
versionId:
type: string
description: The version ID of the item.
nullable: true
additionalProperties:
type: object
microsoft.graph.accessAction:
title: accessAction
type: object
additionalProperties:
type: object
microsoft.graph.termStore.localizedDescription:
title: localizedDescription
type: object
properties:
description:
type: string
description: The description in the localized language.
nullable: true
languageTag:
type: string
description: The language tag for the label.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.localizedLabel:
title: localizedLabel
type: object
properties:
isDefault:
type: boolean
description: Indicates whether the label is the default label.
nullable: true
languageTag:
type: string
description: The language tag for the label.
nullable: true
name:
type: string
description: The name of the label.
nullable: true
additionalProperties:
type: object
microsoft.graph.termStore.relationType:
title: relationType
enum:
- pin
- reuse
- unknownFutureValue
type: string
microsoft.graph.plannerOrderHintsByAssignee:
title: plannerOrderHintsByAssignee
type: object
additionalProperties:
type: object
microsoft.graph.plannerChecklistItems:
title: plannerChecklistItems
type: object
additionalProperties:
type: object
microsoft.graph.plannerExternalReferences:
title: plannerExternalReferences
type: object
additionalProperties:
type: object
microsoft.graph.chatMessageMentionedIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: chatMessageMentionedIdentitySet
type: object
properties:
conversation:
$ref: '#/components/schemas/microsoft.graph.teamworkConversationIdentity'
additionalProperties:
type: object
microsoft.graph.chatMessageActions:
title: chatMessageActions
enum:
- reactionAdded
- reactionRemoved
- actionUndefined
- unknownFutureValue
type: string
microsoft.graph.chatMessagePolicyViolationDlpActionTypes:
title: chatMessagePolicyViolationDlpActionTypes
enum:
- none
- notifySender
- blockAccess
- blockAccessExternal
type: string
microsoft.graph.chatMessagePolicyViolationPolicyTip:
title: chatMessagePolicyViolationPolicyTip
type: object
properties:
complianceUrl:
type: string
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)'
nullable: true
generalText:
type: string
description: Explanatory text shown to the sender of the message.
nullable: true
matchedConditionDescriptions:
type: array
items:
type: string
nullable: true
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''.'
additionalProperties:
type: object
microsoft.graph.chatMessagePolicyViolationUserActionTypes:
title: chatMessagePolicyViolationUserActionTypes
enum:
- none
- override
- reportFalsePositive
type: string
microsoft.graph.chatMessagePolicyViolationVerdictDetailsTypes:
title: chatMessagePolicyViolationVerdictDetailsTypes
enum:
- none
- allowFalsePositiveOverride
- allowOverrideWithoutJustification
- allowOverrideWithJustification
type: string
microsoft.graph.chatMessageReactionIdentitySet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- title: chatMessageReactionIdentitySet
type: object
additionalProperties:
type: object
microsoft.graph.teamworkHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkHostedContent
type: object
properties:
contentBytes:
type: string
description: Write only. Bytes for the hosted content (such as images).
format: base64url
nullable: true
contentType:
type: string
description: 'Write only. Content type. sicj as image/png, image/jpg.'
nullable: true
additionalProperties:
type: object
microsoft.graph.scheduleChangeRequestActor:
title: scheduleChangeRequestActor
enum:
- sender
- recipient
- manager
- system
- unknownFutureValue
type: string
microsoft.graph.scheduleChangeState:
title: scheduleChangeState
enum:
- pending
- approved
- declined
- unknownFutureValue
type: string
microsoft.graph.scheduleEntity:
title: scheduleEntity
type: object
properties:
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
format: date-time
nullable: true
theme:
$ref: '#/components/schemas/microsoft.graph.scheduleEntityTheme'
additionalProperties:
type: object
microsoft.graph.shiftActivity:
title: shiftActivity
type: object
properties:
code:
type: string
description: Customer defined code for the shiftActivity. Required.
nullable: true
displayName:
type: string
description: The name of the shiftActivity. Required.
nullable: true
endDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The end date and time for the shiftActivity. 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. Required.'
format: date-time
nullable: true
isPaid:
type: boolean
description: Indicates whether the microsoft.graph.user should be paid for the activity during their shift. Required.
nullable: true
startDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: 'The start date and time for the shiftActivity. 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. Required.'
format: date-time
nullable: true
theme:
$ref: '#/components/schemas/microsoft.graph.scheduleEntityTheme'
additionalProperties:
type: object
microsoft.graph.externalAudienceScope:
title: externalAudienceScope
enum:
- none
- contactsOnly
- all
type: string
microsoft.graph.automaticRepliesStatus:
title: automaticRepliesStatus
enum:
- disabled
- alwaysEnabled
- scheduled
type: string
microsoft.graph.timeZoneBase:
title: timeZoneBase
type: object
properties:
name:
type: string
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.'
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRuleActions:
title: messageRuleActions
type: object
properties:
assignCategories:
type: array
items:
type: string
nullable: true
description: A list of categories to be assigned to a message.
copyToFolder:
type: string
description: The ID of a folder that a message is to be copied to.
nullable: true
delete:
type: boolean
description: Indicates whether a message should be moved to the Deleted Items folder.
nullable: true
forwardAsAttachmentTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses of the recipients to which a message should be forwarded as an attachment.
forwardTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses of the recipients to which a message should be forwarded.
markAsRead:
type: boolean
description: Indicates whether a message should be marked as read.
nullable: true
markImportance:
$ref: '#/components/schemas/microsoft.graph.importance'
moveToFolder:
type: string
description: The ID of the folder that a message will be moved to.
nullable: true
permanentDelete:
type: boolean
description: Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder.
nullable: true
redirectTo:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: The email addresses to which a message should be redirected.
stopProcessingRules:
type: boolean
description: Indicates whether subsequent rules should be evaluated.
nullable: true
additionalProperties:
type: object
microsoft.graph.messageRulePredicates:
title: messageRulePredicates
type: object
properties:
bodyContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.
bodyOrSubjectContains:
type: array
items:
type: string
nullable: true
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: array
items:
type: string
nullable: true
description: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.
fromAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.
hasAttachments:
type: boolean
description: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.
nullable: true
headerContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isApprovalRequest:
type: boolean
description: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.
nullable: true
isAutomaticForward:
type: boolean
description: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.
nullable: true
isAutomaticReply:
type: boolean
description: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.
nullable: true
isEncrypted:
type: boolean
description: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.
nullable: true
isMeetingRequest:
type: boolean
description: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.
nullable: true
isMeetingResponse:
type: boolean
description: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.
nullable: true
isNonDeliveryReport:
type: boolean
description: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.
nullable: true
isPermissionControlled:
type: boolean
description: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.
nullable: true
isReadReceipt:
type: boolean
description: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.
nullable: true
isSigned:
type: boolean
description: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.
nullable: true
isVoicemail:
type: boolean
description: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.
nullable: true
messageActionFlag:
$ref: '#/components/schemas/microsoft.graph.messageActionFlag'
notSentToMe:
type: boolean
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.
nullable: true
recipientContains:
type: array
items:
type: string
nullable: true
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.
senderContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.
sensitivity:
$ref: '#/components/schemas/microsoft.graph.sensitivity'
sentCcMe:
type: boolean
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.
nullable: true
sentOnlyToMe:
type: boolean
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.
nullable: true
sentToAddresses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.recipient'
description: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.
sentToMe:
type: boolean
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.
nullable: true
sentToOrCcMe:
type: boolean
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.
nullable: true
subjectContains:
type: array
items:
type: string
nullable: true
description: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.
withinSizeRange:
$ref: '#/components/schemas/microsoft.graph.sizeRange'
additionalProperties:
type: object
microsoft.graph.followupFlagStatus:
title: followupFlagStatus
enum:
- notFlagged
- complete
- flagged
type: string
microsoft.graph.categoryColor:
title: categoryColor
enum:
- none
- preset0
- preset1
- preset2
- preset3
- preset4
- preset5
- preset6
- preset7
- preset8
- preset9
- preset10
- preset11
- preset12
- preset13
- preset14
- preset15
- preset16
- preset17
- preset18
- preset19
- preset20
- preset21
- preset22
- preset23
- preset24
type: string
microsoft.graph.selectionLikelihoodInfo:
title: selectionLikelihoodInfo
enum:
- notSpecified
- high
type: string
microsoft.graph.websiteType:
title: websiteType
enum:
- other
- home
- work
- blog
- profile
type: string
microsoft.graph.actionState:
title: actionState
enum:
- none
- pending
- canceled
- active
- done
- failed
- notSupported
type: string
description: State of the action on the device
x-ms-enum:
name: actionState
modelAsString: false
values:
- value: none
description: Not a valid action state
name: none
- value: pending
description: Action is pending
name: pending
- value: canceled
description: Action has been cancelled.
name: canceled
- value: active
description: Action is active.
name: active
- value: done
description: Action completed without errors.
name: done
- value: failed
description: Action failed
name: failed
- value: notSupported
description: Action is not supported.
name: notSupported
microsoft.graph.policyPlatformType:
title: policyPlatformType
enum:
- android
- androidForWork
- iOS
- macOS
- windowsPhone81
- windows81AndLater
- windows10AndLater
- all
type: string
description: Supported platform types for policies.
x-ms-enum:
name: policyPlatformType
modelAsString: false
values:
- value: android
description: Android.
name: android
- value: androidForWork
description: AndroidForWork.
name: androidForWork
- value: iOS
description: iOS.
name: iOS
- value: macOS
description: MacOS.
name: macOS
- value: windowsPhone81
description: WindowsPhone 8.1.
name: windowsPhone81
- value: windows81AndLater
description: Windows 8.1 and later
name: windows81AndLater
- value: windows10AndLater
description: Windows 10 and later.
name: windows10AndLater
- value: all
description: All platforms.
name: all
microsoft.graph.deviceCompliancePolicySettingState:
title: deviceCompliancePolicySettingState
type: object
properties:
currentValue:
type: string
description: Current value of setting on device
nullable: true
errorCode:
type: integer
description: Error code for the setting
format: int64
errorDescription:
type: string
description: Error description
nullable: true
instanceDisplayName:
type: string
description: Name of setting instance that is being reported.
nullable: true
setting:
type: string
description: The setting that is being reported
nullable: true
settingName:
type: string
description: Localized/user friendly setting name that is being reported
nullable: true
sources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingSource'
description: Contributing policies
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
userEmail:
type: string
description: UserEmail
nullable: true
userId:
type: string
description: UserId
nullable: true
userName:
type: string
description: UserName
nullable: true
userPrincipalName:
type: string
description: UserPrincipalName.
nullable: true
additionalProperties:
type: object
description: Device Compilance Policy Setting State for a given device.
microsoft.graph.complianceStatus:
title: complianceStatus
enum:
- unknown
- notApplicable
- compliant
- remediated
- nonCompliant
- error
- conflict
- notAssigned
type: string
microsoft.graph.deviceConfigurationSettingState:
title: deviceConfigurationSettingState
type: object
properties:
currentValue:
type: string
description: Current value of setting on device
nullable: true
errorCode:
type: integer
description: Error code for the setting
format: int64
errorDescription:
type: string
description: Error description
nullable: true
instanceDisplayName:
type: string
description: Name of setting instance that is being reported.
nullable: true
setting:
type: string
description: The setting that is being reported
nullable: true
settingName:
type: string
description: Localized/user friendly setting name that is being reported
nullable: true
sources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.settingSource'
description: Contributing policies
state:
$ref: '#/components/schemas/microsoft.graph.complianceStatus'
userEmail:
type: string
description: UserEmail
nullable: true
userId:
type: string
description: UserId
nullable: true
userName:
type: string
description: UserName
nullable: true
userPrincipalName:
type: string
description: UserPrincipalName.
nullable: true
additionalProperties:
type: object
description: Device Configuration Setting State for a given device.
microsoft.graph.sharingDetail:
title: sharingDetail
type: object
properties:
sharedBy:
$ref: '#/components/schemas/microsoft.graph.insightIdentity'
sharedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
sharingReference:
$ref: '#/components/schemas/microsoft.graph.resourceReference'
sharingSubject:
type: string
description: The subject with which the document was shared.
nullable: true
sharingType:
type: string
description: 'Determines the way the document was shared, can be by a ''Link'', ''Attachment'', ''Group'', ''Site''.'
nullable: true
additionalProperties:
type: object
microsoft.graph.resourceReference:
title: resourceReference
type: object
properties:
id:
type: string
description: The item's unique identifier.
nullable: true
type:
type: string
description: 'A string value that can be used to classify the item, such as ''microsoft.graph.driveItem'''
nullable: true
webUrl:
type: string
description: A URL leading to the referenced item.
nullable: true
additionalProperties:
type: object
microsoft.graph.resourceVisualization:
title: resourceVisualization
type: object
properties:
containerDisplayName:
type: string
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.'
nullable: true
containerType:
type: string
description: Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness.
nullable: true
containerWebUrl:
type: string
description: A path leading to the folder in which the item is stored.
nullable: true
mediaType:
type: string
description: The item's media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Note that not all Media Mime Types are supported.
nullable: true
previewImageUrl:
type: string
description: A URL leading to the preview image for the item.
nullable: true
previewText:
type: string
description: A preview text for the item.
nullable: true
title:
type: string
description: The item's title text.
nullable: true
type:
type: string
description: The item's media type. Can be used for filtering for a specific file based on a specific type. See below for supported types.
nullable: true
additionalProperties:
type: object
microsoft.graph.usageDetails:
title: usageDetails
type: object
properties:
lastAccessedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.shiftAvailability:
title: shiftAvailability
type: object
properties:
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
timeSlots:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.timeRange'
description: The time slot(s) preferred by the user.
timeZone:
type: string
description: Specifies the time zone for the indicated time.
nullable: true
additionalProperties:
type: object
microsoft.graph.imageInfo:
title: imageInfo
type: object
properties:
addImageQuery:
type: boolean
description: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example – a high contrast image
nullable: true
alternateText:
type: string
description: Optional; alt-text accessible content for the image
nullable: true
alternativeText:
type: string
nullable: true
iconUrl:
type: string
description: Optional; URI that points to an icon which represents the application used to generate the activity
nullable: true
additionalProperties:
type: object
microsoft.graph.broadcastMeetingAudience:
title: broadcastMeetingAudience
enum:
- roleIsAttendee
- organization
- everyone
- unknownFutureValue
type: string
microsoft.graph.broadcastMeetingCaptionSettings:
title: broadcastMeetingCaptionSettings
type: object
properties:
isCaptionEnabled:
type: boolean
description: Indicates whether captions are enabled for this Teams live event.
nullable: true
spokenLanguage:
type: string
description: The spoken language.
nullable: true
translationLanguages:
type: array
items:
type: string
nullable: true
description: The translation languages (choose up to 6).
additionalProperties:
type: object
microsoft.graph.lobbyBypassScope:
title: lobbyBypassScope
enum:
- organizer
- organization
- organizationAndFederated
- everyone
- unknownFutureValue
- invited
- organizationExcludingGuests
type: string
microsoft.graph.meetingParticipantInfo:
title: meetingParticipantInfo
type: object
properties:
identity:
$ref: '#/components/schemas/microsoft.graph.identitySet'
role:
$ref: '#/components/schemas/microsoft.graph.onlineMeetingRole'
upn:
type: string
description: User principal name of the participant.
nullable: true
additionalProperties:
type: object
microsoft.graph.attendanceRecord:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attendanceRecord
type: object
properties:
attendanceIntervals:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attendanceInterval'
description: List of time periods between joining and leaving a meeting.
emailAddress:
type: string
description: Email address of the user associated with this attendance record.
nullable: true
identity:
$ref: '#/components/schemas/microsoft.graph.identity'
role:
type: string
description: 'Role of the attendee. Possible values are: None, Attendee, Presenter, and Organizer.'
nullable: true
totalAttendanceInSeconds:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Total duration of the attendances in seconds.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.attestationLevel:
title: attestationLevel
enum:
- attested
- notAttested
- unknownFutureValue
type: string
microsoft.graph.device:
allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- title: device
type: object
properties:
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.'
nullable: true
alternativeSecurityIds:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le).'
approximateLastSignInDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
complianceExpirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
deviceCategory:
type: string
description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
nullable: true
deviceId:
type: string
description: 'Unique identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).'
nullable: true
deviceMetadata:
type: string
description: For internal use only. Set to null.
nullable: true
deviceOwnership:
type: string
description: 'Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.'
nullable: true
deviceVersion:
maximum: 2147483647
minimum: -2147483648
type: integer
description: For internal use only.
format: int32
nullable: true
displayName:
type: string
description: 'The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.'
nullable: true
enrollmentProfileName:
type: string
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.'
nullable: true
isCompliant:
type: boolean
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).'
nullable: true
isManaged:
type: boolean
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).'
nullable: true
mdmAppId:
type: string
description: 'Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).'
nullable: true
onPremisesLastSyncDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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).'
format: date-time
nullable: true
onPremisesSyncEnabled:
type: boolean
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).'
nullable: true
operatingSystem:
type: string
description: 'The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
operatingSystemVersion:
type: string
description: 'The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
physicalIds:
type: array
items:
type: string
description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).'
profileType:
type: string
description: 'The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.'
nullable: true
registrationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
systemLabels:
type: array
items:
type: string
description: 'List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).'
trustType:
type: string
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 Azure AD). For more details, see Introduction to device management in Azure Active Directory'
nullable: true
memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
registeredOwners:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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.
x-ms-navigationProperty: true
registeredUsers:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
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.'
x-ms-navigationProperty: true
transitiveMemberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: Groups and administrative units that the device is a member of. This operation is transitive. Supports $expand.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the device. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.authenticationPhoneType:
title: authenticationPhoneType
enum:
- mobile
- alternateMobile
- office
- unknownFutureValue
type: string
microsoft.graph.authenticationMethodSignInState:
title: authenticationMethodSignInState
enum:
- notSupported
- notAllowedByPolicy
- notEnabled
- phoneNumberNotUnique
- ready
- notConfigured
- unknownFutureValue
type: string
microsoft.graph.authenticationMethodKeyStrength:
title: authenticationMethodKeyStrength
enum:
- normal
- weak
- unknown
type: string
microsoft.graph.teamworkUserIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: teamworkUserIdentity
type: object
properties:
userIdentityType:
$ref: '#/components/schemas/microsoft.graph.teamworkUserIdentityType'
additionalProperties:
type: object
microsoft.graph.wellknownListName:
title: wellknownListName
enum:
- none
- defaultList
- flaggedEmails
- unknownFutureValue
type: string
microsoft.graph.todoTask:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: todoTask
type: object
properties:
body:
$ref: '#/components/schemas/microsoft.graph.itemBody'
bodyLastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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''.'
format: date-time
categories:
type: array
items:
type: string
nullable: true
description: The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.
completedDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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''.'
format: date-time
dueDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
hasAttachments:
type: boolean
description: Indicates whether the task has attachments.
nullable: true
importance:
$ref: '#/components/schemas/microsoft.graph.importance'
isReminderOn:
type: boolean
description: Set to true if an alert is set to remind the user of the task.
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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''.'
format: date-time
recurrence:
$ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
reminderDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
startDateTime:
$ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
status:
$ref: '#/components/schemas/microsoft.graph.taskStatus'
title:
type: string
description: A brief description of the task.
nullable: true
attachments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachmentBase'
description: A collection of file attachments for the task.
x-ms-navigationProperty: true
attachmentSessions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.attachmentSession'
x-ms-navigationProperty: true
checklistItems:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.checklistItem'
description: A collection of checklistItems linked to a task.
x-ms-navigationProperty: true
extensions:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the task. Nullable.
x-ms-navigationProperty: true
linkedResources:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.linkedResource'
description: A collection of resources linked to the task.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workbookFilter:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookFilter
type: object
properties:
criteria:
$ref: '#/components/schemas/microsoft.graph.workbookFilterCriteria'
additionalProperties:
type: object
microsoft.graph.workbookSortField:
title: workbookSortField
type: object
properties:
ascending:
type: boolean
description: Represents whether the sorting is done in an ascending fashion.
color:
type: string
description: Represents the color that is the target of the condition if the sorting is on font or cell color.
nullable: true
dataOption:
type: string
description: 'Represents additional sorting options for this field. The possible values are: Normal, TextAsNumber.'
icon:
$ref: '#/components/schemas/microsoft.graph.workbookIcon'
key:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).'
format: int32
sortOn:
type: string
description: 'Represents the type of sorting of this condition. The possible values are: Value, CellColor, FontColor, Icon.'
additionalProperties:
type: object
microsoft.graph.workbookChartAxes:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxes
type: object
properties:
categoryAxis:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxis'
seriesAxis:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxis'
valueAxis:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxis'
additionalProperties:
type: object
microsoft.graph.workbookChartDataLabels:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartDataLabels
type: object
properties:
position:
type: string
description: 'DataLabelPosition value that represents the position of the data label. The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.'
nullable: true
separator:
type: string
description: String representing the separator used for the data labels on a chart.
nullable: true
showBubbleSize:
type: boolean
description: Boolean value representing if the data label bubble size is visible or not.
nullable: true
showCategoryName:
type: boolean
description: Boolean value representing if the data label category name is visible or not.
nullable: true
showLegendKey:
type: boolean
description: Boolean value representing if the data label legend key is visible or not.
nullable: true
showPercentage:
type: boolean
description: Boolean value representing if the data label percentage is visible or not.
nullable: true
showSeriesName:
type: boolean
description: Boolean value representing if the data label series name is visible or not.
nullable: true
showValue:
type: boolean
description: Boolean value representing if the data label value is visible or not.
nullable: true
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartDataLabelFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartAreaFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAreaFormat
type: object
properties:
fill:
$ref: '#/components/schemas/microsoft.graph.workbookChartFill'
font:
$ref: '#/components/schemas/microsoft.graph.workbookChartFont'
additionalProperties:
type: object
microsoft.graph.workbookChartLegend:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartLegend
type: object
properties:
overlay:
type: boolean
description: Boolean value for whether the chart legend should overlap with the main body of the chart.
nullable: true
position:
type: string
description: 'Represents the position of the legend on the chart. The possible values are: Top, Bottom, Left, Right, Corner, Custom.'
nullable: true
visible:
type: boolean
description: A boolean value the represents the visibility of a ChartLegend object.
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartLegendFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartSeries:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartSeries
type: object
properties:
name:
type: string
description: Represents the name of a series in a chart.
nullable: true
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartSeriesFormat'
points:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChartPoint'
description: Represents a collection of all points in the series. Read-only.
x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.workbookChartTitle:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartTitle
type: object
properties:
overlay:
type: boolean
description: Boolean value representing if the chart title will overlay the chart or not.
nullable: true
text:
type: string
description: Represents the title text of a chart.
nullable: true
visible:
type: boolean
description: A boolean value the represents the visibility of a chart title object.
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartTitleFormat'
additionalProperties:
type: object
microsoft.graph.workbookWorksheetProtectionOptions:
title: workbookWorksheetProtectionOptions
type: object
properties:
allowAutoFilter:
type: boolean
description: Represents the worksheet protection option of allowing using auto filter feature.
allowDeleteColumns:
type: boolean
description: Represents the worksheet protection option of allowing deleting columns.
allowDeleteRows:
type: boolean
description: Represents the worksheet protection option of allowing deleting rows.
allowFormatCells:
type: boolean
description: Represents the worksheet protection option of allowing formatting cells.
allowFormatColumns:
type: boolean
description: Represents the worksheet protection option of allowing formatting columns.
allowFormatRows:
type: boolean
description: Represents the worksheet protection option of allowing formatting rows.
allowInsertColumns:
type: boolean
description: Represents the worksheet protection option of allowing inserting columns.
allowInsertHyperlinks:
type: boolean
description: Represents the worksheet protection option of allowing inserting hyperlinks.
allowInsertRows:
type: boolean
description: Represents the worksheet protection option of allowing inserting rows.
allowPivotTables:
type: boolean
description: Represents the worksheet protection option of allowing using pivot table feature.
allowSort:
type: boolean
description: Represents the worksheet protection option of allowing using sort feature.
additionalProperties:
type: object
microsoft.graph.teamworkConversationIdentity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.identity'
- title: teamworkConversationIdentity
type: object
properties:
conversationIdentityType:
$ref: '#/components/schemas/microsoft.graph.teamworkConversationIdentityType'
additionalProperties:
type: object
microsoft.graph.scheduleEntityTheme:
title: scheduleEntityTheme
enum:
- white
- blue
- green
- purple
- pink
- yellow
- gray
- darkBlue
- darkGreen
- darkPurple
- darkPink
- darkYellow
- unknownFutureValue
type: string
microsoft.graph.messageActionFlag:
title: messageActionFlag
enum:
- any
- call
- doNotForward
- followUp
- fyi
- forward
- noResponseNecessary
- read
- reply
- replyToAll
- review
type: string
microsoft.graph.sizeRange:
title: sizeRange
type: object
properties:
maximumSize:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
format: int32
nullable: true
minimumSize:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.settingSource:
title: settingSource
type: object
properties:
displayName:
type: string
description: Not yet documented
nullable: true
id:
type: string
description: Not yet documented
nullable: true
sourceType:
$ref: '#/components/schemas/microsoft.graph.settingSourceType'
additionalProperties:
type: object
microsoft.graph.insightIdentity:
title: insightIdentity
type: object
properties:
address:
type: string
description: The email address of the user who shared the item.
nullable: true
displayName:
type: string
description: The display name of the user who shared the item.
nullable: true
id:
type: string
description: The id of the user who shared the item.
nullable: true
additionalProperties:
type: object
microsoft.graph.timeRange:
title: timeRange
type: object
properties:
endTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: End time for the time range.
format: time
nullable: true
startTime:
pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
description: Start time for the time range.
format: time
nullable: true
additionalProperties:
type: object
microsoft.graph.onlineMeetingRole:
title: onlineMeetingRole
enum:
- attendee
- presenter
- unknownFutureValue
- producer
- coorganizer
type: string
microsoft.graph.attendanceInterval:
title: attendanceInterval
type: object
properties:
durationInSeconds:
maximum: 2147483647
minimum: -2147483648
type: integer
description: 'Duration of the meeting interval in seconds; that is, the difference between joinDateTime and leaveDateTime.'
format: int32
nullable: true
joinDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The time the attendee joined in UTC.
format: date-time
nullable: true
leaveDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The time the attendee left in UTC.
format: date-time
nullable: true
additionalProperties:
type: object
microsoft.graph.alternativeSecurityId:
title: alternativeSecurityId
type: object
properties:
identityProvider:
type: string
description: For internal use only
nullable: true
key:
type: string
description: For internal use only
format: base64url
nullable: true
type:
maximum: 2147483647
minimum: -2147483648
type: integer
description: For internal use only
format: int32
nullable: true
additionalProperties:
type: object
microsoft.graph.teamworkUserIdentityType:
title: teamworkUserIdentityType
enum:
- aadUser
- onPremiseAadUser
- anonymousGuest
- federatedUser
- personalMicrosoftAccountUser
- skypeUser
- phoneUser
- unknownFutureValue
- emailUser
type: string
microsoft.graph.taskStatus:
title: taskStatus
enum:
- notStarted
- inProgress
- completed
- waitingOnOthers
- deferred
type: string
microsoft.graph.attachmentBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachmentBase
type: object
properties:
contentType:
type: string
description: The MIME type.
nullable: true
lastModifiedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.'
format: date-time
nullable: true
name:
type: string
description: The display name of the attachment. This does not need to be the actual file name.
nullable: true
size:
maximum: 2147483647
minimum: -2147483648
type: integer
description: The length of the attachment in bytes.
format: int32
additionalProperties:
type: object
microsoft.graph.attachmentSession:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: attachmentSession
type: object
properties:
content:
type: string
description: The content streams that are uploaded.
format: base64url
nullable: true
expirationDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
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.
format: date-time
nullable: true
nextExpectedRanges:
type: array
items:
type: string
nullable: true
description: 'Indicates a single value {start} that represents the location in the file where the next upload should begin.'
additionalProperties:
type: object
microsoft.graph.checklistItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: checklistItem
type: object
properties:
checkedDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the checklistItem was finished.
format: date-time
nullable: true
createdDateTime:
pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$'
type: string
description: The date and time when the checklistItem was created.
format: date-time
displayName:
type: string
description: Field indicating the title of checklistItem.
nullable: true
isChecked:
type: boolean
description: State indicating whether the item is checked off or not.
nullable: true
additionalProperties:
type: object
microsoft.graph.linkedResource:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: linkedResource
type: object
properties:
applicationName:
type: string
description: The app name of the source that sends the linkedResource.
nullable: true
displayName:
type: string
description: The title of the linkedResource.
nullable: true
externalId:
type: string
description: ID of the object that is associated with this task on the third-party/partner system.
nullable: true
webUrl:
type: string
description: Deep link to the linkedResource.
nullable: true
additionalProperties:
type: object
microsoft.graph.workbookFilterCriteria:
title: workbookFilterCriteria
type: object
properties:
color:
type: string
nullable: true
criterion1:
type: string
nullable: true
criterion2:
type: string
nullable: true
dynamicCriteria:
type: string
filterOn:
type: string
icon:
$ref: '#/components/schemas/microsoft.graph.workbookIcon'
operator:
type: string
values:
$ref: '#/components/schemas/microsoft.graph.Json'
additionalProperties:
type: object
microsoft.graph.workbookIcon:
title: workbookIcon
type: object
properties:
index:
maximum: 2147483647
minimum: -2147483648
type: integer
description: Represents the index of the icon in the given set.
format: int32
set:
type: string
description: 'Represents the set that the icon is part of. The possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.'
additionalProperties:
type: object
microsoft.graph.workbookChartAxis:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxis
type: object
properties:
majorUnit:
$ref: '#/components/schemas/microsoft.graph.Json'
maximum:
$ref: '#/components/schemas/microsoft.graph.Json'
minimum:
$ref: '#/components/schemas/microsoft.graph.Json'
minorUnit:
$ref: '#/components/schemas/microsoft.graph.Json'
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxisFormat'
majorGridlines:
$ref: '#/components/schemas/microsoft.graph.workbookChartGridlines'
minorGridlines:
$ref: '#/components/schemas/microsoft.graph.workbookChartGridlines'
title:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxisTitle'
additionalProperties:
type: object
microsoft.graph.workbookChartDataLabelFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartDataLabelFormat
type: object
properties:
fill:
$ref: '#/components/schemas/microsoft.graph.workbookChartFill'
font:
$ref: '#/components/schemas/microsoft.graph.workbookChartFont'
additionalProperties:
type: object
microsoft.graph.workbookChartFill:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartFill
type: object
additionalProperties:
type: object
microsoft.graph.workbookChartFont:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartFont
type: object
properties:
bold:
type: boolean
description: Represents the bold status of font.
nullable: true
color:
type: string
description: 'HTML color code representation of the text color. E.g. #FF0000 represents Red.'
nullable: true
italic:
type: boolean
description: Represents the italic status of the font.
nullable: true
name:
type: string
description: Font name (e.g. 'Calibri')
nullable: true
size:
type: number
description: Size of the font (e.g. 11)
format: double
nullable: true
underline:
type: string
description: 'Type of underline applied to the font. The possible values are: None, Single.'
nullable: true
additionalProperties:
type: object
microsoft.graph.workbookChartLegendFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartLegendFormat
type: object
properties:
fill:
$ref: '#/components/schemas/microsoft.graph.workbookChartFill'
font:
$ref: '#/components/schemas/microsoft.graph.workbookChartFont'
additionalProperties:
type: object
microsoft.graph.workbookChartSeriesFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartSeriesFormat
type: object
properties:
fill:
$ref: '#/components/schemas/microsoft.graph.workbookChartFill'
line:
$ref: '#/components/schemas/microsoft.graph.workbookChartLineFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartPoint:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartPoint
type: object
properties:
value:
$ref: '#/components/schemas/microsoft.graph.Json'
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartPointFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartTitleFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartTitleFormat
type: object
properties:
fill:
$ref: '#/components/schemas/microsoft.graph.workbookChartFill'
font:
$ref: '#/components/schemas/microsoft.graph.workbookChartFont'
additionalProperties:
type: object
microsoft.graph.teamworkConversationIdentityType:
title: teamworkConversationIdentityType
enum:
- team
- channel
- chat
- unknownFutureValue
type: string
microsoft.graph.settingSourceType:
title: settingSourceType
enum:
- deviceConfiguration
- deviceIntent
type: string
microsoft.graph.workbookChartAxisFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxisFormat
type: object
properties:
font:
$ref: '#/components/schemas/microsoft.graph.workbookChartFont'
line:
$ref: '#/components/schemas/microsoft.graph.workbookChartLineFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartGridlines:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartGridlines
type: object
properties:
visible:
type: boolean
description: Boolean value representing if the axis gridlines are visible or not.
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartGridlinesFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartAxisTitle:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxisTitle
type: object
properties:
text:
type: string
description: Represents the axis title.
nullable: true
visible:
type: boolean
description: A boolean that specifies the visibility of an axis title.
format:
$ref: '#/components/schemas/microsoft.graph.workbookChartAxisTitleFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartLineFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartLineFormat
type: object
properties:
color:
type: string
description: HTML color code representing the color of lines in the chart.
nullable: true
additionalProperties:
type: object
microsoft.graph.workbookChartPointFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartPointFormat
type: object
properties:
fill:
$ref: '#/components/schemas/microsoft.graph.workbookChartFill'
additionalProperties:
type: object
microsoft.graph.workbookChartGridlinesFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartGridlinesFormat
type: object
properties:
line:
$ref: '#/components/schemas/microsoft.graph.workbookChartLineFormat'
additionalProperties:
type: object
microsoft.graph.workbookChartAxisTitleFormat:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookChartAxisTitleFormat
type: object
properties:
font:
$ref: '#/components/schemas/microsoft.graph.workbookChartFont'
additionalProperties:
type: object
responses:
microsoft.graph.agreementCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementCollectionResponse'
error:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
microsoft.graph.agreementAcceptanceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementAcceptanceCollectionResponse'
ODataCountResponse:
description: The count of the resource
content:
text/plain:
schema:
$ref: '#/components/schemas/ODataCountResponse'
microsoft.graph.agreementFileLocalizationCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileLocalizationCollectionResponse'
microsoft.graph.agreementFileVersionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.agreementFileVersionCollectionResponse'
microsoft.graph.accessReviewScheduleDefinitionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinitionCollectionResponse'
microsoft.graph.accessReviewInstanceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceCollectionResponse'
microsoft.graph.accessReviewReviewerCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewReviewerCollectionResponse'
microsoft.graph.accessReviewInstanceDecisionItemCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemCollectionResponse'
microsoft.graph.accessReviewStageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewStageCollectionResponse'
microsoft.graph.accessReviewHistoryDefinitionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinitionCollectionResponse'
microsoft.graph.accessReviewHistoryInstanceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstanceCollectionResponse'
microsoft.graph.appConsentRequestCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.appConsentRequestCollectionResponse'
microsoft.graph.userConsentRequestCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.userConsentRequestCollectionResponse'
microsoft.graph.approvalStageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalStageCollectionResponse'
microsoft.graph.approvalCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.approvalCollectionResponse'
microsoft.graph.accessPackageCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCollectionResponse'
microsoft.graph.accessPackageAssignmentPolicyCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicyCollectionResponse'
microsoft.graph.accessPackageQuestionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageQuestionCollectionResponse'
StringCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/StringCollectionResponse'
microsoft.graph.groupCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.groupCollectionResponse'
microsoft.graph.accessPackageAssignmentRequestCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestCollectionResponse'
microsoft.graph.accessPackageAssignmentCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentCollectionResponse'
microsoft.graph.accessPackageCatalogCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.accessPackageCatalogCollectionResponse'
microsoft.graph.connectedOrganizationCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.connectedOrganizationCollectionResponse'
microsoft.graph.directoryObjectCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.directoryObjectCollectionResponse'
microsoft.graph.unifiedRbacResourceNamespaceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceNamespaceCollectionResponse'
microsoft.graph.unifiedRbacResourceActionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRbacResourceActionCollectionResponse'
microsoft.graph.unifiedRoleAssignmentCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentCollectionResponse'
microsoft.graph.unifiedRoleAssignmentScheduleInstanceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleInstanceCollectionResponse'
microsoft.graph.unifiedRoleAssignmentScheduleRequestCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleRequestCollectionResponse'
microsoft.graph.unifiedRoleAssignmentScheduleCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleAssignmentScheduleCollectionResponse'
microsoft.graph.unifiedRoleDefinitionCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleDefinitionCollectionResponse'
microsoft.graph.unifiedRoleEligibilityScheduleInstanceCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleInstanceCollectionResponse'
microsoft.graph.unifiedRoleEligibilityScheduleRequestCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleRequestCollectionResponse'
microsoft.graph.unifiedRoleEligibilityScheduleCollectionResponse:
description: Retrieved collection
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.unifiedRoleEligibilityScheduleCollectionResponse'
parameters:
search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
filter:
name: $filter
in: query
description: Filter items by property values
style: form
explode: false
schema:
type: string
count:
name: $count
in: query
description: Include count of items
style: form
explode: false
schema:
type: boolean
requestBodies:
refPostBody:
description: New navigation property ref value
content:
application/json:
schema:
$ref: '#/components/schemas/ReferenceCreate'
required: true
securitySchemes:
azureaadv2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
scopes: { }
security:
- azureaadv2: [ ]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment