diff --git a/.azure-pipelines/ci-build.yml b/.azure-pipelines/ci-build.yml index f511dfd83d5..2ff694bc2aa 100644 --- a/.azure-pipelines/ci-build.yml +++ b/.azure-pipelines/ci-build.yml @@ -26,7 +26,7 @@ trigger: branches: include: - main - - features/2.0 + - dev pr: none jobs: @@ -69,11 +69,11 @@ jobs: publishLocation: "Container" - task: NuGetCommand@2 - displayName: Publish NuGet to preview feed + displayName: Publish NuGet to feed inputs: command: push packagesToPush: $(Build.ArtifactStagingDirectory)/**/Microsoft.Graph.*.nupkg - publishVstsFeed: $(PROJECT_NAME)/$(PREVIEW_FEED_NAME) + publishVstsFeed: $(PROJECT_NAME)/$(FEED_NAME) allowPackageConflicts: true - template: ./common-templates/security-post-checks.yml diff --git a/.azure-pipelines/common-templates/download-openapi-docs.yml b/.azure-pipelines/common-templates/download-openapi-docs.yml index 6ad3780c417..cba9ef760d2 100644 --- a/.azure-pipelines/common-templates/download-openapi-docs.yml +++ b/.azure-pipelines/common-templates/download-openapi-docs.yml @@ -90,7 +90,7 @@ steps: pwsh: true targetType: inline script: | - . "$(System.DefaultWorkingDirectory)\tools\Versions\BumpModuleVersion.ps1" -BumpV1Module -BumpBetaModule -BumpAuthModule -PreReleaseTag "rc" -Debug + . "$(System.DefaultWorkingDirectory)\tools\Versions\BumpModuleVersion.ps1" -BumpV1Module -BumpBetaModule -BumpAuthModule -Debug - task: Bash@3 displayName: Commit downloaded files diff --git a/.azure-pipelines/weekly-examples-update.yml b/.azure-pipelines/weekly-examples-update.yml index d997035c999..83cb7cfc177 100644 --- a/.azure-pipelines/weekly-examples-update.yml +++ b/.azure-pipelines/weekly-examples-update.yml @@ -8,7 +8,7 @@ schedules: displayName: 'PowerShellExamplesUpdateV2' branches: include: - - features/2.0 + - dev always: true parameters: - name: PipelineTimeout @@ -25,7 +25,7 @@ resources: type: github endpoint: microsoftgraph name: microsoftgraph/msgraph-sdk-powershell - ref: features/2.0 + ref: dev jobs: - job: PowerShellExamplesUpdateV2 @@ -88,7 +88,7 @@ jobs: - template: ./common-templates/create-pr.yml parameters: - BaseBranch: "features/2.0" + BaseBranch: "dev" TargetBranch: $(ComputeBranch.WeeklyExamplesBranch) Title: "[v2] Examples Update" Body: "This pull request was automatically created by Azure Pipelines. **Important** Check for unexpected deletions or changes in this PR." \ No newline at end of file diff --git a/.azure-pipelines/weekly-preview-generation.yml b/.azure-pipelines/weekly-generation.yml similarity index 94% rename from .azure-pipelines/weekly-preview-generation.yml rename to .azure-pipelines/weekly-generation.yml index 70adfd31a26..ff84c68f6d4 100644 --- a/.azure-pipelines/weekly-preview-generation.yml +++ b/.azure-pipelines/weekly-generation.yml @@ -9,7 +9,7 @@ parameters: default: 1es-windows-ps-compute - name: BaseBranch displayName: Base Branch - default: features/2.0 + default: dev - name: GenerationBranch displayName: Generation branch default: v2/generation @@ -35,7 +35,7 @@ parameters: type: boolean variables: - Branch: "WeeklyPreviewRefresh" + Branch: "WeeklyApiRefresh" BaseBranch: ${{ parameters.BaseBranch }} GenerationBranch: ${{ parameters.GenerationBranch }} BuildAgent: ${{ parameters.BuildAgent }} @@ -46,10 +46,10 @@ trigger: none pr: none schedules: - cron: "0 12 * * TUE" # Run every Tuesday at noon UTC - displayName: "PS SDK Preview Weekly Refresh" + displayName: "PS SDK Weekly Refresh" branches: include: - - features/2.0 + - dev always: true jobs: - job: RefreshOpenAPIDocuments @@ -73,6 +73,9 @@ jobs: variables: WeeklyBranch: $[ dependencies.RefreshOpenAPIDocuments.outputs['ComputeBranch.WeeklyBranch'] ] steps: + - template: ./common-templates/checkout.yml + parameters: + TargetBranch: $(GenerationBranch) # Gives git local knowledge of the branch for merge. - template: ./common-templates/checkout.yml parameters: TargetBranch: $(WeeklyBranch) @@ -105,11 +108,11 @@ jobs: ArtifactName: "drop" publishLocation: "Container" - task: NuGetCommand@2 - displayName: Publish NuGet to preview feed + displayName: Publish NuGet to feed inputs: command: push packagesToPush: $(Build.ArtifactStagingDirectory)/**/Microsoft.Graph.*.nupkg - publishVstsFeed: $(PROJECT_NAME)/$(PREVIEW_FEED_NAME) + publishVstsFeed: $(PROJECT_NAME)/$(FEED_NAME) allowPackageConflicts: true - template: ./generation-templates/generate-command-metadata.yml - template: ./common-templates/security-post-checks.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 2f6fa7ccdfd..c23bae1ecb2 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @peombwa @ddyett @shemogumbe @timayabi2020 +* @microsoftgraph/msgraph-powershell-team \ No newline at end of file diff --git a/.github/policies/msgraph-sdk-powershell-branch-protection.yml b/.github/policies/msgraph-sdk-powershell-branch-protection.yml new file mode 100644 index 00000000000..d5c33a9e16d --- /dev/null +++ b/.github/policies/msgraph-sdk-powershell-branch-protection.yml @@ -0,0 +1,108 @@ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. + +# File initially created using https://github.com/MIchaelMainer/policyservicetoolkit/blob/main/branch_protection_export.ps1. + +name: msgraph-sdk-powershell-branch-protection +description: Branch protection policy for the msgraph-sdk-powershell repository +resource: repository +configuration: + branchProtectionRules: + + - branchNamePattern: main + # This branch pattern applies to the following branches as of 06/12/2023 10:31:18: + # main + + # Specifies whether this branch can be deleted. boolean + allowsDeletions: false + # Specifies whether forced pushes are allowed on this branch. boolean + allowsForcePushes: false + # Specifies whether new commits pushed to the matching branches dismiss pull request review approvals. boolean + dismissStaleReviews: false + # Specifies whether admins can overwrite branch protection. boolean + isAdminEnforced: false + # Indicates whether "Require a pull request before merging" is enabled. boolean + requiresPullRequestBeforeMerging: true + # Specifies the number of pull request reviews before merging. int (0-6). Should be null/empty if PRs are not required + requiredApprovingReviewsCount: 1 + # Require review from Code Owners. Requires requiredApprovingReviewsCount. boolean + requireCodeOwnersReview: false + # Are commits required to be signed. boolean. TODO: all contributors must have commit signing on local machines. + requiresCommitSignatures: false + # Are conversations required to be resolved before merging? boolean + requiresConversationResolution: false + # Are merge commits prohibited from being pushed to this branch. boolean + requiresLinearHistory: false + # Require branches to be up to date before merging. Requires requiredStatusChecks. boolean + requiresStrictStatusChecks: true + # Indicates whether there are restrictions on who can push. boolean. Should be set with whoCanPush. + restrictsPushes: false + # Restrict who can dismiss pull request reviews. boolean + restrictsReviewDismissals: false + + - branchNamePattern: dev + # This branch pattern applies to the following branches as of 06/12/2023 10:31:18: + # dev + + # Specifies whether this branch can be deleted. boolean + allowsDeletions: false + # Specifies whether forced pushes are allowed on this branch. boolean + allowsForcePushes: false + # Specifies whether new commits pushed to the matching branches dismiss pull request review approvals. boolean + dismissStaleReviews: true + # Specifies whether admins can overwrite branch protection. boolean + isAdminEnforced: false + # Indicates whether "Require a pull request before merging" is enabled. boolean + requiresPullRequestBeforeMerging: true + # Specifies the number of pull request reviews before merging. int (0-6). Should be null/empty if PRs are not required + requiredApprovingReviewsCount: 1 + # Require review from Code Owners. Requires requiredApprovingReviewsCount. boolean + requireCodeOwnersReview: true + # Are commits required to be signed. boolean. TODO: all contributors must have commit signing on local machines. + requiresCommitSignatures: false + # Are conversations required to be resolved before merging? boolean + requiresConversationResolution: false + # Are merge commits prohibited from being pushed to this branch. boolean + requiresLinearHistory: false + # Required status checks to pass before merging. Values can be any string, but if the value does not correspond to any existing status check, the status check will be stuck on pending for status since nothing exists to push an actual status + requiredStatusChecks: + - license/cla + # Require branches to be up to date before merging. Requires requiredStatusChecks. boolean + requiresStrictStatusChecks: true + # Indicates whether there are restrictions on who can push. boolean. Should be set with whoCanPush. + restrictsPushes: false + # Restrict who can dismiss pull request reviews. boolean + restrictsReviewDismissals: false + + - branchNamePattern: features/[0-9]* + # This branch pattern applies to the following branches as of 06/12/2023 10:31:18: + # features/2.0 + + # Specifies whether this branch can be deleted. boolean + allowsDeletions: false + # Specifies whether forced pushes are allowed on this branch. boolean + allowsForcePushes: false + # Specifies whether new commits pushed to the matching branches dismiss pull request review approvals. boolean + dismissStaleReviews: true + # Specifies whether admins can overwrite branch protection. boolean + isAdminEnforced: false + # Indicates whether "Require a pull request before merging" is enabled. boolean + requiresPullRequestBeforeMerging: true + # Specifies the number of pull request reviews before merging. int (0-6). Should be null/empty if PRs are not required + requiredApprovingReviewsCount: 1 + # Require review from Code Owners. Requires requiredApprovingReviewsCount. boolean + requireCodeOwnersReview: false + # Are commits required to be signed. boolean. TODO: all contributors must have commit signing on local machines. + requiresCommitSignatures: false + # Are conversations required to be resolved before merging? boolean + requiresConversationResolution: false + # Are merge commits prohibited from being pushed to this branch. boolean + requiresLinearHistory: false + # Required status checks to pass before merging. Values can be any string, but if the value does not correspond to any existing status check, the status check will be stuck on pending for status since nothing exists to push an actual status + requiredStatusChecks: + # Require branches to be up to date before merging. Requires requiredStatusChecks. boolean + requiresStrictStatusChecks: true + # Indicates whether there are restrictions on who can push. boolean. Should be set with whoCanPush. + restrictsPushes: false + # Restrict who can dismiss pull request reviews. boolean + restrictsReviewDismissals: false diff --git a/config/ModulesMapping.jsonc b/config/ModulesMapping.jsonc index faa58ec686f..c51d614b2f6 100644 --- a/config/ModulesMapping.jsonc +++ b/config/ModulesMapping.jsonc @@ -9,7 +9,7 @@ "Devices.CloudPrint": "^print\\.", "Devices.CorporateManagement": "^deviceAppManagement\\.|^officeConfiguration\\.|^users.mobileAppIntentAndState$|^users.mobileAppTroubleshootingEvent$|^users.windowsInformationProtectionDeviceRegistration$|^users.managedAppRegistration$|^users.managedDevice$|^users.deviceManagementTroubleshootingEvent$|^users.deviceEnrollmentConfiguration$", "Devices.ServiceAnnouncement": "^admin.serviceAnnouncement$|^admin.Actions$|^admin.Functions$", - "DeviceManagement": "^deviceManagement.(deviceCompliancePolicy.*|deviceManagementConfigurationPolicy.*|deviceManagementCompliancePolicy.*|deviceManagementConfigurationSettingDefinition.*|deviceConfiguration.*|managedDevice.*|managementCondition.*|microsoftTunnel.*|userExperienceAnalytics.*|windowsInformationProtection.*|deviceManagement|deviceManagement(DerivedCredentialSettings|Intent|ResourceAccessProfileBase|Script|SettingCategory|SettingDefinition|Template|TroubleshootingEvent)|androidForWork(AppConfigurationSchema|Settings)|androidManagedStore(AccountEnterpriseSettings|AppConfigurationSchema)|deviceAndAppManagementAssignmentFilter|deviceCategory|advancedThreatProtectionOnboardingStateSummary|dataSharingConsent|detectedApp|deviceHealthScript|deviceShellScript|embeddedSIMActivationCodePool|groupPolicyConfiguration|macOSSoftwareUpdateAccountSummary|mobileAppTroubleshootingEvent|notificationMessageTemplate|remoteActionAudit|softwareUpdateStatusSummary|windowsMalwareInformation)$|^print.printer$|^print.printerShare$|^admin.edge$|^deviceManagement.monitoring$|^users.ListCloudPCs$", + "DeviceManagement": "^deviceManagement.(deviceCompliancePolicy.*|deviceManagementConfigurationPolicy.*|deviceManagementCompliancePolicy.*|deviceManagementConfigurationSettingDefinition.*|deviceConfiguration.*|managedDevice.*|managementCondition.*|microsoftTunnel.*|userExperienceAnalytics.*|windowsInformationProtection.*|deviceManagement|deviceManagement(DerivedCredentialSettings|Intent|ResourceAccessProfileBase|Script|SettingCategory|SettingDefinition|Template|TroubleshootingEvent)|androidForWork(AppConfigurationSchema|Settings)|androidManagedStore(AccountEnterpriseSettings|AppConfigurationSchema)|deviceAndAppManagementAssignmentFilter|deviceCategory|advancedThreatProtectionOnboardingStateSummary|dataSharingConsent|detectedApp|deviceHealthScript|deviceShellScript|embeddedSIMActivationCodePool|groupPolicyConfiguration|macOSSoftwareUpdateAccountSummary|mobileAppTroubleshootingEvent|notificationMessageTemplate|remoteActionAudit|softwareUpdateStatusSummary|windowsMalwareInformation)$|^admin.edge$|^deviceManagement.monitoring$|^users.ListCloudPCs$", "DeviceManagement.Administration": "^deviceManagement.(virtualEndpoint.*|.*Partner.*|.*Certificate.*|.*role.*|deviceManagement(DomainJoinConnector|ExchangeConnector|ExchangeOnPremisesPolicy)|groupPolicy(Category|Definition|DefinitionFile|MigrationReport|ObjectFile|UploadedDefinitionFile)|auditEvent|cartToClassAssociation|comanagementEligibleDevice|deviceAndAppManagementRoleAssignment|intuneBrandingProfile|iosUpdateDeviceStatus|mobileThreatDefenseConnector|ndesConnector|resourceOperation|restrictedAppsViolation|termsAndConditions)", "DeviceManagement.Enrollment": "^deviceManagement.(.*Enrollment.*|.*Autopilot.*|.*depOnboarding.*|importedDeviceIdentity|onPremisesConditionalAccessSettings|windowsFeatureUpdateProfile)$|^roleManagement.roleManagement$|^roleManagement.rbacApplicationMultiple$", "DeviceManagement.Actions": "^deviceManagement.Actions$", diff --git a/openApiDocs/beta/Applications.yml b/openApiDocs/beta/Applications.yml index 58e5ab709ab..0db956e9838 100644 --- a/openApiDocs/beta/Applications.yml +++ b/openApiDocs/beta/Applications.yml @@ -2641,7 +2641,7 @@ paths: tags: - applications.directoryObject summary: Get the number of the resource - operationId: application.ListOwner_GetCountAsEndpoint + operationId: application.Owner_GetCountAsEndpoint parameters: - name: application-id in: path @@ -2751,7 +2751,7 @@ paths: tags: - applications.directoryObject summary: Get the number of the resource - operationId: application.ListOwner_GetCountAsServicePrincipal + operationId: application.Owner_GetCountAsServicePrincipal parameters: - name: application-id in: path @@ -2861,7 +2861,7 @@ paths: tags: - applications.directoryObject summary: Get the number of the resource - operationId: application.ListOwner_GetCountAsUser + operationId: application.Owner_GetCountAsUser parameters: - name: application-id in: path @@ -12979,7 +12979,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListCreatedObject_GetCountAsServicePrincipal + operationId: servicePrincipal.CreatedObject_GetCountAsServicePrincipal parameters: - name: servicePrincipal-id in: path @@ -14713,7 +14713,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListMemberOf_GetCountAsAdministrativeUnit + operationId: servicePrincipal.MemberOf_GetCountAsAdministrativeUnit parameters: - name: servicePrincipal-id in: path @@ -14823,7 +14823,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListMemberOf_GetCountAsGroup + operationId: servicePrincipal.MemberOf_GetCountAsGroup parameters: - name: servicePrincipal-id in: path @@ -15939,7 +15939,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwnedObject_GetCountAsApplication + operationId: servicePrincipal.OwnedObject_GetCountAsApplication parameters: - name: servicePrincipal-id in: path @@ -16029,7 +16029,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwnedObject_GetCountAsEndpoint + operationId: servicePrincipal.OwnedObject_GetCountAsEndpoint parameters: - name: servicePrincipal-id in: path @@ -16119,7 +16119,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwnedObject_GetCountAsGroup + operationId: servicePrincipal.OwnedObject_GetCountAsGroup parameters: - name: servicePrincipal-id in: path @@ -16209,7 +16209,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwnedObject_GetCountAsServicePrincipal + operationId: servicePrincipal.OwnedObject_GetCountAsServicePrincipal parameters: - name: servicePrincipal-id in: path @@ -16755,7 +16755,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwner_GetCountAsEndpoint + operationId: servicePrincipal.Owner_GetCountAsEndpoint parameters: - name: servicePrincipal-id in: path @@ -16865,7 +16865,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwner_GetCountAsServicePrincipal + operationId: servicePrincipal.Owner_GetCountAsServicePrincipal parameters: - name: servicePrincipal-id in: path @@ -16975,7 +16975,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListOwner_GetCountAsUser + operationId: servicePrincipal.Owner_GetCountAsUser parameters: - name: servicePrincipal-id in: path @@ -20270,7 +20270,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListTransitiveMemberOf_GetCountAsAdministrativeUnit + operationId: servicePrincipal.TransitiveMemberOf_GetCountAsAdministrativeUnit parameters: - name: servicePrincipal-id in: path @@ -20380,7 +20380,7 @@ paths: tags: - servicePrincipals.directoryObject summary: Get the number of the resource - operationId: servicePrincipal.ListTransitiveMemberOf_GetCountAsGroup + operationId: servicePrincipal.TransitiveMemberOf_GetCountAsGroup parameters: - name: servicePrincipal-id in: path @@ -21882,7 +21882,7 @@ components: nullable: true isManagementRestricted: type: boolean - description: 'true if the user is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.' + description: 'true if the user is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a user who is a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.' nullable: true isResourceAccount: type: boolean @@ -22188,6 +22188,11 @@ components: $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership' description: The scoped-role administrative unit memberships for this user. Read-only. Nullable. x-ms-navigationProperty: true + sponsors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + x-ms-navigationProperty: true transitiveMemberOf: type: array items: @@ -22376,6 +22381,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.userActivity' + description: The user's activities across devices. Read-only. Nullable. x-ms-navigationProperty: true devices: type: array @@ -22386,6 +22392,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.onlineMeeting' + description: 'Information about a meeting, including the URL used to join a meeting, the attendees'' list, and the description.' x-ms-navigationProperty: true presence: $ref: '#/components/schemas/microsoft.graph.presence' @@ -22402,6 +22409,11 @@ components: $ref: '#/components/schemas/microsoft.graph.team' description: The Microsoft Teams teams that the user is a member of. Read-only. Nullable. x-ms-navigationProperty: true + permissionGrants: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' + x-ms-navigationProperty: true teamwork: $ref: '#/components/schemas/microsoft.graph.userTeamwork' todo: @@ -23035,7 +23047,7 @@ components: nullable: true isMemberManagementRestricted: type: boolean - description: 'true if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. Default value is false. Use this property to define administrative units whose roles don''t inherit from tenant-level administrators, and management of individual member objects is limited to administrators scoped to a restricted management administrative unit. Immutable, so cannot be changed later.' + description: 'true if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. Default value is false. Use this property to define administrative units whose roles don''t inherit from tenant-level administrators, and management of individual member objects is limited to administrators scoped to a restricted management administrative unit. Immutable, so cannot be changed later. For more information about working with restricted management administrative units, see Restricted management administrative units in Azure Active Directory.' nullable: true visibility: type: string @@ -23125,7 +23137,7 @@ components: nullable: true isManagementRestricted: type: boolean - description: 'Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.' + description: 'Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a group that''s a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.' nullable: true licenseProcessingState: $ref: '#/components/schemas/microsoft.graph.licenseProcessingState' @@ -23639,6 +23651,7 @@ components: properties: removeUnverifiedEmailClaim: type: boolean + description: Removes the email claim from tokens sent to an application when the email address's domain cannot be verified. nullable: true requireClientServicePrincipal: type: boolean @@ -26766,40 +26779,50 @@ components: 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' @@ -26807,6 +26830,7 @@ components: 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 @@ -26894,7 +26918,7 @@ components: nullable: true isManagementRestricted: type: boolean - description: 'true if the device is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.' + description: 'true if the device is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a device that''s a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.' nullable: true isRooted: type: boolean @@ -27475,6 +27499,34 @@ components: $ref: '#/components/schemas/microsoft.graph.schedule' 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.userTeamwork: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -28084,34 +28136,6 @@ components: $ref: '#/components/schemas/microsoft.graph.MembershipRuleProcessingStatusDetails' 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.directorySetting: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -28845,11 +28869,11 @@ components: properties: key: type: string - description: 'Contains the name of the field that a value is associated with. When a sign in or domain hint is included in the sign-in request, corresponding fields are included as key-value pairs. Possible keys: Login hint present, Domain hint present.' + description: Contains the name of the field that a value is associated with. nullable: true value: type: string - description: Contains the corresponding value for the specified key. The value is true if a sign in hint was included in the sign-in request; otherwise false. The value is true if a domain hint was included in the sign-in request; otherwise false. + description: Contains the corresponding value for the specified key. nullable: true additionalProperties: type: object @@ -32680,15 +32704,15 @@ components: nullable: true fullScanOverdue: type: boolean - description: Full scan overdue or not? + description: 'When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.' nullable: true fullScanRequired: type: boolean - description: Full scan required or not? + description: 'When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.' nullable: true isVirtualMachine: type: boolean - description: Indicates whether the device is a virtual machine. + description: 'When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.' nullable: true lastFullScanDateTime: 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])$' @@ -32718,29 +32742,29 @@ components: nullable: true malwareProtectionEnabled: type: boolean - description: Anti malware is enabled or not + description: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled. nullable: true networkInspectionSystemEnabled: type: boolean - description: Network inspection system enabled or not? + description: 'When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.' nullable: true productStatus: $ref: '#/components/schemas/microsoft.graph.windowsDefenderProductStatus' quickScanOverdue: type: boolean - description: Quick scan overdue or not? + description: 'When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.' nullable: true realTimeProtectionEnabled: type: boolean - description: Real time protection is enabled or not? + description: 'When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.' nullable: true rebootRequired: type: boolean - description: Reboot required or not? + description: 'When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.' nullable: true signatureUpdateOverdue: type: boolean - description: Signature out of date or not? + description: 'When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.' nullable: true signatureVersion: type: string @@ -32748,7 +32772,7 @@ components: nullable: true tamperProtectionEnabled: type: boolean - description: Indicates whether the Windows Defender tamper protection feature is enabled. + description: 'When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.' nullable: true detectedMalwareState: type: array @@ -34083,18 +34107,18 @@ components: properties: identityProvider: type: string - description: For internal use only + description: For internal use only. nullable: true key: type: string - description: For internal use only + description: For internal use only. format: base64url nullable: true type: maximum: 2147483647 minimum: -2147483648 type: integer - description: For internal use only + description: For internal use only. format: int32 nullable: true additionalProperties: @@ -35399,6 +35423,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.offerShiftRequest' + description: The offer requests for shifts in the schedule. x-ms-navigationProperty: true openShiftChangeRequests: type: array @@ -36034,7 +36059,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' - innererror: + innerError: $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' additionalProperties: type: object @@ -37752,7 +37777,7 @@ components: properties: format: type: string - description: 'For dateTime output types, the format of the value. Must be one of dateOnly or dateTime.' + description: 'For dateTime output types, the format of the value. Possible values are: dateOnly or dateTime.' nullable: true formula: type: string @@ -37760,7 +37785,7 @@ components: 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.' + description: 'The output type used to format values in this column. Possible values are: boolean, currency, dateTime, number, or text.' nullable: true additionalProperties: type: object @@ -37819,11 +37844,11 @@ components: properties: formula: type: string - description: The formula used to compute the default value for this column. + description: The formula used to compute the default value for the column. nullable: true value: type: string - description: The direct value to use as the default value for this column. + description: The direct value to use as the default value for the column. nullable: true additionalProperties: type: object @@ -37916,7 +37941,7 @@ components: properties: id: type: string - description: The id of the content type. + description: The ID of the content type. nullable: true name: type: string @@ -38081,13 +38106,13 @@ components: properties: default: type: boolean - description: Whether this is the default Content Type + description: Indicates 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. + description: Specifies the position in which the content type appears in the selection UI. format: int32 nullable: true additionalProperties: @@ -40998,21 +41023,25 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer + description: Count of guests in a channel. format: int32 nullable: true hasMembersFromOtherTenants: type: boolean + description: Indicates whether external members are included on the channel. nullable: true membersCount: maximum: 2147483647 minimum: -2147483648 type: integer + description: Count of members in a channel. format: int32 nullable: true ownersCount: maximum: 2147483647 minimum: -2147483648 type: integer + description: Count of owners in a channel. format: int32 nullable: true additionalProperties: diff --git a/openApiDocs/beta/Bookings.yml b/openApiDocs/beta/Bookings.yml index 6cfbd30a55a..c1c2cd1581c 100644 --- a/openApiDocs/beta/Bookings.yml +++ b/openApiDocs/beta/Bookings.yml @@ -11,7 +11,7 @@ paths: tags: - bookingBusinesses.bookingBusiness summary: List bookingBusinesses - description: 'Get a collection of bookingBusiness objects that has been created for the tenant. This operation returns only the **id** and **displayName** of each Microsoft Bookings business in the collection. For performance considerations, it does not return other properties. You can get the other properties of a Bookings business by specifying its **id** in a GET operation. You can also query for Bookings businesses by specifying a string in a `query` parameter to do substring matching among the businesses of a tenant. See an example below.' + description: 'Get a collection of bookingBusiness objects that has been created for the tenant. This operation returns only the **id** and **displayName** of each Microsoft Bookings business in the collection. For performance considerations, it does not return other properties. You can get the other properties of a Bookings business by specifying its **id** in a GET operation. You can also query for Bookings businesses by specifying a string in a `query` parameter to do substring matching among the businesses of a tenant. For details, see Example 2.' externalDocs: description: Find more info here url: https://docs.microsoft.com/graph/api/bookingbusiness-list?view=graph-rest-1.0 @@ -7554,11 +7554,11 @@ paths: get: tags: - solutions.virtualEventsRoot - summary: Get externalMeetingRegistration - description: Get the externalMeetingRegistration details associated with an onlineMeeting. + summary: Get meetingRegistration + description: Get the meetingRegistration details associated with an onlineMeeting on behalf of the organizer. externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/externalmeetingregistration-get?view=graph-rest-1.0 + url: https://docs.microsoft.com/graph/api/meetingregistration-get?view=graph-rest-1.0 operationId: solution.virtualEvent.event.session_GetRegistration parameters: - name: virtualEvent-id @@ -8847,7 +8847,11 @@ paths: get: tags: - solutions.virtualEventsRoot - summary: Get virtualAppointment from solutions + summary: Get virtualAppointment (deprecated) + description: Read the properties and relationships of a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-get?view=graph-rest-1.0 operationId: solution.virtualEvent.event.session_GetVirtualAppointment parameters: - name: virtualEvent-id @@ -8914,7 +8918,11 @@ paths: patch: tags: - solutions.virtualEventsRoot - summary: Update the navigation property virtualAppointment in solutions + summary: Create virtualAppointment (deprecated) + description: Create a new virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-put?view=graph-rest-1.0 operationId: solution.virtualEvent.event.session_UpdateVirtualAppointment parameters: - name: virtualEvent-id @@ -8959,7 +8967,11 @@ paths: delete: tags: - solutions.virtualEventsRoot - summary: Delete navigation property virtualAppointment for solutions + summary: Delete virtualAppointment (deprecated) + description: Delete a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-delete?view=graph-rest-1.0 operationId: solution.virtualEvent.event.session_DeleteVirtualAppointment parameters: - name: virtualEvent-id @@ -11823,11 +11835,11 @@ paths: get: tags: - solutions.virtualEventsRoot - summary: Get externalMeetingRegistration - description: Get the externalMeetingRegistration details associated with an onlineMeeting. + summary: Get meetingRegistration + description: Get the meetingRegistration details associated with an onlineMeeting on behalf of the organizer. externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/externalmeetingregistration-get?view=graph-rest-1.0 + url: https://docs.microsoft.com/graph/api/meetingregistration-get?view=graph-rest-1.0 operationId: solution.virtualEvent.webinar.session_GetRegistration parameters: - name: virtualEventWebinar-id @@ -13116,7 +13128,11 @@ paths: get: tags: - solutions.virtualEventsRoot - summary: Get virtualAppointment from solutions + summary: Get virtualAppointment (deprecated) + description: Read the properties and relationships of a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-get?view=graph-rest-1.0 operationId: solution.virtualEvent.webinar.session_GetVirtualAppointment parameters: - name: virtualEventWebinar-id @@ -13183,7 +13199,11 @@ paths: patch: tags: - solutions.virtualEventsRoot - summary: Update the navigation property virtualAppointment in solutions + summary: Create virtualAppointment (deprecated) + description: Create a new virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-put?view=graph-rest-1.0 operationId: solution.virtualEvent.webinar.session_UpdateVirtualAppointment parameters: - name: virtualEventWebinar-id @@ -13228,7 +13248,11 @@ paths: delete: tags: - solutions.virtualEventsRoot - summary: Delete navigation property virtualAppointment for solutions + summary: Delete virtualAppointment (deprecated) + description: Delete a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-delete?view=graph-rest-1.0 operationId: solution.virtualEvent.webinar.session_DeleteVirtualAppointment parameters: - name: virtualEventWebinar-id @@ -15978,7 +16002,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' - innererror: + innerError: $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' additionalProperties: type: object diff --git a/openApiDocs/beta/Calendar.yml b/openApiDocs/beta/Calendar.yml index 9add0546537..8968aea0aad 100644 --- a/openApiDocs/beta/Calendar.yml +++ b/openApiDocs/beta/Calendar.yml @@ -23476,7 +23476,7 @@ paths: tags: - places.place summary: Get the number of the resource - operationId: place.ListPlace_GetCountAsRoom + operationId: place_GetCountAsRoom parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' @@ -76149,7 +76149,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' - innererror: + innerError: $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' additionalProperties: type: object diff --git a/openApiDocs/beta/ChangeNotifications.yml b/openApiDocs/beta/ChangeNotifications.yml index a31c5eb8034..04473467b7a 100644 --- a/openApiDocs/beta/ChangeNotifications.yml +++ b/openApiDocs/beta/ChangeNotifications.yml @@ -342,7 +342,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' - innererror: + innerError: $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' additionalProperties: type: object diff --git a/openApiDocs/beta/CloudCommunications.yml b/openApiDocs/beta/CloudCommunications.yml index 4394dc890ea..5d7bcc62dd7 100644 --- a/openApiDocs/beta/CloudCommunications.yml +++ b/openApiDocs/beta/CloudCommunications.yml @@ -5512,11 +5512,11 @@ paths: get: tags: - communications.onlineMeeting - summary: Get externalMeetingRegistration - description: Get the externalMeetingRegistration details associated with an onlineMeeting. + summary: Get meetingRegistration + description: Get the meetingRegistration details associated with an onlineMeeting on behalf of the organizer. externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/externalmeetingregistration-get?view=graph-rest-1.0 + url: https://docs.microsoft.com/graph/api/meetingregistration-get?view=graph-rest-1.0 operationId: communication.onlineMeeting_GetRegistration parameters: - name: onlineMeeting-id @@ -6605,7 +6605,11 @@ paths: get: tags: - communications.onlineMeeting - summary: Get virtualAppointment from communications + summary: Get virtualAppointment (deprecated) + description: Read the properties and relationships of a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-get?view=graph-rest-1.0 operationId: communication.onlineMeeting_GetVirtualAppointment parameters: - name: onlineMeeting-id @@ -6664,7 +6668,11 @@ paths: patch: tags: - communications.onlineMeeting - summary: Update the navigation property virtualAppointment in communications + summary: Create virtualAppointment (deprecated) + description: Create a new virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-put?view=graph-rest-1.0 operationId: communication.onlineMeeting_UpdateVirtualAppointment parameters: - name: onlineMeeting-id @@ -6701,7 +6709,11 @@ paths: delete: tags: - communications.onlineMeeting - summary: Delete navigation property virtualAppointment for communications + summary: Delete virtualAppointment (deprecated) + description: Delete a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-delete?view=graph-rest-1.0 operationId: communication.onlineMeeting_DeleteVirtualAppointment parameters: - name: onlineMeeting-id @@ -7429,6 +7441,7 @@ paths: tags: - users.onlineMeeting summary: Get onlineMeetings from users + description: 'Information about a meeting, including the URL used to join a meeting, the attendees'' list, and the description.' operationId: user_GetOnlineMeeting parameters: - name: user-id @@ -9465,11 +9478,11 @@ paths: get: tags: - users.onlineMeeting - summary: Get externalMeetingRegistration - description: Get the externalMeetingRegistration details associated with an onlineMeeting. + summary: Get meetingRegistration + description: Get the meetingRegistration details associated with an onlineMeeting on behalf of the organizer. externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/externalmeetingregistration-get?view=graph-rest-1.0 + url: https://docs.microsoft.com/graph/api/meetingregistration-get?view=graph-rest-1.0 operationId: user.onlineMeeting_GetRegistration parameters: - name: user-id @@ -10758,7 +10771,11 @@ paths: get: tags: - users.onlineMeeting - summary: Get virtualAppointment from users + summary: Get virtualAppointment (deprecated) + description: Read the properties and relationships of a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-get?view=graph-rest-1.0 operationId: user.onlineMeeting_GetVirtualAppointment parameters: - name: user-id @@ -10825,7 +10842,11 @@ paths: patch: tags: - users.onlineMeeting - summary: Update the navigation property virtualAppointment in users + summary: Create virtualAppointment (deprecated) + description: Create a new virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-put?view=graph-rest-1.0 operationId: user.onlineMeeting_UpdateVirtualAppointment parameters: - name: user-id @@ -10870,7 +10891,11 @@ paths: delete: tags: - users.onlineMeeting - summary: Delete navigation property virtualAppointment for users + summary: Delete virtualAppointment (deprecated) + description: Delete a virtualAppointment object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/virtualappointment-delete?view=graph-rest-1.0 operationId: user.onlineMeeting_DeleteVirtualAppointment parameters: - name: user-id @@ -10933,11 +10958,11 @@ paths: get: tags: - users.presence - summary: Get presence - description: Get a user's presence information. + summary: 'presence: setStatusMessage' + description: Set a presence status message for a user. An optional expiration date and time can be supplied. externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/presence-get?view=graph-rest-1.0 + url: https://docs.microsoft.com/graph/api/presence-setstatusmessage?view=graph-rest-1.0 operationId: user_GetPresence parameters: - name: user-id @@ -13816,7 +13841,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' - innererror: + innerError: $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' additionalProperties: type: object diff --git a/openApiDocs/beta/Compliance.yml b/openApiDocs/beta/Compliance.yml index c65633a36cb..7455ecc29dd 100644 --- a/openApiDocs/beta/Compliance.yml +++ b/openApiDocs/beta/Compliance.yml @@ -5652,7 +5652,7 @@ paths: tags: - compliance.ediscoveryroot summary: Get the number of the resource - operationId: compliance.ediscovery.case.ListOperation_GetCountAsCaseExportOperation + operationId: compliance.ediscovery.case.Operation_GetCountAsCaseExportOperation parameters: - name: case-id in: path @@ -8831,3506 +8831,3133 @@ paths: date: '2022-12-05T00:00:00.0000000+00:00' version: 2022-12/ediscoveryNamespace description: 'The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security.' -components: - schemas: - microsoft.graph.compliance: - title: compliance - type: object - properties: - ediscovery: - $ref: '#/components/schemas/microsoft.graph.ediscovery.ediscoveryroot' - additionalProperties: - type: object - microsoft.graph.ediscovery.ediscoveryroot: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: ediscoveryroot - type: object - properties: - cases: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.case' - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.ediscovery.case: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: case - type: object - properties: - closedBy: - $ref: '#/components/schemas/microsoft.graph.identitySet' - closedDateTime: - 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 case was closed. 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 - 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])$' + /privacy/subjectRightsRequests: + get: + tags: + - privacy.subjectRightsRequest + summary: List subjectRightsRequests + description: Get a list of subjectRightsRequest objects and their properties. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/subjectrightsrequest-list?view=graph-rest-1.0 + operationId: privacy_ListSubjectRightsRequest + 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 + - assignedTo + - assignedTo desc + - closedDateTime + - closedDateTime desc + - contentQuery + - contentQuery desc + - createdBy + - createdBy desc + - createdDateTime + - createdDateTime desc + - dataSubject + - dataSubject desc + - dataSubjectType + - dataSubjectType desc + - description + - description desc + - displayName + - displayName desc + - externalId + - externalId desc + - history + - history desc + - includeAllVersions + - includeAllVersions desc + - includeAuthoredContent + - includeAuthoredContent desc + - insight + - insight desc + - internalDueDateTime + - internalDueDateTime desc + - lastModifiedBy + - lastModifiedBy desc + - lastModifiedDateTime + - lastModifiedDateTime desc + - mailboxlocations + - mailboxlocations desc + - pauseAfterEstimate + - pauseAfterEstimate desc + - regulations + - regulations desc + - sitelocations + - sitelocations desc + - stages + - stages desc + - status + - status desc + - type + - type desc type: string - description: 'The date and time when the entity 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 - description: + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - assignedTo + - closedDateTime + - contentQuery + - createdBy + - createdDateTime + - dataSubject + - dataSubjectType + - description + - displayName + - externalId + - history + - includeAllVersions + - includeAuthoredContent + - insight + - internalDueDateTime + - lastModifiedBy + - lastModifiedDateTime + - mailboxlocations + - pauseAfterEstimate + - regulations + - sitelocations + - stages + - status + - type + - approvers + - collaborators + - notes + - team type: string - description: The case description. - nullable: true - displayName: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - approvers + - collaborators + - notes + - team type: string - description: The case name. - nullable: true - externalId: + responses: + 2XX: + $ref: '#/components/responses/microsoft.graph.subjectRightsRequestCollectionResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - privacy.subjectRightsRequest + summary: Create subjectRightsRequest + description: Create a new subjectRightsRequest object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/subjectrightsrequest-post?view=graph-rest-1.0 + operationId: privacy_CreateSubjectRightsRequest + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' + required: true + responses: + 2XX: + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}': + get: + tags: + - privacy.subjectRightsRequest + summary: Get subjectRightsRequest + description: Read the properties and relationships of a subjectRightsRequest object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/subjectrightsrequest-get?view=graph-rest-1.0 + operationId: privacy_GetSubjectRightsRequest + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - assignedTo + - closedDateTime + - contentQuery + - createdBy + - createdDateTime + - dataSubject + - dataSubjectType + - description + - displayName + - externalId + - history + - includeAllVersions + - includeAuthoredContent + - insight + - internalDueDateTime + - lastModifiedBy + - lastModifiedDateTime + - mailboxlocations + - pauseAfterEstimate + - regulations + - sitelocations + - stages + - status + - type + - approvers + - collaborators + - notes + - team type: string - description: The external case number for customer reference. - 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])$' + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - approvers + - collaborators + - notes + - team type: string - description: 'The latest date and time when the case was modified. 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 - status: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseStatus' - custodians: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.custodian' - description: Returns a list of case custodian objects for this case. Nullable. - x-ms-navigationProperty: true - legalHolds: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.legalHold' - description: Returns a list of case legalHold objects for this case. Nullable. - x-ms-navigationProperty: true - noncustodialDataSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.noncustodialDataSource' - description: Returns a list of case noncustodialDataSource objects for this case. Nullable. - x-ms-navigationProperty: true - operations: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' - description: Returns a list of case operation objects for this case. Nullable. - x-ms-navigationProperty: true - reviewSets: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' - description: Returns a list of reviewSet objects in the case. Read-only. Nullable. - x-ms-navigationProperty: true - settings: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseSettings' - sourceCollections: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' - description: Returns a list of sourceCollection objects associated with this case. - x-ms-navigationProperty: true - tags: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' - description: Returns a list of tag objects associated to this case. - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.ediscovery.custodian: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceContainer' - - title: custodian - type: object - properties: - acknowledgedDateTime: - 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])$' + responses: + 2XX: + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + patch: + tags: + - privacy.subjectRightsRequest + summary: Update subjectRightsRequest + description: Update the properties of a subjectRightsRequest object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/subjectrightsrequest-update?view=graph-rest-1.0 + operationId: privacy_UpdateSubjectRightsRequest + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' + required: true + responses: + 2XX: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + delete: + tags: + - privacy.subjectRightsRequest + summary: Delete navigation property subjectRightsRequests for privacy + operationId: privacy_DeleteSubjectRightsRequest + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + 2XX: + description: Success + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers': + get: + tags: + - privacy.subjectRightsRequest + summary: Get approvers from privacy + operationId: privacy.subjectRightsRequest_ListApprover + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - $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 + - deletedDateTime + - deletedDateTime desc + - signInActivity + - signInActivity desc + - accountEnabled + - accountEnabled desc + - ageGroup + - ageGroup desc + - assignedLicenses + - assignedLicenses desc + - assignedPlans + - assignedPlans desc + - authorizationInfo + - authorizationInfo desc + - businessPhones + - businessPhones desc + - city + - city desc + - companyName + - companyName desc + - consentProvidedForMinor + - consentProvidedForMinor desc + - country + - country desc + - createdDateTime + - createdDateTime desc + - creationType + - creationType desc + - customSecurityAttributes + - customSecurityAttributes desc + - department + - department desc + - deviceKeys + - deviceKeys desc + - displayName + - displayName desc + - employeeHireDate + - employeeHireDate desc + - employeeId + - employeeId desc + - employeeLeaveDateTime + - employeeLeaveDateTime desc + - employeeOrgData + - employeeOrgData desc + - employeeType + - employeeType desc + - externalUserState + - externalUserState desc + - externalUserStateChangeDateTime + - externalUserStateChangeDateTime desc + - faxNumber + - faxNumber desc + - givenName + - givenName desc + - identities + - identities desc + - imAddresses + - imAddresses desc + - infoCatalogs + - infoCatalogs desc + - isLicenseReconciliationNeeded + - isLicenseReconciliationNeeded desc + - isManagementRestricted + - isManagementRestricted desc + - isResourceAccount + - isResourceAccount desc + - jobTitle + - jobTitle desc + - lastPasswordChangeDateTime + - lastPasswordChangeDateTime desc + - legalAgeGroupClassification + - legalAgeGroupClassification desc + - licenseAssignmentStates + - licenseAssignmentStates desc + - mail + - mail desc + - mailNickname + - mailNickname desc + - mobilePhone + - mobilePhone desc + - officeLocation + - officeLocation desc + - onPremisesDistinguishedName + - onPremisesDistinguishedName desc + - onPremisesDomainName + - onPremisesDomainName desc + - onPremisesExtensionAttributes + - onPremisesExtensionAttributes desc + - onPremisesImmutableId + - onPremisesImmutableId desc + - onPremisesLastSyncDateTime + - onPremisesLastSyncDateTime desc + - onPremisesProvisioningErrors + - onPremisesProvisioningErrors desc + - onPremisesSamAccountName + - onPremisesSamAccountName desc + - onPremisesSecurityIdentifier + - onPremisesSecurityIdentifier desc + - onPremisesSyncEnabled + - onPremisesSyncEnabled desc + - onPremisesUserPrincipalName + - onPremisesUserPrincipalName desc + - otherMails + - otherMails desc + - passwordPolicies + - passwordPolicies desc + - passwordProfile + - passwordProfile desc + - postalCode + - postalCode desc + - preferredDataLocation + - preferredDataLocation desc + - preferredLanguage + - preferredLanguage desc + - provisionedPlans + - provisionedPlans desc + - proxyAddresses + - proxyAddresses desc + - refreshTokensValidFromDateTime + - refreshTokensValidFromDateTime desc + - securityIdentifier + - securityIdentifier desc + - serviceProvisioningErrors + - serviceProvisioningErrors desc + - showInAddressList + - showInAddressList desc + - signInSessionsValidFromDateTime + - signInSessionsValidFromDateTime desc + - state + - state desc + - streetAddress + - streetAddress desc + - surname + - surname desc + - usageLocation + - usageLocation desc + - userPrincipalName + - userPrincipalName desc + - userType + - userType desc + - mailboxSettings + - mailboxSettings desc + - deviceEnrollmentLimit + - deviceEnrollmentLimit desc + - print + - print desc + - aboutMe + - aboutMe desc + - birthday + - birthday desc + - hireDate + - hireDate desc + - interests + - interests desc + - mySite + - mySite desc + - pastProjects + - pastProjects desc + - preferredName + - preferredName desc + - responsibilities + - responsibilities desc + - schools + - schools desc + - skills + - skills desc type: string - description: Date and time the custodian acknowledged a hold notification. - format: date-time - nullable: true - applyHoldToSources: - type: boolean - description: Identifies whether a custodian's sources were placed on hold during creation. - nullable: true - email: + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - deletedDateTime + - signInActivity + - accountEnabled + - ageGroup + - assignedLicenses + - assignedPlans + - authorizationInfo + - businessPhones + - city + - companyName + - consentProvidedForMinor + - country + - createdDateTime + - creationType + - customSecurityAttributes + - department + - deviceKeys + - displayName + - employeeHireDate + - employeeId + - employeeLeaveDateTime + - employeeOrgData + - employeeType + - externalUserState + - externalUserStateChangeDateTime + - faxNumber + - givenName + - identities + - imAddresses + - infoCatalogs + - isLicenseReconciliationNeeded + - isManagementRestricted + - isResourceAccount + - jobTitle + - lastPasswordChangeDateTime + - legalAgeGroupClassification + - licenseAssignmentStates + - mail + - mailNickname + - mobilePhone + - officeLocation + - onPremisesDistinguishedName + - onPremisesDomainName + - onPremisesExtensionAttributes + - onPremisesImmutableId + - onPremisesLastSyncDateTime + - onPremisesProvisioningErrors + - onPremisesSamAccountName + - onPremisesSecurityIdentifier + - onPremisesSyncEnabled + - onPremisesUserPrincipalName + - otherMails + - passwordPolicies + - passwordProfile + - postalCode + - preferredDataLocation + - preferredLanguage + - provisionedPlans + - proxyAddresses + - refreshTokensValidFromDateTime + - securityIdentifier + - serviceProvisioningErrors + - showInAddressList + - signInSessionsValidFromDateTime + - state + - streetAddress + - surname + - usageLocation + - userPrincipalName + - userType + - mailboxSettings + - deviceEnrollmentLimit + - print + - aboutMe + - birthday + - hireDate + - interests + - mySite + - pastProjects + - preferredName + - responsibilities + - schools + - skills + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience type: string - description: Email address of the custodian. - siteSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.siteSource' - description: Data source entity for SharePoint sites associated with the custodian. - x-ms-navigationProperty: true - unifiedGroupSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.unifiedGroupSource' - description: Data source entity for groups associated with the custodian. - x-ms-navigationProperty: true - userSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.userSource' - description: Data source entity for a the custodian. This is the container for a custodian's mailbox and OneDrive for Business site. - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.ediscovery.caseIndexOperation: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' - - title: caseIndexOperation - type: object - additionalProperties: - type: object - microsoft.graph.ediscovery.siteSource: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - - title: siteSource - type: object - properties: - site: - $ref: '#/components/schemas/microsoft.graph.site' - additionalProperties: - type: object - microsoft.graph.site: - allOf: - - $ref: '#/components/schemas/microsoft.graph.baseItem' - - title: site - type: object - properties: - deleted: - $ref: '#/components/schemas/microsoft.graph.deleted' - displayName: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience type: string - description: The full title for the site. Read-only. - nullable: true - root: - $ref: '#/components/schemas/microsoft.graph.root' - settings: - $ref: '#/components/schemas/microsoft.graph.siteSettings' - sharepointIds: - $ref: '#/components/schemas/microsoft.graph.sharepointIds' - siteCollection: - $ref: '#/components/schemas/microsoft.graph.siteCollection' - informationProtection: - $ref: '#/components/schemas/microsoft.graph.informationProtection' - 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' - description: The collection of column definitions available in the site that are referenced from the sites in the parent hierarchy of the current site. - x-ms-navigationProperty: true + responses: + 2XX: + $ref: '#/components/responses/microsoft.graph.userCollectionResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id}': + get: + tags: + - privacy.subjectRightsRequest + summary: Get approvers from privacy + operationId: privacy.subjectRightsRequest_GetApprover + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: user-id + in: path + description: The unique identifier of user + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array items: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.baseItem' - description: Used to address any item contained in this site. This collection cannot 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 for the site. - x-ms-navigationProperty: true - pages: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.sitePage' - description: The collection of pages in the SitePages list in this 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' - onenote: - $ref: '#/components/schemas/microsoft.graph.onenote' - additionalProperties: - type: object - microsoft.graph.ediscovery.unifiedGroupSource: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - - title: unifiedGroupSource - type: object - properties: - includedSources: - $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceType' - group: - $ref: '#/components/schemas/microsoft.graph.group' - 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: + enum: + - id + - deletedDateTime + - signInActivity + - accountEnabled + - ageGroup + - assignedLicenses + - assignedPlans + - authorizationInfo + - businessPhones + - city + - companyName + - consentProvidedForMinor + - country + - createdDateTime + - creationType + - customSecurityAttributes + - department + - deviceKeys + - displayName + - employeeHireDate + - employeeId + - employeeLeaveDateTime + - employeeOrgData + - employeeType + - externalUserState + - externalUserStateChangeDateTime + - faxNumber + - givenName + - identities + - imAddresses + - infoCatalogs + - isLicenseReconciliationNeeded + - isManagementRestricted + - isResourceAccount + - jobTitle + - lastPasswordChangeDateTime + - legalAgeGroupClassification + - licenseAssignmentStates + - mail + - mailNickname + - mobilePhone + - officeLocation + - onPremisesDistinguishedName + - onPremisesDomainName + - onPremisesExtensionAttributes + - onPremisesImmutableId + - onPremisesLastSyncDateTime + - onPremisesProvisioningErrors + - onPremisesSamAccountName + - onPremisesSecurityIdentifier + - onPremisesSyncEnabled + - onPremisesUserPrincipalName + - otherMails + - passwordPolicies + - passwordProfile + - postalCode + - preferredDataLocation + - preferredLanguage + - provisionedPlans + - proxyAddresses + - refreshTokensValidFromDateTime + - securityIdentifier + - serviceProvisioningErrors + - showInAddressList + - signInSessionsValidFromDateTime + - state + - streetAddress + - surname + - usageLocation + - userPrincipalName + - userType + - mailboxSettings + - deviceEnrollmentLimit + - print + - aboutMe + - birthday + - hireDate + - interests + - mySite + - pastProjects + - preferredName + - responsibilities + - schools + - skills + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience 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 - createdByAppId: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience type: string - description: 'App ID of the app used to create the group. Can be null for some groups. Returned by default. Read-only. Supports $filter (eq, ne, not, in, 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])$' + responses: + 2XX: + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.user' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id}/mailboxSettings': + get: + tags: + - privacy.subjectRightsRequest + summary: Get mailboxSettings property value + description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. For more information, see User preferences for languages and regional formats. Returned only on $select.' + operationId: privacy.subjectRightsRequest.approver_GetMailboxSetting + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: user-id + in: path + description: The unique identifier of user + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - archiveFolder + - automaticRepliesSetting + - dateFormat + - delegateMeetingMessageDeliveryOptions + - language + - timeFormat + - timeZone + - userPurpose + - userPurposeV2 + - workingHours 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: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' 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. Required. 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). Supports $filter (eq).' - nullable: true - infoCatalogs: - type: array - items: - type: string - description: 'Identifies the info segments assigned to the group. Returned by default. Supports $filter (eq, not, ge, le, startsWith).' - isAssignableToRole: - type: boolean - description: 'Indicates whether this group can be assigned to an Azure Active Directory role. 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 - isManagementRestricted: - type: boolean - description: 'Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.' - nullable: true - licenseProcessingState: - $ref: '#/components/schemas/microsoft.graph.licenseProcessingState' - mail: - type: string - description: 'The SMTP address for the group, for example, ''serviceadmins@contoso.onmicrosoft.com''. 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, and eq on null values).' - 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. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith).' - 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 - description: 'Contains the on-premises domain FQDN, 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.Returned by default. Read-only.' - 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: + responses: + 2XX: + description: Result entities + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + patch: + tags: + - privacy.subjectRightsRequest + summary: Update property mailboxSettings value. + operationId: privacy.subjectRightsRequest.approver_UpdateMailboxSetting + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: user-id + in: path + description: The unique identifier of user + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + requestBody: + description: New property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + required: true + responses: + 2XX: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/$count': + get: + tags: + - privacy.subjectRightsRequest + summary: Get the number of the resource + operationId: privacy.subjectRightsRequest.approver_GetCount + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + responses: + 2XX: + $ref: '#/components/responses/ODataCountResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators': + get: + tags: + - privacy.subjectRightsRequest + summary: Get collaborators from privacy + operationId: privacy.subjectRightsRequest_ListCollaborator + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - $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 + - deletedDateTime + - deletedDateTime desc + - signInActivity + - signInActivity desc + - accountEnabled + - accountEnabled desc + - ageGroup + - ageGroup desc + - assignedLicenses + - assignedLicenses desc + - assignedPlans + - assignedPlans desc + - authorizationInfo + - authorizationInfo desc + - businessPhones + - businessPhones desc + - city + - city desc + - companyName + - companyName desc + - consentProvidedForMinor + - consentProvidedForMinor desc + - country + - country desc + - createdDateTime + - createdDateTime desc + - creationType + - creationType desc + - customSecurityAttributes + - customSecurityAttributes desc + - department + - department desc + - deviceKeys + - deviceKeys desc + - displayName + - displayName desc + - employeeHireDate + - employeeHireDate desc + - employeeId + - employeeId desc + - employeeLeaveDateTime + - employeeLeaveDateTime desc + - employeeOrgData + - employeeOrgData desc + - employeeType + - employeeType desc + - externalUserState + - externalUserState desc + - externalUserStateChangeDateTime + - externalUserStateChangeDateTime desc + - faxNumber + - faxNumber desc + - givenName + - givenName desc + - identities + - identities desc + - imAddresses + - imAddresses desc + - infoCatalogs + - infoCatalogs desc + - isLicenseReconciliationNeeded + - isLicenseReconciliationNeeded desc + - isManagementRestricted + - isManagementRestricted desc + - isResourceAccount + - isResourceAccount desc + - jobTitle + - jobTitle desc + - lastPasswordChangeDateTime + - lastPasswordChangeDateTime desc + - legalAgeGroupClassification + - legalAgeGroupClassification desc + - licenseAssignmentStates + - licenseAssignmentStates desc + - mail + - mail desc + - mailNickname + - mailNickname desc + - mobilePhone + - mobilePhone desc + - officeLocation + - officeLocation desc + - onPremisesDistinguishedName + - onPremisesDistinguishedName desc + - onPremisesDomainName + - onPremisesDomainName desc + - onPremisesExtensionAttributes + - onPremisesExtensionAttributes desc + - onPremisesImmutableId + - onPremisesImmutableId desc + - onPremisesLastSyncDateTime + - onPremisesLastSyncDateTime desc + - onPremisesProvisioningErrors + - onPremisesProvisioningErrors desc + - onPremisesSamAccountName + - onPremisesSamAccountName desc + - onPremisesSecurityIdentifier + - onPremisesSecurityIdentifier desc + - onPremisesSyncEnabled + - onPremisesSyncEnabled desc + - onPremisesUserPrincipalName + - onPremisesUserPrincipalName desc + - otherMails + - otherMails desc + - passwordPolicies + - passwordPolicies desc + - passwordProfile + - passwordProfile desc + - postalCode + - postalCode desc + - preferredDataLocation + - preferredDataLocation desc + - preferredLanguage + - preferredLanguage desc + - provisionedPlans + - provisionedPlans desc + - proxyAddresses + - proxyAddresses desc + - refreshTokensValidFromDateTime + - refreshTokensValidFromDateTime desc + - securityIdentifier + - securityIdentifier desc + - serviceProvisioningErrors + - serviceProvisioningErrors desc + - showInAddressList + - showInAddressList desc + - signInSessionsValidFromDateTime + - signInSessionsValidFromDateTime desc + - state + - state desc + - streetAddress + - streetAddress desc + - surname + - surname desc + - usageLocation + - usageLocation desc + - userPrincipalName + - userPrincipalName desc + - userType + - userType desc + - mailboxSettings + - mailboxSettings desc + - deviceEnrollmentLimit + - deviceEnrollmentLimit desc + - print + - print desc + - aboutMe + - aboutMe desc + - birthday + - birthday desc + - hireDate + - hireDate desc + - interests + - interests desc + - mySite + - mySite desc + - pastProjects + - pastProjects desc + - preferredName + - preferredName desc + - responsibilities + - responsibilities desc + - schools + - schools desc + - skills + - skills desc type: string - description: Contains the on-premises netBios 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. Read-only. - 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: + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - deletedDateTime + - signInActivity + - accountEnabled + - ageGroup + - assignedLicenses + - assignedPlans + - authorizationInfo + - businessPhones + - city + - companyName + - consentProvidedForMinor + - country + - createdDateTime + - creationType + - customSecurityAttributes + - department + - deviceKeys + - displayName + - employeeHireDate + - employeeId + - employeeLeaveDateTime + - employeeOrgData + - employeeType + - externalUserState + - externalUserStateChangeDateTime + - faxNumber + - givenName + - identities + - imAddresses + - infoCatalogs + - isLicenseReconciliationNeeded + - isManagementRestricted + - isResourceAccount + - jobTitle + - lastPasswordChangeDateTime + - legalAgeGroupClassification + - licenseAssignmentStates + - mail + - mailNickname + - mobilePhone + - officeLocation + - onPremisesDistinguishedName + - onPremisesDomainName + - onPremisesExtensionAttributes + - onPremisesImmutableId + - onPremisesLastSyncDateTime + - onPremisesProvisioningErrors + - onPremisesSamAccountName + - onPremisesSecurityIdentifier + - onPremisesSyncEnabled + - onPremisesUserPrincipalName + - otherMails + - passwordPolicies + - passwordProfile + - postalCode + - preferredDataLocation + - preferredLanguage + - provisionedPlans + - proxyAddresses + - refreshTokensValidFromDateTime + - securityIdentifier + - serviceProvisioningErrors + - showInAddressList + - signInSessionsValidFromDateTime + - state + - streetAddress + - surname + - usageLocation + - userPrincipalName + - userType + - mailboxSettings + - deviceEnrollmentLimit + - print + - aboutMe + - birthday + - hireDate + - interests + - mySite + - pastProjects + - preferredName + - responsibilities + - schools + - skills + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience 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: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience 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 - organizationId: - type: string - 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: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. The any operator is required for 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])$' + responses: + 2XX: + $ref: '#/components/responses/microsoft.graph.userCollectionResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id}': + get: + tags: + - privacy.subjectRightsRequest + summary: Get collaborators from privacy + operationId: privacy.subjectRightsRequest_GetCollaborator + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: user-id + in: path + description: The unique identifier of user + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - deletedDateTime + - signInActivity + - accountEnabled + - ageGroup + - assignedLicenses + - assignedPlans + - authorizationInfo + - businessPhones + - city + - companyName + - consentProvidedForMinor + - country + - createdDateTime + - creationType + - customSecurityAttributes + - department + - deviceKeys + - displayName + - employeeHireDate + - employeeId + - employeeLeaveDateTime + - employeeOrgData + - employeeType + - externalUserState + - externalUserStateChangeDateTime + - faxNumber + - givenName + - identities + - imAddresses + - infoCatalogs + - isLicenseReconciliationNeeded + - isManagementRestricted + - isResourceAccount + - jobTitle + - lastPasswordChangeDateTime + - legalAgeGroupClassification + - licenseAssignmentStates + - mail + - mailNickname + - mobilePhone + - officeLocation + - onPremisesDistinguishedName + - onPremisesDomainName + - onPremisesExtensionAttributes + - onPremisesImmutableId + - onPremisesLastSyncDateTime + - onPremisesProvisioningErrors + - onPremisesSamAccountName + - onPremisesSecurityIdentifier + - onPremisesSyncEnabled + - onPremisesUserPrincipalName + - otherMails + - passwordPolicies + - passwordProfile + - postalCode + - preferredDataLocation + - preferredLanguage + - provisionedPlans + - proxyAddresses + - refreshTokensValidFromDateTime + - securityIdentifier + - serviceProvisioningErrors + - showInAddressList + - signInSessionsValidFromDateTime + - state + - streetAddress + - surname + - usageLocation + - userPrincipalName + - userType + - mailboxSettings + - deviceEnrollmentLimit + - print + - aboutMe + - birthday + - hireDate + - interests + - mySite + - pastProjects + - preferredName + - responsibilities + - schools + - skills + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience 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 - resourceBehaviorOptions: - type: array - items: - type: string - description: 'Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are AllowOnlyMembersToPost, HideGroupInOutlook, SubscribeNewGroupMembers, WelcomeEmailDisabled. For more information, see Set Microsoft 365 group behaviors and provisioning options.' - resourceProvisioningOptions: - type: array - items: - type: string - description: 'Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith.' - 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: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - analytics + - cloudPCs + - usageRights + - informationProtection + - appRoleAssignedResources + - appRoleAssignments + - createdObjects + - directReports + - licenseDetails + - manager + - memberOf + - oauth2PermissionGrants + - ownedDevices + - ownedObjects + - registeredDevices + - scopedRoleMemberOf + - sponsors + - transitiveMemberOf + - transitiveReports + - calendar + - calendarGroups + - calendars + - calendarView + - contactFolders + - contacts + - events + - inferenceClassification + - joinedGroups + - mailFolders + - messages + - outlook + - people + - drive + - drives + - followedSites + - extensions + - appConsentRequestsForApproval + - approvals + - pendingAccessReviewInstances + - agreementAcceptances + - security + - deviceEnrollmentConfigurations + - managedDevices + - managedAppRegistrations + - windowsInformationProtectionDeviceRegistrations + - deviceManagementTroubleshootingEvents + - mobileAppIntentAndStates + - mobileAppTroubleshootingEvents + - notifications + - planner + - insights + - settings + - onenote + - photo + - photos + - profile + - activities + - devices + - onlineMeetings + - presence + - authentication + - chats + - joinedTeams + - permissionGrants + - teamwork + - todo + - employeeExperience type: string - description: 'Security identifier of the group, used in Windows scenarios. Returned by default.' - nullable: true - serviceProvisioningErrors: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.serviceProvisioningError' - description: 'Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object . Supports $filter (eq, not, for isResolved and serviceInstance).' - theme: + responses: + 2XX: + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.user' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id}/mailboxSettings': + get: + tags: + - privacy.subjectRightsRequest + summary: Get mailboxSettings property value + description: 'Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. For more information, see User preferences for languages and regional formats. Returned only on $select.' + operationId: privacy.subjectRightsRequest.collaborator_GetMailboxSetting + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: user-id + in: path + description: The unique identifier of user + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - archiveFolder + - automaticRepliesSetting + - dateFormat + - delegateMeetingMessageDeliveryOptions + - language + - timeFormat + - timeZone + - userPurpose + - userPurposeV2 + - workingHours 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: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' 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 - writebackConfiguration: - $ref: '#/components/schemas/microsoft.graph.groupWritebackConfiguration' - accessType: - $ref: '#/components/schemas/microsoft.graph.groupAccessType' - 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 user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups; false otherwise. 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, false otherwise. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' - nullable: true - isFavorite: - type: boolean - 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 - unseenConversationsCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: Count of conversations that have been delivered one or more new posts since the signed-in user's last visit to the group. This property is the same as unseenCount. Returned only on $select. - format: int32 - 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. This property is the same as unseenConversationsCount.Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' - format: int32 - nullable: true - unseenMessagesCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: Count of new posts that have been delivered to the group's conversations since the signed-in user's last visit to the group. Returned only on $select. - format: int32 - nullable: true - membershipRuleProcessingStatus: - $ref: '#/components/schemas/microsoft.graph.membershipRuleProcessingStatus' - 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' - endpoints: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.endpoint' - description: Endpoints for the group. Read-only. Nullable. - x-ms-navigationProperty: true - memberOf: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - description: 'Groups and administrative units 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: 'Direct 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 who can be users or service principals. 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 permissions that have been granted for a group to a specific application. Supports $expand. - x-ms-navigationProperty: true - settings: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.directorySetting' - 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 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.ediscovery.userSource: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - - title: userSource - type: object - properties: - email: + responses: + 2XX: + description: Result entities + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + patch: + tags: + - privacy.subjectRightsRequest + summary: Update property mailboxSettings value. + operationId: privacy.subjectRightsRequest.collaborator_UpdateMailboxSetting + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: user-id + in: path + description: The unique identifier of user + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + requestBody: + description: New property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + required: true + responses: + 2XX: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/$count': + get: + tags: + - privacy.subjectRightsRequest + summary: Get the number of the resource + operationId: privacy.subjectRightsRequest.collaborator_GetCount + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + responses: + 2XX: + $ref: '#/components/responses/ODataCountResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/notes': + get: + tags: + - privacy.subjectRightsRequest + summary: List notes + description: 'Get the list of authored notes associated with a subject rights request. ' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/subjectrightsrequest-list-notes?view=graph-rest-1.0 + operationId: privacy.subjectRightsRequest_ListNote + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - $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 + - author + - author desc + - content + - content desc + - createdDateTime + - createdDateTime desc type: string - description: Email address of the user's mailbox. - includedSources: - $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceType' - siteWebUrl: + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - author + - content + - createdDateTime type: string - description: The URL of the user's OneDrive for Business site. Read-only. - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.legalHold: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: legalHold - type: object - properties: - contentQuery: - type: string - description: 'KQL query that specifies content to be held in the specified locations. To learn more, see Keyword queries and search conditions for Content Search and eDiscovery. To hold all content in the specified locations, leave contentQuery blank.' - 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 date and time the legal hold was created. - format: date-time - nullable: true - description: - type: string - description: The legal hold description. - nullable: true - displayName: - type: string - description: The display name of the legal hold. - nullable: true - errors: - type: array - items: - type: string - nullable: true - description: Lists any errors that happened while placing the hold. - isEnabled: - type: boolean - description: Indicates whether the hold is enabled and actively holding content. - 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 the legal hold was last modified. - format: date-time - nullable: true - status: - $ref: '#/components/schemas/microsoft.graph.ediscovery.legalHoldStatus' - siteSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.siteSource' - description: Data source entity for SharePoint sites associated with the legal hold. - x-ms-navigationProperty: true - unifiedGroupSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.unifiedGroupSource' - x-ms-navigationProperty: true - userSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.userSource' - description: Data source entity for a the legal hold. This is the container for a mailbox and OneDrive for Business site. - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.ediscovery.noncustodialDataSource: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceContainer' - - title: noncustodialDataSource - type: object - properties: - applyHoldToSource: - type: boolean - description: Indicates if hold is applied to non-custodial data source (such as mailbox or site). - nullable: true - dataSource: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - additionalProperties: - type: object - microsoft.graph.ediscovery.dataSource: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: dataSource - 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: The date and time the dataSource was created. - format: date-time - nullable: true - displayName: - type: string - description: The display name of the dataSource. This will be the name of the SharePoint site. - nullable: true - holdStatus: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceHoldStatus' - additionalProperties: - type: object - microsoft.graph.ediscovery.caseOperation: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: caseOperation - type: object - properties: - action: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseAction' - 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 and time the operation was completed. - 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 date and time the operation was created. - format: date-time - nullable: true - percentProgress: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: The progress of the operation. - format: int32 - nullable: true - resultInfo: - $ref: '#/components/schemas/microsoft.graph.resultInfo' - status: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperationStatus' - additionalProperties: - type: object - microsoft.graph.ediscovery.caseExportOperation: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' - - title: caseExportOperation - type: object - properties: - azureBlobContainer: - type: string - description: The name of the Azure storage location where the export will be stored. This only applies to exports stored in your own Azure storage location. - nullable: true - azureBlobToken: - type: string - description: The SAS token for the Azure storage location. This only applies to exports stored in your own Azure storage location. - nullable: true - description: - type: string - description: The description provided for the export. - nullable: true - exportOptions: - $ref: '#/components/schemas/microsoft.graph.ediscovery.exportOptions' - exportStructure: - $ref: '#/components/schemas/microsoft.graph.ediscovery.exportFileStructure' - outputFolderId: + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' type: string - nullable: true - outputName: + responses: + 2XX: + $ref: '#/components/responses/microsoft.graph.authoredNoteCollectionResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - privacy.subjectRightsRequest + summary: Create authoredNote + description: Create a new authoredNote object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/subjectrightsrequest-post-notes?view=graph-rest-1.0 + operationId: privacy.subjectRightsRequest_CreateNote + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.authoredNote' + required: true + responses: + 2XX: + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.authoredNote' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/notes/{authoredNote-id}': + get: + tags: + - privacy.subjectRightsRequest + summary: Get notes from privacy + description: List of notes associated with the request. + operationId: privacy.subjectRightsRequest_GetNote + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: authoredNote-id + in: path + description: The unique identifier of authoredNote + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: authoredNote + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - author + - content + - createdDateTime type: string - description: The name provided for the export. - nullable: true - reviewSet: - $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' - additionalProperties: - type: object - microsoft.graph.ediscovery.reviewSet: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: reviewSet - 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])$' + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' type: string - description: 'The datetime when the review set 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 - displayName: - type: string - description: The review set name. The name is unique with a maximum limit of 64 characters. - nullable: true - queries: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSetQuery' - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.ediscovery.sourceCollection: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: sourceCollection - type: object - properties: - contentQuery: - type: string - description: 'The query string in KQL (Keyword Query Language) query. For details, see Keyword queries and search conditions for Content Search and eDiscovery. You can refine searches by using fields paired with values; for example, subject:''Quarterly Financials'' AND Date>=06/01/2016 AND Date<=07/01/2016.' - 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 date and time the sourceCollection was created. - format: date-time - nullable: true - dataSourceScopes: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceScopes' - description: - type: string - description: The description of the sourceCollection. - nullable: true - displayName: - type: string - description: The display name of the sourceCollection. - 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 last date and time the sourceCollection was modified. - format: date-time - nullable: true - additionalSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - description: Adds an additional source to the sourceCollection. - x-ms-navigationProperty: true - addToReviewSetOperation: - $ref: '#/components/schemas/microsoft.graph.ediscovery.addToReviewSetOperation' - custodianSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - description: Custodian sources that are included in the sourceCollection. - x-ms-navigationProperty: true - lastEstimateStatisticsOperation: - $ref: '#/components/schemas/microsoft.graph.ediscovery.estimateStatisticsOperation' - noncustodialSources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.noncustodialDataSource' - description: noncustodialDataSource sources that are included in the sourceCollection - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.ediscovery.additionalDataOptions: - title: additionalDataOptions - enum: - - allVersions - - linkedFiles - - unknownFutureValue - type: string - microsoft.graph.ediscovery.exportOptions: - title: exportOptions - enum: - - originalFiles - - text - - pdfReplacement - - fileInfo - - tags - - unknownFutureValue - type: string - microsoft.graph.ediscovery.exportFileStructure: - title: exportFileStructure - enum: - - none - - directory - - pst - - unknownFutureValue - type: string - microsoft.graph.ediscovery.reviewSetQuery: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: reviewSetQuery - 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: 'The time and date when the query 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: The name of the query. - 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 the query was last modified. 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 - query: - type: string - description: 'The query string in KQL (Keyword Query Language) query. For details, see Document metadata fields in Advanced eDiscovery. This field maps directly to the keywords condition. You can refine searches by using fields listed in the searchable field name paired with values; for example, subject:''Quarterly Financials'' AND Date>=06/01/2016 AND Date<=07/01/2016.' - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.tag: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: tag - type: object - properties: - childSelectability: - $ref: '#/components/schemas/microsoft.graph.ediscovery.childSelectability' - createdBy: - $ref: '#/components/schemas/microsoft.graph.identitySet' - description: - type: string - description: The description for the tag. - nullable: true - displayName: - type: string - description: Display name of the tag. - 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 tag was last modified. - format: date-time - nullable: true - childTags: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' - description: Returns the tags that are a child of a tag. - x-ms-navigationProperty: true - parent: - $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' - additionalProperties: - type: object - microsoft.graph.ediscovery.caseSettings: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: caseSettings - type: object - properties: - ocr: - $ref: '#/components/schemas/microsoft.graph.ediscovery.ocrSettings' - redundancyDetection: - $ref: '#/components/schemas/microsoft.graph.ediscovery.redundancyDetectionSettings' - topicModeling: - $ref: '#/components/schemas/microsoft.graph.ediscovery.topicModelingSettings' - additionalProperties: - type: object - microsoft.graph.ediscovery.addToReviewSetOperation: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' - - title: addToReviewSetOperation - type: object - properties: - reviewSet: - $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' - sourceCollection: - $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' - additionalProperties: - type: object - microsoft.graph.ediscovery.estimateStatisticsOperation: - allOf: - - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' - - title: estimateStatisticsOperation - type: object - properties: - indexedItemCount: - type: integer - description: The estimated count of items for the sourceCollection that matched the content query. - format: int64 - nullable: true - indexedItemsSize: - type: integer - description: The estimated size of items for the sourceCollection that matched the content query. - format: int64 - nullable: true - mailboxCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: The number of mailboxes that had search hits. - format: int32 - nullable: true - siteCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: The number of mailboxes that had search hits. - format: int32 - nullable: true - unindexedItemCount: - type: integer - description: The estimated count of unindexed items for the collection. - format: int64 - nullable: true - unindexedItemsSize: - type: integer - description: The estimated size of unindexed items for the collection. - format: int64 - nullable: true - sourceCollection: - $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' - additionalProperties: - type: object - microsoft.graph.entity: - title: entity - type: object - properties: - id: - type: string - description: The unique identifier for an entity. Read-only. - 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.ediscovery.caseStatus: - title: caseStatus - enum: - - unknown - - active - - pendingDelete - - closing - - closed - - closedWithError - type: string - microsoft.graph.ediscovery.dataSourceContainer: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: dataSourceContainer - 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: Created date and time of the dataSourceContainer entity. - format: date-time - nullable: true - displayName: - type: string - description: Display name of the dataSourceContainer entity. - nullable: true - holdStatus: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceHoldStatus' - 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 modified date and time of the dataSourceContainer. - format: date-time - nullable: true - releasedDateTime: - 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 that the dataSourceContainer was released from the case. - format: date-time - nullable: true - status: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceContainerStatus' - lastIndexOperation: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseIndexOperation' - 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 - 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.deleted: - title: deleted - type: object - properties: - state: - type: string - description: Represents the state of the deleted item. - nullable: true - additionalProperties: - type: object - microsoft.graph.root: - title: root - type: object - additionalProperties: - type: object - microsoft.graph.siteSettings: - title: siteSettings - type: object - properties: - languageTag: - type: string - description: The language tag for the language used on this site. - nullable: true - timeZone: - type: string - description: Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC). - 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.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.informationProtection: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: informationProtection - type: object - properties: - bitlocker: - $ref: '#/components/schemas/microsoft.graph.bitlocker' - dataLossPreventionPolicies: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.dataLossPreventionPolicy' - x-ms-navigationProperty: true - sensitivityLabels: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.sensitivityLabel' - x-ms-navigationProperty: true - sensitivityPolicySettings: - $ref: '#/components/schemas/microsoft.graph.sensitivityPolicySettings' - policy: - $ref: '#/components/schemas/microsoft.graph.informationProtectionPolicy' - threatAssessmentRequests: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest' - x-ms-navigationProperty: true - 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 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 hubsites 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 cannot be modified unless this value is first set to false.' - nullable: true - sealed: - type: boolean - description: 'If true, the content type cannot 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.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' - activities: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.itemActivityOLD' - description: The list of recent activities that took place under this drive. - x-ms-navigationProperty: true - 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.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' - activities: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.itemActivityOLD' - description: The recent activities that took place within this list. - x-ms-navigationProperty: true - columns: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.columnDefinition' - x-ms-navigationProperty: true - contentTypes: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.contentType' - 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 for 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.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: A unique identifier for the result. - nullable: true - type: - type: string - description: Type of the operation. - nullable: true - additionalProperties: - type: object - microsoft.graph.sitePage: - allOf: - - $ref: '#/components/schemas/microsoft.graph.baseItem' - - title: sitePage - type: object - properties: - contentType: - $ref: '#/components/schemas/microsoft.graph.contentTypeInfo' - pageLayout: - $ref: '#/components/schemas/microsoft.graph.pageLayoutType' - promotionKind: - $ref: '#/components/schemas/microsoft.graph.pagePromotionType' - publishingState: - $ref: '#/components/schemas/microsoft.graph.publicationFacet' - reactions: - $ref: '#/components/schemas/microsoft.graph.reactionsFacet' - showComments: - type: boolean - description: Determines whether or not to show comments at the bottom of the page. - nullable: true - showRecommendedPages: - type: boolean - description: Determines whether or not to show recommended pages at the bottom of the page. - nullable: true - thumbnailWebUrl: - type: string - description: Url of the sitePage's thumbnail image - nullable: true - title: - type: string - description: Title of the sitePage. - nullable: true - titleArea: - $ref: '#/components/schemas/microsoft.graph.titleArea' - canvasLayout: - $ref: '#/components/schemas/microsoft.graph.canvasLayout' - webParts: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.webPart' - description: Collection of webparts on the SharePoint page - x-ms-navigationProperty: 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. - 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.ediscovery.sourceType: - title: sourceType - enum: - - mailbox - - site - type: string - 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.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.serviceProvisioningError: - title: serviceProvisioningError - 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 at which the error occurred. - format: date-time - nullable: true - isResolved: - type: boolean - description: Indicates whether the Error has been attended to. - nullable: true - serviceInstance: - type: string - description: 'Qualified service instance (e.g., ''SharePoint/Dublin'') that published the service error information.' - nullable: true - additionalProperties: - type: object - microsoft.graph.groupWritebackConfiguration: - allOf: - - $ref: '#/components/schemas/microsoft.graph.writebackConfiguration' - - title: groupWritebackConfiguration - type: object - properties: - onPremisesGroupType: - type: string - description: 'Indicates the target on-premise group type the cloud object will be written back as. Nullable. The possible values are: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Azure AD security groups can be written back as universalSecurityGroup. If isEnabled or the NewUnifiedGroupWritebackDefault group setting is true but this property is not explicitly configured: Microsoft 365 groups will be written back as universalDistributionGroup by defaultSecurity groups will be written back as universalSecurityGroup by default' - nullable: true - additionalProperties: - type: object - microsoft.graph.groupAccessType: - title: groupAccessType - enum: - - none - - private - - secret - - public - type: string - microsoft.graph.membershipRuleProcessingStatus: - title: membershipRuleProcessingStatus - type: object - properties: - errorMessage: - type: string - description: Detailed error message if dynamic group processing ran into an error. Optional. Read-only. - nullable: true - lastMembershipUpdated: - 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: Most recent date and time when membership of a dynamic group was updated. Optional. Read-only. - format: date-time - nullable: true - status: - $ref: '#/components/schemas/microsoft.graph.MembershipRuleProcessingStatusDetails' - additionalProperties: - type: object - microsoft.graph.appRoleAssignment: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - 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 - creationTimestamp: - 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.endpoint: - allOf: - - $ref: '#/components/schemas/microsoft.graph.directoryObject' - - title: endpoint - type: object - properties: - capability: - type: string - description: 'Describes the capability that is associated with this resource. (e.g. Messages, Conversations, etc.) Not nullable. Read-only.' - providerId: - type: string - description: Application id of the publishing underlying service. Not nullable. Read-only. - nullable: true - providerName: - type: string - description: Name of the publishing underlying service. Read-only. - nullable: true - providerResourceId: - type: string - description: 'For Microsoft 365 groups, this is set to a well-known name for the resource (e.g. Yammer.FeedURL etc.). Not nullable. Read-only.' - nullable: true - uri: - type: string - description: URL of the published resource. Not nullable. Read-only. - 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.directorySetting: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: directorySetting - type: object - properties: - displayName: - type: string - description: 'Display name of this group of settings, which comes from the associated template. Read-only.' - nullable: true - templateId: - type: string - description: Unique identifier for the template used to create this group of settings. 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 directorySettingTemplates 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.' - calendarGroupId: - type: string - description: 'The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.' - nullable: true - 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, through an Outlook client or the corresponding calendarPermission resource. Read-only.' - 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. Read-only.' - nullable: true - canViewPrivateItems: - type: boolean - description: 'true if the user can read calendar items that have been marked private, false otherwise. This property is set through an Outlook client or the corresponding calendarPermission resource. Read-only.' - 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.' - 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 - isShared: - type: boolean - description: 'true if the user has shared the calendar with other users, false otherwise. Since only the user who created the calendar can share it, isShared and isSharedWithMe cannot be true for the same user. This property is set when sharing is initiated in an Outlook client, and can be reset when the sharing is cancelled through the client or the corresponding calendarPermission resource. Read-only.' - nullable: true - isSharedWithMe: - type: boolean - description: 'true if the user has been shared this calendar, false otherwise. This property is always false for a calendar owner. This property is set when sharing is initiated in an Outlook client, and can be reset when the sharing is cancelled through the client or the corresponding calendarPermission resource. Read-only.' - 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 - cancelledOccurrences: - type: array - items: - type: string - nullable: true - description: 'Contains occurrenceId property values of cancelled instances in a recurring series, if the event is the series master. Instances in a recurring series that are cancelled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).' - 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 - 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' - occurrenceId: - type: string - nullable: true - 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' - uid: - type: string - nullable: true - 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' - exceptionOccurrences: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.event' - x-ms-navigationProperty: true - 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. Supports $filter (eq, ne, le, ge).' - format: date-time - preview: - type: string - description: A short summary from the body of the latest post in this conversation. - 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.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.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 - discoverySettings: - $ref: '#/components/schemas/microsoft.graph.teamDiscoverySettings' - 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 - isMembershipLimitedToOwners: - type: boolean - description: 'If set to true, the team is currently in the owner-only team membership state and not accessible by other team members, such as students.' - 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 - owners: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.user' - description: 'The list of this team''s owners. Currently, when creating a team using application permissions, exactly one owner must be specified. When using user delegated permissions, no owner can be specified (the current user is the owner). Owner must be specified as an object ID (GUID), not a UPN.' - x-ms-navigationProperty: true - permissionGrants: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' - description: A collection of permissions granted to apps to access the 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' - templateDefinition: - $ref: '#/components/schemas/microsoft.graph.teamTemplateDefinition' - schedule: - $ref: '#/components/schemas/microsoft.graph.schedule' - additionalProperties: - type: object - microsoft.graph.ediscovery.legalHoldStatus: - title: legalHoldStatus - enum: - - Pending - - Error - - Success - - UnknownFutureValue - type: string - microsoft.graph.ediscovery.dataSourceHoldStatus: - title: dataSourceHoldStatus - enum: - - notApplied - - applied - - applying - - removing - - partial - - unknownFutureValue - type: string - microsoft.graph.ediscovery.caseAction: - title: caseAction - enum: - - contentExport - - applyTags - - convertToPdf - - index - - estimateStatistics - - addToReviewSet - - holdUpdate - - unknownFutureValue - - purgeData - type: string - microsoft.graph.resultInfo: - title: resultInfo - type: object - properties: - code: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: The result code. - format: int32 - message: - type: string - description: The message. - nullable: true - subcode: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: The result sub-code. - format: int32 - additionalProperties: - type: object - microsoft.graph.ediscovery.caseOperationStatus: - title: caseOperationStatus - enum: - - notStarted - - submissionFailed - - running - - succeeded - - partiallySucceeded - - failed - type: string - microsoft.graph.ediscovery.dataSourceScopes: - title: dataSourceScopes - enum: - - none - - allTenantMailboxes - - allTenantSites - - allCaseCustodians - - allCaseNoncustodialDataSources - - unknownFutureValue - type: string - microsoft.graph.ediscovery.childSelectability: - title: childSelectability - enum: - - One - - Many - type: string - microsoft.graph.ediscovery.ocrSettings: - title: ocrSettings - type: object - properties: - isEnabled: - type: boolean - description: Indicates whether or not OCR is enabled for the case. - nullable: true - maxImageSize: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: Maximum image size that will be processed in KB). - format: int32 - nullable: true - timeout: - pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' - type: string - description: 'The timeout duration for the OCR engine. A longer timeout may increase success of OCR, but may add to the total processing time.' - format: duration - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.redundancyDetectionSettings: - title: redundancyDetectionSettings - type: object - properties: - isEnabled: - type: boolean - description: Indicates whether email threading and near duplicate detection are enabled. - nullable: true - maxWords: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: 'Specifies the maximum number of words used for email threading and near duplicate detection. To learn more, see Minimum/maximum number of words.' - format: int32 - nullable: true - minWords: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: 'Specifies the minimum number of words used for email threading and near duplicate detection. To learn more, see Minimum/maximum number of words.' - format: int32 - nullable: true - similarityThreshold: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: 'Specifies the similarity level for documents to be put in the same near duplicate set. To learn more, see Document and email similarity threshold.' - format: int32 - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.topicModelingSettings: - title: topicModelingSettings - type: object - properties: - dynamicallyAdjustTopicCount: - type: boolean - description: 'To learn more, see Adjust maximum number of themes dynamically.' - nullable: true - ignoreNumbers: - type: boolean - description: 'To learn more, see Include numbers in themes.' - nullable: true - isEnabled: - type: boolean - description: Indicates whether themes is enabled for the case. - nullable: true - topicCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: 'To learn more, see Maximum number of themes.' - format: int32 - 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.ediscovery.caseCollectionResponse: - title: Collection of case - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.case' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.custodianCollectionResponse: - title: Collection of custodian - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.custodian' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.siteSourceCollectionResponse: - title: Collection of siteSource - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.siteSource' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - ODataCountResponse: - type: integer - format: int32 - microsoft.graph.ediscovery.unifiedGroupSourceCollectionResponse: - title: Collection of unifiedGroupSource - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.unifiedGroupSource' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.userSourceCollectionResponse: - title: Collection of userSource - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.userSource' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.legalHoldCollectionResponse: - title: Collection of legalHold - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.legalHold' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.noncustodialDataSourceCollectionResponse: - title: Collection of noncustodialDataSource - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.noncustodialDataSource' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.caseOperationCollectionResponse: - title: Collection of caseOperation - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.caseExportOperationCollectionResponse: - title: Collection of caseExportOperation - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseExportOperation' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.reviewSetCollectionResponse: - title: Collection of reviewSet - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.reviewSetQueryCollectionResponse: - title: Collection of reviewSetQuery - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSetQuery' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.sourceCollectionCollectionResponse: - title: Collection of sourceCollection - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.dataSourceCollectionResponse: - title: Collection of dataSource - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.tagCollectionResponse: - title: Collection of tag - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' - '@odata.nextLink': - type: string - nullable: true - additionalProperties: - type: object - microsoft.graph.identity: - title: identity - type: object - properties: - displayName: - type: string - description: The display name of the identity. This property is read-only. - nullable: true - id: - type: string - description: The identifier of the identity. This property is read-only. - nullable: true - additionalProperties: - type: object - microsoft.graph.ediscovery.dataSourceContainerStatus: - title: dataSourceContainerStatus - enum: - - Active - - Released - - UnknownFutureValue - type: string - microsoft.graph.itemReference: - title: itemReference + responses: + 2XX: + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.authoredNote' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + patch: + tags: + - privacy.subjectRightsRequest + summary: Update the navigation property notes in privacy + operationId: privacy.subjectRightsRequest_UpdateNote + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: authoredNote-id + in: path + description: The unique identifier of authoredNote + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: authoredNote + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.authoredNote' + required: true + responses: + 2XX: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.authoredNote' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + delete: + tags: + - privacy.subjectRightsRequest + summary: Delete navigation property notes for privacy + operationId: privacy.subjectRightsRequest_DeleteNote + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: authoredNote-id + in: path + description: The unique identifier of authoredNote + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: authoredNote + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + 2XX: + description: Success + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/notes/$count': + get: + tags: + - privacy.subjectRightsRequest + summary: Get the number of the resource + operationId: privacy.subjectRightsRequest.note_GetCount + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + responses: + 2XX: + $ref: '#/components/responses/ODataCountResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + '/privacy/subjectRightsRequests/{subjectRightsRequest-id}/team': + get: + tags: + - privacy.subjectRightsRequest + summary: Get team from privacy + description: Information about the Microsoft Teams team that was created for the request. + operationId: privacy.subjectRightsRequest_GetTeam + parameters: + - name: subjectRightsRequest-id + in: path + description: The unique identifier of subjectRightsRequest + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: subjectRightsRequest + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - classification + - createdDateTime + - description + - discoverySettings + - displayName + - funSettings + - guestSettings + - internalId + - isArchived + - isMembershipLimitedToOwners + - memberSettings + - messagingSettings + - specialization + - summary + - tenantId + - visibility + - webUrl + - allChannels + - channels + - group + - incomingChannels + - installedApps + - members + - operations + - owners + - permissionGrants + - photo + - primaryChannel + - tags + - template + - templateDefinition + - schedule + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - allChannels + - channels + - group + - incomingChannels + - installedApps + - members + - operations + - owners + - permissionGrants + - photo + - primaryChannel + - tags + - template + - templateDefinition + - schedule + type: string + responses: + 2XX: + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.team' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' + x-ms-docs-operation-type: operation + /privacy/subjectRightsRequests/$count: + get: + tags: + - privacy.subjectRightsRequest + summary: Get the number of the resource + operationId: privacy.subjectRightsRequest_GetCount + parameters: + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + responses: + 2XX: + $ref: '#/components/responses/ODataCountResponse' + default: + $ref: '#/components/responses/error' + deprecated: true + x-ms-deprecation: + removalDate: '2025-03-20T00:00:00.0000000+00:00' + date: '2022-03-22T00:00:00.0000000+00:00' + version: 2022-02/PrivacyDeprecate + description: 'The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security.' +components: + schemas: + microsoft.graph.compliance: + title: compliance 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 + ediscovery: + $ref: '#/components/schemas/microsoft.graph.ediscovery.ediscoveryroot' additionalProperties: type: object - microsoft.graph.user: + microsoft.graph.ediscovery.ediscoveryroot: allOf: - - $ref: '#/components/schemas/microsoft.graph.directoryObject' - - title: user + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: ediscoveryroot type: object properties: - signInActivity: - $ref: '#/components/schemas/microsoft.graph.signInActivity' - accountEnabled: + cases: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.case' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.ediscovery.case: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: case + type: object + properties: + closedBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + closedDateTime: + 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 case was closed. 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 + 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 entity 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 + description: + type: string + description: The case description. + nullable: true + displayName: + type: string + description: The case name. + nullable: true + externalId: + type: string + description: The external case number for customer reference. + 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 latest date and time when the case was modified. 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 + status: + $ref: '#/components/schemas/microsoft.graph.ediscovery.caseStatus' + custodians: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.custodian' + description: Returns a list of case custodian objects for this case. Nullable. + x-ms-navigationProperty: true + legalHolds: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.legalHold' + description: Returns a list of case legalHold objects for this case. Nullable. + x-ms-navigationProperty: true + noncustodialDataSources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.noncustodialDataSource' + description: Returns a list of case noncustodialDataSource objects for this case. Nullable. + x-ms-navigationProperty: true + operations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' + description: Returns a list of case operation objects for this case. Nullable. + x-ms-navigationProperty: true + reviewSets: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' + description: Returns a list of reviewSet objects in the case. Read-only. Nullable. + x-ms-navigationProperty: true + settings: + $ref: '#/components/schemas/microsoft.graph.ediscovery.caseSettings' + sourceCollections: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' + description: Returns a list of sourceCollection objects associated with this case. + x-ms-navigationProperty: true + tags: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' + description: Returns a list of tag objects associated to this case. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.ediscovery.custodian: + allOf: + - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceContainer' + - title: custodian + type: object + properties: + acknowledgedDateTime: + 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 custodian acknowledged a hold notification. + format: date-time + nullable: true + applyHoldToSources: type: boolean - description: 'true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).' + description: Identifies whether a custodian's sources were placed on hold during creation. nullable: true - ageGroup: + email: 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. Supports $filter (eq, ne, not, and in).' - nullable: true - assignedLicenses: + description: Email address of the custodian. + siteSources: 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. Supports $filter (eq, not, /$count eq 0, /$count ne 0).' - assignedPlans: + $ref: '#/components/schemas/microsoft.graph.ediscovery.siteSource' + description: Data source entity for SharePoint sites associated with the custodian. + x-ms-navigationProperty: true + unifiedGroupSources: type: array items: - $ref: '#/components/schemas/microsoft.graph.assignedPlan' - description: The plans that are assigned to the user. Read-only. Not nullable.Supports $filter (eq and not). - authorizationInfo: - $ref: '#/components/schemas/microsoft.graph.authorizationInfo' - businessPhones: + $ref: '#/components/schemas/microsoft.graph.ediscovery.unifiedGroupSource' + description: Data source entity for groups associated with the custodian. + x-ms-navigationProperty: true + userSources: type: array items: - type: string - description: 'The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced from on-premises directory. Supports $filter (eq, not, ge, le, startsWith).' - city: - type: string - description: 'The city in which the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' - nullable: true - companyName: + $ref: '#/components/schemas/microsoft.graph.ediscovery.userSource' + description: Data source entity for a the custodian. This is the container for a custodian's mailbox and OneDrive for Business site. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.ediscovery.caseIndexOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' + - title: caseIndexOperation + type: object + additionalProperties: + type: object + microsoft.graph.ediscovery.siteSource: + allOf: + - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' + - title: siteSource + type: object + properties: + site: + $ref: '#/components/schemas/microsoft.graph.site' + additionalProperties: + type: object + microsoft.graph.site: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItem' + - title: site + type: object + properties: + deleted: + $ref: '#/components/schemas/microsoft.graph.deleted' + displayName: 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.Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + description: The full title for the site. Read-only. nullable: true - consentProvidedForMinor: + root: + $ref: '#/components/schemas/microsoft.graph.root' + settings: + $ref: '#/components/schemas/microsoft.graph.siteSettings' + sharepointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + siteCollection: + $ref: '#/components/schemas/microsoft.graph.siteCollection' + informationProtection: + $ref: '#/components/schemas/microsoft.graph.informationProtection' + 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' + description: The collection of column definitions available in the site that are referenced from the sites in the parent hierarchy of the current site. + 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 cannot 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 for the site. + x-ms-navigationProperty: true + pages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.sitePage' + description: The collection of pages in the SitePages list in this 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' + onenote: + $ref: '#/components/schemas/microsoft.graph.onenote' + additionalProperties: + type: object + microsoft.graph.ediscovery.unifiedGroupSource: + allOf: + - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' + - title: unifiedGroupSource + type: object + properties: + includedSources: + $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceType' + group: + $ref: '#/components/schemas/microsoft.graph.group' + 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: '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. Supports $filter (eq, ne, not, and in).' + 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 - country: + createdByAppId: type: string - description: 'The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + description: 'App ID of the app used to create the group. Can be null for some groups. Returned by default. Read-only. Supports $filter (eq, ne, not, in, 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: '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. Supports $filter (eq, ne, not , ge, le, in).' + 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 - 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.Supports $filter (eq, ne, not, and in).' - nullable: true - customSecurityAttributes: - $ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue' - department: + description: type: string - description: 'The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, not , ge, le, in, and eq on null values).' + description: 'An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.' nullable: true - deviceKeys: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.deviceKey' displayName: type: string - description: 'The name displayed in the address book for the user. This value is usually the combination of the user''s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters. 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. 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.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).' + description: 'The display name for the group. Required. 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 - employeeLeaveDateTime: + 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 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.' + 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 - employeeOrgData: - $ref: '#/components/schemas/microsoft.graph.employeeOrgData' - employeeType: - type: string - description: 'Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. 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. Supports $filter (eq, ne, not , in).' - nullable: true - externalUserStateChangeDateTime: - type: string - description: 'Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, not , in).' - nullable: true - faxNumber: - type: string - description: 'The fax number of the user. 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. 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. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.' - imAddresses: + groupTypes: 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. Supports $filter (eq, not, ge, le, startsWith).' + 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). Supports $filter (eq).' + nullable: true infoCatalogs: type: array items: type: string - description: 'Identifies the info segments assigned to the user. Supports $filter (eq, not, ge, le, startsWith).' - isLicenseReconciliationNeeded: + description: 'Identifies the info segments assigned to the group. Returned by default. Supports $filter (eq, not, ge, le, startsWith).' + isAssignableToRole: type: boolean - description: Indicates whether the user is pending an exchange mailbox license assignment. Read-only. Supports $filter (eq where true only). + description: 'Indicates whether this group can be assigned to an Azure Active Directory role. 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 isManagementRestricted: type: boolean - description: 'true if the user is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.' - nullable: true - 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. 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 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.' - 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.' + description: 'Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a group that''s a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.' 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. + licenseProcessingState: + $ref: '#/components/schemas/microsoft.graph.licenseProcessingState' mail: type: string - description: 'The SMTP address for the user, for example, admin@contoso.com. 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).' + description: 'The SMTP address for the group, for example, ''serviceadmins@contoso.onmicrosoft.com''. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + mailEnabled: + type: boolean + description: 'Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not, and eq on null values).' nullable: true - mobilePhone: + mailNickname: type: string - description: 'The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.' + 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. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith).' nullable: true - officeLocation: + membershipRule: type: string - description: 'The office location in the user''s place of business. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + 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 - onPremisesDistinguishedName: + membershipRuleProcessingState: 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. + 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 - 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.' - 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. Supports $filter (eq, ne, not, ge, le, in).' + description: 'Contains the on-premises domain FQDN, 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.Returned by default. Read-only.' 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. Supports $filter (eq, ne, not, ge, le, in).' + 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 + description: Contains the on-premises netBios 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. Read-only. + nullable: true onPremisesProvisioningErrors: type: array items: $ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError' - description: 'Errors when using Microsoft synchronization product during provisioning. Supports $filter (eq, not, ge, le).' + description: 'Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).' 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. Supports $filter (eq, ne, not, ge, le, in, startsWith).' + 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 user that was synchronized from on-premises to the cloud. Read-only. Supports $filter (eq including on null values). + 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 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. 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. 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: [''bob@contoso.com'', ''Robert@fabrikam.com''].NOTE: This property cannot contain accent characters.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. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).' + 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 - passwordProfile: - $ref: '#/components/schemas/microsoft.graph.passwordProfile' - postalCode: + organizationId: 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. 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.' + 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 the user. Should follow ISO 639-1 Code; for example en-US. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + 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 - provisionedPlans: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.provisionedPlan' - description: 'The plans that are provisioned for the user. Read-only. Not nullable. Supports $filter (eq, not, ge, le).' proxyAddresses: type: array items: type: string - description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. 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. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).' - refreshTokensValidFromDateTime: + description: 'Email addresses for the group that direct to the same group mailbox. For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. The any operator is required for 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: '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 invalidateAllRefreshTokens to reset.' + 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 + resourceBehaviorOptions: + type: array + items: + type: string + description: 'Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are AllowOnlyMembersToPost, HideGroupInOutlook, SubscribeNewGroupMembers, WelcomeEmailDisabled. For more information, see Set Microsoft 365 group behaviors and provisioning options.' + resourceProvisioningOptions: + type: array + items: + type: string + description: 'Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith.' + 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 (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).' + description: 'Security identifier of the group, used in Windows scenarios. Returned by default.' nullable: true serviceProvisioningErrors: type: array items: $ref: '#/components/schemas/microsoft.graph.serviceProvisioningError' - description: 'Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a user object . Supports $filter (eq, not, for isResolved and serviceInstance).' - 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.' - format: date-time - nullable: true - state: - type: string - description: 'The state or province in the user''s address. Maximum length is 128 characters. 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' - nullable: true - surname: + description: 'Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object . Supports $filter (eq, not, for isResolved and serviceInstance).' + theme: type: string - description: 'The user''s surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + 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 - usageLocation: + visibility: 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + 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 - 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.' + writebackConfiguration: + $ref: '#/components/schemas/microsoft.graph.groupWritebackConfiguration' + accessType: + $ref: '#/components/schemas/microsoft.graph.groupAccessType' + 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 - userType: - type: string - description: 'A String value that can be used to classify user types in your directory, such as Member and Guest. 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?' + 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 - 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 - print: - $ref: '#/components/schemas/microsoft.graph.userPrint' - aboutMe: - type: string - description: A freeform text entry field for the user to describe themselves. Returned only on $select. + hideFromAddressLists: + type: boolean + description: 'true if the group is not displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups; false otherwise. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' 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. + hideFromOutlookClients: + type: boolean + description: 'true if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' 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. + isFavorite: + type: boolean + 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 + unseenConversationsCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Count of conversations that have been delivered one or more new posts since the signed-in user's last visit to the group. This property is the same as unseenCount. Returned only on $select. + format: int32 + 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. This property is the same as unseenConversationsCount.Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + format: int32 + nullable: true + unseenMessagesCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Count of new posts that have been delivered to the group's conversations since the signed-in user's last visit to the group. Returned only on $select. + format: int32 + nullable: true + membershipRuleProcessingStatus: + $ref: '#/components/schemas/microsoft.graph.membershipRuleProcessingStatus' + 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 - 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. - analytics: - $ref: '#/components/schemas/microsoft.graph.userAnalytics' - cloudPCs: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.cloudPC' - x-ms-navigationProperty: true - usageRights: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.usageRight' - description: Represents the usage rights a user has been granted. - x-ms-navigationProperty: true - informationProtection: - $ref: '#/components/schemas/microsoft.graph.informationProtection' - appRoleAssignedResources: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.servicePrincipal' - x-ms-navigationProperty: true 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. + description: Represents the app roles a group has been granted for an application. Supports $expand. x-ms-navigationProperty: true - licenseDetails: + createdOnBehalfOf: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + endpoints: type: array items: - $ref: '#/components/schemas/microsoft.graph.licenseDetails' + $ref: '#/components/schemas/microsoft.graph.endpoint' + description: Endpoints for the group. Read-only. Nullable. x-ms-navigationProperty: true - manager: - $ref: '#/components/schemas/microsoft.graph.directoryObject' memberOf: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' - description: 'The groups, directory roles and administrative units that the user is a member of. Read-only. Nullable. Supports $expand.' + description: 'Groups and administrative units that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.' x-ms-navigationProperty: true - oauth2PermissionGrants: + members: type: array items: - $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant' + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'Direct 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 - ownedDevices: + membersWithLicenseErrors: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' - description: Devices that are owned by the user. Read-only. Nullable. Supports $expand. + description: A list of group members with license errors from this group-based license assignment. Read-only. x-ms-navigationProperty: true - ownedObjects: + owners: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' - description: 'Directory objects 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).' + description: 'The owners of the group who can be users or service principals. 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 - registeredDevices: + permissionGrants: type: array items: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - description: Devices that are registered for the user. Read-only. Nullable. Supports $expand. + $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' + description: The permissions that have been granted for a group to a specific application. Supports $expand. x-ms-navigationProperty: true - scopedRoleMemberOf: + settings: type: array items: - $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership' - description: The scoped-role administrative unit memberships for this user. Read-only. Nullable. + $ref: '#/components/schemas/microsoft.graph.directorySetting' + 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, including nested groups, and directory roles that a user is a member of. Nullable.' + description: 'The groups that a group is a member of, either directly and through nested membership. Nullable.' x-ms-navigationProperty: true - transitiveReports: + transitiveMembers: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' - description: The transitive reports for a user. Read-only. - 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. + description: The direct and transitive members of a group. Nullable. x-ms-navigationProperty: true - calendars: + acceptedSenders: type: array items: - $ref: '#/components/schemas/microsoft.graph.calendar' - description: The user's calendars. Read-only. Nullable. + $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. Nullable. - x-ms-navigationProperty: true - contactFolders: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.contactFolder' - description: The user's contacts folders. Read-only. Nullable. + description: The calendar view for the calendar. Read-only. x-ms-navigationProperty: true - contacts: + conversations: type: array items: - $ref: '#/components/schemas/microsoft.graph.contact' - description: The user's contacts. Read-only. Nullable. + $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 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' - joinedGroups: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.group' - x-ms-navigationProperty: true - mailFolders: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.mailFolder' - description: The user's mail folders. Read-only. Nullable. + description: The group's events. x-ms-navigationProperty: true - messages: + rejectedSenders: type: array items: - $ref: '#/components/schemas/microsoft.graph.message' - description: The messages in a mailbox or folder. Read-only. Nullable. + $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 - outlook: - $ref: '#/components/schemas/microsoft.graph.outlookUser' - people: + threads: type: array items: - $ref: '#/components/schemas/microsoft.graph.person' - description: 'Read-only. The most relevant people to the user. The collection is ordered by their relevance to the user, which is determined by the user''s communication, collaboration and business relationships. A person is an aggregation of information from across mail, contacts and social networks.' + $ref: '#/components/schemas/microsoft.graph.conversationThread' + description: The group's conversation threads. Nullable. x-ms-navigationProperty: true drive: $ref: '#/components/schemas/microsoft.graph.drive' @@ -12338,2472 +11965,3126 @@ components: 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. Supports $expand. Nullable. - x-ms-navigationProperty: true - appConsentRequestsForApproval: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.appConsentRequest' - x-ms-navigationProperty: true - approvals: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.approval' - x-ms-navigationProperty: true - pendingAccessReviewInstances: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.accessReviewInstance' - description: Navigation property to get list of access reviews pending approval by reviewer. - 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 - security: - $ref: '#/components/schemas/microsoft.graph.security.security' - deviceEnrollmentConfigurations: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration' - description: Get enrollment configurations targeted to the user - 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 - windowsInformationProtectionDeviceRegistrations: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.windowsInformationProtectionDeviceRegistration' - description: Zero or more WIP device 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 - mobileAppIntentAndStates: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.mobileAppIntentAndState' - description: The list of troubleshooting events for this user. - x-ms-navigationProperty: true - mobileAppTroubleshootingEvents: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.mobileAppTroubleshootingEvent' - description: The list of mobile app troubleshooting events for this user. - x-ms-navigationProperty: true - notifications: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.notification' - x-ms-navigationProperty: true - planner: - $ref: '#/components/schemas/microsoft.graph.plannerUser' - insights: - $ref: '#/components/schemas/microsoft.graph.itemInsights' - 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 - profile: - $ref: '#/components/schemas/microsoft.graph.profile' - activities: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.userActivity' - x-ms-navigationProperty: true - devices: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.device' + description: The group's drives. Read-only. x-ms-navigationProperty: true - onlineMeetings: + sites: type: array items: - $ref: '#/components/schemas/microsoft.graph.onlineMeeting' + $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 - presence: - $ref: '#/components/schemas/microsoft.graph.presence' - authentication: - $ref: '#/components/schemas/microsoft.graph.authentication' - chats: + extensions: type: array items: - $ref: '#/components/schemas/microsoft.graph.chat' + $ref: '#/components/schemas/microsoft.graph.extension' + description: The collection of open extensions defined for the group. Read-only. Nullable. x-ms-navigationProperty: true - joinedTeams: + groupLifecyclePolicies: type: array items: - $ref: '#/components/schemas/microsoft.graph.team' - description: The Microsoft Teams teams that the user is a member of. Read-only. Nullable. + $ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy' + description: The collection of lifecycle policies for this group. Read-only. Nullable. x-ms-navigationProperty: true - teamwork: - $ref: '#/components/schemas/microsoft.graph.userTeamwork' - todo: - $ref: '#/components/schemas/microsoft.graph.todo' - employeeExperience: - $ref: '#/components/schemas/microsoft.graph.employeeExperienceUser' - additionalProperties: - type: object - microsoft.graph.bitlocker: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: bitlocker - type: object - properties: - recoveryKeys: + 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.bitlockerRecoveryKey' - description: The recovery keys associated with the bitlocker entity. + $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.dataLossPreventionPolicy: + microsoft.graph.ediscovery.userSource: allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: dataLossPreventionPolicy + - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' + - title: userSource type: object properties: - name: + email: + type: string + description: Email address of the user's mailbox. + includedSources: + $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceType' + siteWebUrl: type: string + description: The URL of the user's OneDrive for Business site. Read-only. nullable: true additionalProperties: type: object - microsoft.graph.sensitivityLabel: + microsoft.graph.ediscovery.legalHold: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: sensitivityLabel + - title: legalHold type: object properties: - applicableTo: - $ref: '#/components/schemas/microsoft.graph.sensitivityLabelTarget' - applicationMode: - $ref: '#/components/schemas/microsoft.graph.applicationMode' - assignedPolicies: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.labelPolicy' - autoLabeling: - $ref: '#/components/schemas/microsoft.graph.autoLabeling' - description: + contentQuery: type: string + description: 'KQL query that specifies content to be held in the specified locations. To learn more, see Keyword queries and search conditions for Content Search and eDiscovery. To hold all content in the specified locations, leave contentQuery blank.' nullable: true - displayName: + 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 date and time the legal hold was created. + format: date-time nullable: true - isDefault: - type: boolean + description: + type: string + description: The legal hold description. nullable: true - isEndpointProtectionEnabled: - type: boolean + displayName: + type: string + description: The display name of the legal hold. nullable: true - labelActions: + errors: type: array items: - $ref: '#/components/schemas/microsoft.graph.labelActionBase' - name: - type: string - nullable: true - priority: - maximum: 2147483647 - minimum: -2147483648 - type: integer - format: int32 + type: string + nullable: true + description: Lists any errors that happened while placing the hold. + isEnabled: + type: boolean + description: Indicates whether the hold is enabled and actively holding content. nullable: true - toolTip: + 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 the legal hold was last modified. + format: date-time nullable: true - sublabels: + status: + $ref: '#/components/schemas/microsoft.graph.ediscovery.legalHoldStatus' + siteSources: type: array items: - $ref: '#/components/schemas/microsoft.graph.sensitivityLabel' + $ref: '#/components/schemas/microsoft.graph.ediscovery.siteSource' + description: Data source entity for SharePoint sites associated with the legal hold. + x-ms-navigationProperty: true + unifiedGroupSources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.unifiedGroupSource' + x-ms-navigationProperty: true + userSources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.userSource' + description: Data source entity for a the legal hold. This is the container for a mailbox and OneDrive for Business site. x-ms-navigationProperty: true additionalProperties: type: object - microsoft.graph.sensitivityPolicySettings: + microsoft.graph.ediscovery.noncustodialDataSource: allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: sensitivityPolicySettings + - $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceContainer' + - title: noncustodialDataSource type: object properties: - applicableTo: - $ref: '#/components/schemas/microsoft.graph.sensitivityLabelTarget' - downgradeSensitivityRequiresJustification: - type: boolean - nullable: true - helpWebUrl: - type: string - nullable: true - isMandatory: + applyHoldToSource: type: boolean + description: Indicates if hold is applied to non-custodial data source (such as mailbox or site). nullable: true + dataSource: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' additionalProperties: type: object - microsoft.graph.informationProtectionPolicy: + microsoft.graph.ediscovery.dataSource: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: informationProtectionPolicy + - title: dataSource type: object properties: - labels: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.informationProtectionLabel' - x-ms-navigationProperty: 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 date and time the dataSource was created. + format: date-time + nullable: true + displayName: + type: string + description: The display name of the dataSource. This will be the name of the SharePoint site. + nullable: true + holdStatus: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceHoldStatus' additionalProperties: type: object - microsoft.graph.threatAssessmentRequest: + microsoft.graph.ediscovery.caseOperation: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: threatAssessmentRequest + - title: caseOperation type: object properties: - category: - $ref: '#/components/schemas/microsoft.graph.threatCategory' - contentType: - $ref: '#/components/schemas/microsoft.graph.threatAssessmentContentType' + action: + $ref: '#/components/schemas/microsoft.graph.ediscovery.caseAction' + 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 and time the operation was completed. + 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 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.' + description: The date and time the operation was created. format: date-time nullable: true - expectedAssessment: - $ref: '#/components/schemas/microsoft.graph.threatExpectedAssessment' - requestSource: - $ref: '#/components/schemas/microsoft.graph.threatAssessmentRequestSource' + percentProgress: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The progress of the operation. + format: int32 + nullable: true + resultInfo: + $ref: '#/components/schemas/microsoft.graph.resultInfo' status: - $ref: '#/components/schemas/microsoft.graph.threatAssessmentStatus' - results: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.threatAssessmentResult' - description: 'A collection of threat assessment results. Read-only. By default, a GET /threatAssessmentRequests/{id} does not return this property unless you apply $expand on it.' - x-ms-navigationProperty: true + $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperationStatus' additionalProperties: type: object - microsoft.graph.itemActivityStat: + microsoft.graph.ediscovery.caseExportOperation: allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: itemActivityStat + - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' + - title: caseExportOperation 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])$' + azureBlobContainer: type: string - description: When the interval ends. Read-only. - format: date-time + description: The name of the Azure storage location where the export will be stored. This only applies to exports stored in your own Azure storage location. nullable: true - incompleteData: - $ref: '#/components/schemas/microsoft.graph.incompleteData' - isTrending: - type: boolean - description: Indicates whether the item is 'trending.' Read-only. + azureBlobToken: + type: string + description: The SAS token for the Azure storage location. This only applies to exports stored in your own Azure storage location. + nullable: true + description: + type: string + description: The description provided for the export. + nullable: true + exportOptions: + $ref: '#/components/schemas/microsoft.graph.ediscovery.exportOptions' + exportStructure: + $ref: '#/components/schemas/microsoft.graph.ediscovery.exportFileStructure' + outputFolderId: + type: string 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])$' + outputName: type: string - description: When the interval starts. Read-only. - format: date-time + description: The name provided for the export. 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 + reviewSet: + $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' 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 + microsoft.graph.ediscovery.reviewSet: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: reviewSet + 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: 'The datetime when the review set 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 + displayName: + type: string + description: The review set name. The name is unique with a maximum limit of 64 characters. + nullable: true + queries: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSetQuery' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.ediscovery.sourceCollection: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: sourceCollection + type: object + properties: + contentQuery: + type: string + description: 'The query string in KQL (Keyword Query Language) query. For details, see Keyword queries and search conditions for Content Search and eDiscovery. You can refine searches by using fields paired with values; for example, subject:''Quarterly Financials'' AND Date>=06/01/2016 AND Date<=07/01/2016.' + 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 date and time the sourceCollection was created. + format: date-time + nullable: true + dataSourceScopes: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceScopes' + description: + type: string + description: The description of the sourceCollection. + nullable: true + displayName: + type: string + description: The display name of the sourceCollection. + 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 last date and time the sourceCollection was modified. + format: date-time + nullable: true + additionalSources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' + description: Adds an additional source to the sourceCollection. + x-ms-navigationProperty: true + addToReviewSetOperation: + $ref: '#/components/schemas/microsoft.graph.ediscovery.addToReviewSetOperation' + custodianSources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSource' + description: Custodian sources that are included in the sourceCollection. + x-ms-navigationProperty: true + lastEstimateStatisticsOperation: + $ref: '#/components/schemas/microsoft.graph.ediscovery.estimateStatisticsOperation' + noncustodialSources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.noncustodialDataSource' + description: noncustodialDataSource sources that are included in the sourceCollection + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.ediscovery.additionalDataOptions: + title: additionalDataOptions enum: - - note + - allVersions + - linkedFiles + - unknownFutureValue + type: string + microsoft.graph.ediscovery.exportOptions: + title: exportOptions + enum: + - originalFiles - text - - choice - - multichoice - - number - - currency - - dateTime - - lookup - - boolean - - user - - url - - calculated - - location - - geolocation - - term - - multiterm - - thumbnail - - approvalStatus + - pdfReplacement + - fileInfo + - tags - 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: Indicates whether to add the name of the document set to each file name. - nullable: true - shouldPrefixNameToFile: - type: boolean - description: 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: + microsoft.graph.ediscovery.exportFileStructure: + title: exportFileStructure + enum: + - none + - directory + - pst + - unknownFutureValue + type: string + microsoft.graph.ediscovery.reviewSetQuery: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: reviewSetQuery + 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: 'The time and date when the query 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: The name of the query. + 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 the query was last modified. 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 + query: + type: string + description: 'The query string in KQL (Keyword Query Language) query. For details, see Document metadata fields in Advanced eDiscovery. This field maps directly to the keywords condition. You can refine searches by using fields listed in the searchable field name paired with values; for example, subject:''Quarterly Financials'' AND Date>=06/01/2016 AND Date<=07/01/2016.' + nullable: true + additionalProperties: + type: object + microsoft.graph.ediscovery.tag: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: tag + type: object + properties: + childSelectability: + $ref: '#/components/schemas/microsoft.graph.ediscovery.childSelectability' + createdBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + description: + type: string + description: The description for the tag. + nullable: true + displayName: + type: string + description: Display name of the tag. + 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 tag was last modified. + format: date-time + nullable: true + childTags: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' + description: Returns the tags that are a child of a tag. + x-ms-navigationProperty: true + parent: + $ref: '#/components/schemas/microsoft.graph.ediscovery.tag' + additionalProperties: + type: object + microsoft.graph.ediscovery.caseSettings: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: columnLink + - title: caseSettings type: object properties: - name: + ocr: + $ref: '#/components/schemas/microsoft.graph.ediscovery.ocrSettings' + redundancyDetection: + $ref: '#/components/schemas/microsoft.graph.ediscovery.redundancyDetectionSettings' + topicModeling: + $ref: '#/components/schemas/microsoft.graph.ediscovery.topicModelingSettings' + additionalProperties: + type: object + microsoft.graph.ediscovery.addToReviewSetOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' + - title: addToReviewSetOperation + type: object + properties: + reviewSet: + $ref: '#/components/schemas/microsoft.graph.ediscovery.reviewSet' + sourceCollection: + $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' + additionalProperties: + type: object + microsoft.graph.ediscovery.estimateStatisticsOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.ediscovery.caseOperation' + - title: estimateStatisticsOperation + type: object + properties: + indexedItemCount: + type: integer + description: The estimated count of items for the sourceCollection that matched the content query. + format: int64 + nullable: true + indexedItemsSize: + type: integer + description: The estimated size of items for the sourceCollection that matched the content query. + format: int64 + nullable: true + mailboxCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of mailboxes that had search hits. + format: int32 + nullable: true + siteCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of mailboxes that had search hits. + format: int32 + nullable: true + unindexedItemCount: + type: integer + description: The estimated count of unindexed items for the collection. + format: int64 + nullable: true + unindexedItemsSize: + type: integer + description: The estimated size of unindexed items for the collection. + format: int64 + nullable: true + sourceCollection: + $ref: '#/components/schemas/microsoft.graph.ediscovery.sourceCollection' + additionalProperties: + type: object + microsoft.graph.subjectRightsRequest: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: subjectRightsRequest + type: object + properties: + assignedTo: + $ref: '#/components/schemas/microsoft.graph.identity' + closedDateTime: + 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 request was closed. 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 + contentQuery: + type: string + description: KQL based content query that should be used for search. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. + 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 date and time when the request 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 + dataSubject: + $ref: '#/components/schemas/microsoft.graph.dataSubject' + dataSubjectType: + $ref: '#/components/schemas/microsoft.graph.dataSubjectType' + description: + type: string + description: Description for the request. + nullable: true + displayName: + type: string + description: The name of the request. + nullable: true + externalId: + type: string + description: The external ID for the request that is immutable after creation and is used for tracking the request for the external system. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. + nullable: true + history: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestHistory' + description: Collection of history change events. + includeAllVersions: + type: boolean + description: 'Include all versions of the documents. By default, the current copies of the documents will be returned. If SharePoint sites have versioning enabled, including all versions will include the historical copies of the documents. This property is defined only for APIs accessed using the /security query path and not the /privacy query path.' + nullable: true + includeAuthoredContent: + type: boolean + description: Include content authored by the data subject. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. + nullable: true + insight: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestDetail' + internalDueDateTime: + 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 request is internally 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 + 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 request was last modified. 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 + mailboxlocations: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestMailboxLocation' + pauseAfterEstimate: + type: boolean + description: 'Pause the request after estimate has finished. By default, the data estimate will run and then pause, allowing you to preview results and then select the option to retrieve data in the UI. You can set this property to false if you want it to perform the estimate and then automatically begin with the retrieval of the content. This property is defined only for APIs accessed using the /security query path and not the /privacy query path.' + nullable: true + regulations: + type: array + items: + type: string + nullable: true + description: List of regulations that this request will fulfill. + sitelocations: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestSiteLocation' + stages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestStageDetail' + description: Information about the different stages for the request. + status: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestStatus' + type: + $ref: '#/components/schemas/microsoft.graph.subjectRightsRequestType' + approvers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.user' + x-ms-navigationProperty: true + collaborators: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.user' + x-ms-navigationProperty: true + notes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.authoredNote' + description: List of notes associated with the request. + x-ms-navigationProperty: true + team: + $ref: '#/components/schemas/microsoft.graph.team' + 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. 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. 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. 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.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. Only one number can be set for this property. Read-only for users synced from on-premises directory. Supports $filter (eq, not, ge, le, startsWith).' + city: + type: string + description: 'The city in which the user is located. Maximum length is 128 characters. 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.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. 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. 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. 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.Supports $filter (eq, ne, not, and in).' + nullable: true + customSecurityAttributes: + $ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue' + department: + type: string + description: 'The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, not , ge, le, in, and eq on null values).' + nullable: true + deviceKeys: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.deviceKey' + displayName: + type: string + description: 'The name displayed in the address book for the user. This value is usually the combination of the user''s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters. 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. 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.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. Supports $filter (eq, ne, not , ge, le, in, startsWith).' + nullable: true + externalUserState: type: string - description: The name of the column in this content type. + 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. Supports $filter (eq, ne, not , in).' nullable: true - 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.systemFacet: - title: systemFacet - type: object - additionalProperties: - type: object - microsoft.graph.itemActivityOLD: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: itemActivityOLD - type: object - properties: - action: - $ref: '#/components/schemas/microsoft.graph.itemActionSet' - actor: - $ref: '#/components/schemas/microsoft.graph.identitySet' - times: - $ref: '#/components/schemas/microsoft.graph.itemActivityTimeSet' - driveItem: - $ref: '#/components/schemas/microsoft.graph.driveItem' - listItem: - $ref: '#/components/schemas/microsoft.graph.listItem' - 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: + externalUserStateChangeDateTime: + type: string + description: 'Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, not , in).' + nullable: true + faxNumber: + type: string + description: 'The fax number of the user. 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. 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. 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. Supports $filter (eq, not, ge, le, startsWith).' + infoCatalogs: + type: array + items: + type: string + description: 'Identifies the info segments assigned to the user. Supports $filter (eq, not, ge, le, startsWith).' + isLicenseReconciliationNeeded: + type: boolean + description: Indicates whether the user is pending an exchange mailbox license assignment. Read-only. Supports $filter (eq where true only). + nullable: true + isManagementRestricted: + type: boolean + description: 'true if the user is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a user who is a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.' + nullable: true + 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. 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 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.' + 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, admin@contoso.com. 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. 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. 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.' + nullable: true + officeLocation: + type: string + description: 'The office location in the user''s place of business. Maximum length is 128 characters. 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. + 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.' + 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. 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. 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. 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. 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. 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. 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. 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: [''bob@contoso.com'', ''Robert@fabrikam.com''].NOTE: This property cannot contain accent characters.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. 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. 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. 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. Supports $filter (eq, not, ge, le).' + proxyAddresses: + type: array + items: + type: string + description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. 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. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).' + refreshTokensValidFromDateTime: + 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 invalidateAllRefreshTokens to reset.' + format: date-time + nullable: true + 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 + serviceProvisioningErrors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.serviceProvisioningError' + description: 'Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a user object . Supports $filter (eq, not, for isResolved and serviceInstance).' + 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.' + format: date-time + nullable: true + state: + type: string + description: 'The state or province in the user''s address. Maximum length is 128 characters. 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. 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + usageLocation: type: string - description: 'The content stream, if the item represents a file.' - format: base64url + 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' nullable: true - cTag: + userPrincipalName: 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. + 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. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.' 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' - media: - $ref: '#/components/schemas/microsoft.graph.media' - package: - $ref: '#/components/schemas/microsoft.graph.package' - pendingOperations: - $ref: '#/components/schemas/microsoft.graph.pendingOperations' + userType: + type: string + description: 'A String value that can be used to classify user types in your directory, such as Member and Guest. 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 + print: + $ref: '#/components/schemas/microsoft.graph.userPrint' + 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. + analytics: + $ref: '#/components/schemas/microsoft.graph.userAnalytics' + cloudPCs: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.cloudPC' + x-ms-navigationProperty: true + usageRights: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.usageRight' + description: Represents the usage rights a user has been granted. + x-ms-navigationProperty: true + informationProtection: + $ref: '#/components/schemas/microsoft.graph.informationProtection' + appRoleAssignedResources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.servicePrincipal' + x-ms-navigationProperty: true + 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' + x-ms-navigationProperty: true + manager: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + memberOf: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'The groups, directory roles and administrative units 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. + 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 and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).' + 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' + description: The scoped-role administrative unit memberships for this user. Read-only. Nullable. + x-ms-navigationProperty: true + sponsors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + 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 + transitiveReports: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: The transitive reports for a user. Read-only. + 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' + joinedGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.group' + x-ms-navigationProperty: true + 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: 'Read-only. The most relevant people to the user. The collection is ordered by their relevance to the user, which is determined by the user''s communication, collaboration and business relationships. A person is an aggregation of information from across mail, contacts and social networks.' + 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. Supports $expand. Nullable. + x-ms-navigationProperty: true + appConsentRequestsForApproval: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.appConsentRequest' + x-ms-navigationProperty: true + approvals: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.approval' + x-ms-navigationProperty: true + pendingAccessReviewInstances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstance' + description: Navigation property to get list of access reviews pending approval by reviewer. + 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 + security: + $ref: '#/components/schemas/microsoft.graph.security.security' + deviceEnrollmentConfigurations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration' + description: Get enrollment configurations targeted to the user + 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 + windowsInformationProtectionDeviceRegistrations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.windowsInformationProtectionDeviceRegistration' + description: Zero or more WIP device 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 + mobileAppIntentAndStates: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.mobileAppIntentAndState' + description: The list of troubleshooting events for this user. + x-ms-navigationProperty: true + mobileAppTroubleshootingEvents: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.mobileAppTroubleshootingEvent' + description: The list of mobile app troubleshooting events for this user. + x-ms-navigationProperty: true + notifications: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.notification' + x-ms-navigationProperty: true + planner: + $ref: '#/components/schemas/microsoft.graph.plannerUser' + insights: + $ref: '#/components/schemas/microsoft.graph.itemInsights' + settings: + $ref: '#/components/schemas/microsoft.graph.userSettings' + onenote: + $ref: '#/components/schemas/microsoft.graph.onenote' 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 - source: - $ref: '#/components/schemas/microsoft.graph.driveItemSource' - 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' + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + photos: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + x-ms-navigationProperty: true + profile: + $ref: '#/components/schemas/microsoft.graph.profile' activities: type: array items: - $ref: '#/components/schemas/microsoft.graph.itemActivityOLD' - description: The list of recent activities that took place on this item. + $ref: '#/components/schemas/microsoft.graph.userActivity' + description: The user's activities across devices. Read-only. Nullable. x-ms-navigationProperty: true - analytics: - $ref: '#/components/schemas/microsoft.graph.itemAnalytics' - children: + devices: 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. + $ref: '#/components/schemas/microsoft.graph.device' x-ms-navigationProperty: true - listItem: - $ref: '#/components/schemas/microsoft.graph.listItem' - permissions: + onlineMeetings: type: array items: - $ref: '#/components/schemas/microsoft.graph.permission' - description: The set of permissions for the item. Read-only. Nullable. + $ref: '#/components/schemas/microsoft.graph.onlineMeeting' + description: 'Information about a meeting, including the URL used to join a meeting, the attendees'' list, and the description.' x-ms-navigationProperty: true - retentionLabel: - $ref: '#/components/schemas/microsoft.graph.itemRetentionLabel' - subscriptions: + presence: + $ref: '#/components/schemas/microsoft.graph.presence' + authentication: + $ref: '#/components/schemas/microsoft.graph.authentication' + chats: 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. + $ref: '#/components/schemas/microsoft.graph.chat' x-ms-navigationProperty: true - thumbnails: + joinedTeams: 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.' + $ref: '#/components/schemas/microsoft.graph.team' + description: The Microsoft Teams teams that the user is a member of. Read-only. Nullable. x-ms-navigationProperty: true - versions: + permissionGrants: 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.' + $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' x-ms-navigationProperty: true + teamwork: + $ref: '#/components/schemas/microsoft.graph.userTeamwork' + todo: + $ref: '#/components/schemas/microsoft.graph.todo' + employeeExperience: + $ref: '#/components/schemas/microsoft.graph.employeeExperienceUser' additionalProperties: type: object - microsoft.graph.listInfo: - title: listInfo + microsoft.graph.mailboxSettings: + title: mailboxSettings type: object properties: - contentTypesEnabled: - type: boolean - description: 'If true, indicates that content types are enabled for this list.' + archiveFolder: + type: string + description: Folder ID of an archive folder for the user. Read-only. nullable: true - hidden: - type: boolean - description: 'If true, indicates that the list is not normally visible in the SharePoint user experience.' + automaticRepliesSetting: + $ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting' + dateFormat: + type: string + description: The date format for the user's mailbox. nullable: true - template: + delegateMeetingMessageDeliveryOptions: + $ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions' + language: + $ref: '#/components/schemas/microsoft.graph.localeInfo' + timeFormat: 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.' + 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' + userPurposeV2: + $ref: '#/components/schemas/microsoft.graph.mailboxRecipientType' + workingHours: + $ref: '#/components/schemas/microsoft.graph.workingHours' additionalProperties: type: object - microsoft.graph.listItem: + microsoft.graph.authoredNote: allOf: - - $ref: '#/components/schemas/microsoft.graph.baseItem' - - title: listItem + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: authoredNote type: object properties: - contentType: - $ref: '#/components/schemas/microsoft.graph.contentTypeInfo' - deleted: - $ref: '#/components/schemas/microsoft.graph.deleted' - sharepointIds: - $ref: '#/components/schemas/microsoft.graph.sharepointIds' - activities: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.itemActivityOLD' - description: The list of recent activities that took place on this item. - x-ms-navigationProperty: true - 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 + author: + $ref: '#/components/schemas/microsoft.graph.identity' + content: + $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: 'The date and time when the entity 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 additionalProperties: type: object - microsoft.graph.subscription: + microsoft.graph.team: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: subscription + - title: team 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 255 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: + classification: type: string - description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when includeResourceData is true. + 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 - expirationDateTime: + 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: '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.' + description: Timestamp at which the team was created. 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 - notificationContentType: + description: type: string - description: Optional. Desired content-type for Microsoft Graph change notifications for supported resource types. The default content-type is application/json. + description: 'An optional description for the team. Maximum length: 1024 characters.' nullable: true - notificationQueryOptions: + discoverySettings: + $ref: '#/components/schemas/microsoft.graph.teamDiscoverySettings' + displayName: type: string - description: 'Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the 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.' + description: The name of the team. nullable: true - notificationUrl: - type: string - description: Required. The URL of the endpoint that receives 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: + funSettings: + $ref: '#/components/schemas/microsoft.graph.teamFunSettings' + guestSettings: + $ref: '#/components/schemas/microsoft.graph.teamGuestSettings' + internalId: 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. + 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 - resource: - type: string - description: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/beta/). See the possible resource path values for each supported resource. - 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 + isArchived: + type: boolean + description: Whether this team is in read-only mode. 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 + isMembershipLimitedToOwners: + type: boolean + description: 'If set to true, the team is currently in the owner-only team membership state and not accessible by other team members, such as students.' nullable: true - resourceLocation: + 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: URI of the resource that the operation is performed on. + description: The ID of the Azure Active Directory tenant. nullable: true - status: - $ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus' - statusDetail: + visibility: + $ref: '#/components/schemas/microsoft.graph.teamVisibilityType' + webUrl: type: string - description: Details about the status of the operation. + 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 - 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.pageLayoutType: - title: pageLayoutType - enum: - - microsoftReserved - - article - - home - - unknownFutureValue - type: string - microsoft.graph.pagePromotionType: - title: pagePromotionType - enum: - - microsoftReserved - - page - - newsPost - - unknownFutureValue - type: string - 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.reactionsFacet: - title: reactionsFacet - type: object - properties: - commentCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: Count of comments. - format: int32 - nullable: true - likeCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: Count of likes. - format: int32 - nullable: true - shareCount: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: Count of shares. - format: int32 - 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 + owners: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.user' + description: 'The list of this team''s owners. Currently, when creating a team using application permissions, exactly one owner must be specified. When using user delegated permissions, no owner can be specified (the current user is the owner). Owner must be specified as an object ID (GUID), not a UPN.' + x-ms-navigationProperty: true + permissionGrants: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' + description: A collection of permissions granted to apps to access the 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' + templateDefinition: + $ref: '#/components/schemas/microsoft.graph.teamTemplateDefinition' + schedule: + $ref: '#/components/schemas/microsoft.graph.schedule' + additionalProperties: + type: object + microsoft.graph.entity: + title: entity + type: object + properties: + id: + type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object - microsoft.graph.titleArea: - title: titleArea + microsoft.graph.identitySet: + title: identitySet type: object properties: - alternativeText: - type: string - description: Alternative text on the title area. - nullable: true - enableGradientEffect: - type: boolean - description: Indicates whether the title area has a gradient effect enabled. - nullable: true - imageWebUrl: - type: string - description: URL of the image in the title area. - nullable: true - layout: - $ref: '#/components/schemas/microsoft.graph.titleAreaLayoutType' - serverProcessedContent: - $ref: '#/components/schemas/microsoft.graph.serverProcessedContent' - showAuthor: - type: boolean - description: Indicates whether the author should be shown in title area. - nullable: true - showPublishedDate: - type: boolean - description: Indicates whether the published date should be shown in title area. - nullable: true - showTextBlockAboveTitle: - type: boolean - description: Indicates whether the text block above title should be shown in title area. - nullable: true - textAboveTitle: - type: string - description: The text above title line. - nullable: true - textAlignment: - $ref: '#/components/schemas/microsoft.graph.titleAreaTextAlignmentType' + 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.canvasLayout: + microsoft.graph.ediscovery.caseStatus: + title: caseStatus + enum: + - unknown + - active + - pendingDelete + - closing + - closed + - closedWithError + type: string + microsoft.graph.ediscovery.dataSourceContainer: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: canvasLayout + - title: dataSourceContainer type: object properties: - horizontalSections: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.horizontalSection' - description: Collection of horizontal sections on the SharePoint page. - x-ms-navigationProperty: true - verticalSection: - $ref: '#/components/schemas/microsoft.graph.verticalSection' + 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: Created date and time of the dataSourceContainer entity. + format: date-time + nullable: true + displayName: + type: string + description: Display name of the dataSourceContainer entity. + nullable: true + holdStatus: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceHoldStatus' + 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 modified date and time of the dataSourceContainer. + format: date-time + nullable: true + releasedDateTime: + 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 that the dataSourceContainer was released from the case. + format: date-time + nullable: true + status: + $ref: '#/components/schemas/microsoft.graph.ediscovery.dataSourceContainerStatus' + lastIndexOperation: + $ref: '#/components/schemas/microsoft.graph.ediscovery.caseIndexOperation' additionalProperties: type: object - microsoft.graph.webPart: + microsoft.graph.baseItem: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - - title: webPart - type: object - additionalProperties: - type: object - microsoft.graph.sharePointIdentitySet: - allOf: - - $ref: '#/components/schemas/microsoft.graph.identitySet' - - title: sharePointIdentitySet + - title: baseItem type: object properties: - group: - $ref: '#/components/schemas/microsoft.graph.identity' - siteGroup: - $ref: '#/components/schemas/microsoft.graph.sharePointIdentity' - siteUser: - $ref: '#/components/schemas/microsoft.graph.sharePointIdentity' + 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 + 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.sharingInvitation: - title: sharingInvitation + microsoft.graph.deleted: + title: deleted 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: + state: 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. + description: Represents the state of the deleted item. nullable: true additionalProperties: type: object - microsoft.graph.sharingLink: - title: sharingLink + microsoft.graph.root: + title: root + type: object + additionalProperties: + type: object + microsoft.graph.siteSettings: + title: siteSettings type: object properties: - application: - $ref: '#/components/schemas/microsoft.graph.identity' - configuratorUrl: + languageTag: type: string + description: The language tag for the language used on this site. nullable: true - 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.' + timeZone: + type: string + description: Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC). nullable: true - scope: + additionalProperties: + type: object + microsoft.graph.sharepointIds: + title: sharepointIds + type: object + properties: + listId: 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.' + description: The unique identifier (guid) for the item's list in SharePoint. nullable: true - type: + listItemId: type: string - description: The type of the link created. + description: An integer identifier for the item within the containing list. nullable: true - webHtml: + listItemUniqueId: type: string - description: 'For embed links, this property contains the HTML code for an