From a076ed2e986fb8015a28ea4c13dcf4fcbeeda3a1 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Tue, 4 Oct 2022 16:40:48 +0000 Subject: [PATCH] Weekly OpenApiDocs Download. [run ci] --- openApiDocs/beta/Applications.yml | 37 +- openApiDocs/beta/Bookings.yml | 1 + openApiDocs/beta/Calendar.yml | 1 + openApiDocs/beta/ChangeNotifications.yml | 1 + openApiDocs/beta/CloudCommunications.yml | 2 + openApiDocs/beta/Compliance.yml | 6 +- openApiDocs/beta/CrossDeviceExperiences.yml | 1 + openApiDocs/beta/DeviceManagement.Actions.yml | 675 +- .../beta/DeviceManagement.Administration.yml | 397 + .../beta/DeviceManagement.Enrolment.yml | 1 + .../beta/DeviceManagement.Functions.yml | 99 +- openApiDocs/beta/DeviceManagement.yml | 1538 +- openApiDocs/beta/Devices.CloudPrint.yml | 12 +- .../beta/Devices.CorporateManagement.yml | 55 +- .../beta/Devices.ServiceAnnouncement.yml | 1 + openApiDocs/beta/DirectoryObjects.yml | 1 + openApiDocs/beta/Education.yml | 6 +- openApiDocs/beta/Files.yml | 6 +- openApiDocs/beta/Financials.yml | 1 + openApiDocs/beta/Groups.yml | 6 +- .../beta/Identity.DirectoryManagement.yml | 17 +- openApiDocs/beta/Identity.Governance.yml | 32 +- openApiDocs/beta/Identity.SignIns.yml | 275 +- openApiDocs/beta/Mail.yml | 1 + openApiDocs/beta/ManagedTenants.yml | 17 +- openApiDocs/beta/Notes.yml | 1 + openApiDocs/beta/People.yml | 2 + openApiDocs/beta/PersonalContacts.yml | 1 + openApiDocs/beta/Planner.yml | 2 + openApiDocs/beta/Reports.yml | 9 +- openApiDocs/beta/SchemaExtensions.yml | 1 + openApiDocs/beta/Search.yml | 19 + openApiDocs/beta/Security.yml | 34 +- openApiDocs/beta/Sites.yml | 6 +- openApiDocs/beta/Teams.yml | 6 +- openApiDocs/beta/Users.Actions.yml | 36 +- openApiDocs/beta/Users.Functions.yml | 6 +- openApiDocs/beta/Users.yml | 6 +- openApiDocs/beta/WindowsUpdates.yml | 1 + openApiDocs/v1.0/Applications.yml | 3 +- openApiDocs/v1.0/Bookings.yml | 1 + openApiDocs/v1.0/Calendar.yml | 1 + openApiDocs/v1.0/ChangeNotifications.yml | 1 + openApiDocs/v1.0/CloudCommunications.yml | 16 +- openApiDocs/v1.0/CrossDeviceExperiences.yml | 1 + openApiDocs/v1.0/DeviceManagement.Actions.yml | 1 + .../v1.0/DeviceManagement.Administration.yml | 1 + .../v1.0/DeviceManagement.Enrolment.yml | 1 + openApiDocs/v1.0/DeviceManagement.yml | 1 + openApiDocs/v1.0/Devices.CloudPrint.yml | 3 +- .../v1.0/Devices.CorporateManagement.yml | 1 + .../v1.0/Devices.ServiceAnnouncement.yml | 1 + openApiDocs/v1.0/DirectoryObjects.yml | 1 + openApiDocs/v1.0/Education.yml | 3 +- openApiDocs/v1.0/Files.yml | 3 +- openApiDocs/v1.0/Groups.yml | 3 +- .../v1.0/Identity.DirectoryManagement.yml | 1 + openApiDocs/v1.0/Identity.Governance.yml | 23374 ++++++++++++---- openApiDocs/v1.0/Identity.SignIns.yml | 251 +- openApiDocs/v1.0/Mail.yml | 1 + openApiDocs/v1.0/Notes.yml | 1 + openApiDocs/v1.0/People.yml | 1 + openApiDocs/v1.0/PersonalContacts.yml | 1 + openApiDocs/v1.0/Planner.yml | 1 + openApiDocs/v1.0/Reports.yml | 309 + openApiDocs/v1.0/SchemaExtensions.yml | 1 + openApiDocs/v1.0/Search.yml | 1 + openApiDocs/v1.0/Security.yml | 1442 +- openApiDocs/v1.0/Sites.yml | 3 +- openApiDocs/v1.0/Teams.yml | 3 +- openApiDocs/v1.0/Users.Actions.yml | 3 +- openApiDocs/v1.0/Users.Functions.yml | 3 +- openApiDocs/v1.0/Users.yml | 3 +- .../crawl-log-v1.0-beta.json | 44 + .../definitions/v1.0-beta.md | 13 + .../crawl-log-v1.0-beta.json | 12 + .../definitions/v1.0-beta.md | 3 + .../crawl-log-v1.0-beta.json | 12 + .../definitions/v1.0-beta.md | 3 + .../DeviceManagement/crawl-log-v1.0-beta.json | 16 + .../DeviceManagement/definitions/v1.0-beta.md | 4 + .../Identity.Governance/crawl-log-v1.0.json | 72 + .../Identity.Governance/definitions/v1.0.md | 27 + .../Identity.SignIns/crawl-log-v1.0-beta.json | 8 + profiles/Identity.SignIns/crawl-log-v1.0.json | 8 + .../Identity.SignIns/definitions/v1.0-beta.md | 2 + profiles/Identity.SignIns/definitions/v1.0.md | 2 + profiles/Reports/crawl-log-v1.0.json | 16 + profiles/Reports/definitions/v1.0.md | 4 + profiles/Security/crawl-log-v1.0.json | 28 + profiles/Security/definitions/v1.0.md | 7 + .../Users.Actions/crawl-log-v1.0-beta.json | 4 + .../Users.Actions/definitions/v1.0-beta.md | 1 + .../Microsoft.Graph.Authentication.psd1 | 2 +- 94 files changed, 23903 insertions(+), 5145 deletions(-) diff --git a/openApiDocs/beta/Applications.yml b/openApiDocs/beta/Applications.yml index 51bdd970421..7d7b2161c10 100644 --- a/openApiDocs/beta/Applications.yml +++ b/openApiDocs/beta/Applications.yml @@ -98,6 +98,8 @@ paths: - samlMetadataUrl desc - serviceManagementReference - serviceManagementReference desc + - servicePrincipalLockConfiguration + - servicePrincipalLockConfiguration desc - signInAudience - signInAudience desc - spa @@ -155,6 +157,7 @@ paths: - requiredResourceAccess - samlMetadataUrl - serviceManagementReference + - servicePrincipalLockConfiguration - signInAudience - spa - tags @@ -289,6 +292,7 @@ paths: - requiredResourceAccess - samlMetadataUrl - serviceManagementReference + - servicePrincipalLockConfiguration - signInAudience - spa - tags @@ -5128,6 +5132,7 @@ paths: - requiredResourceAccess - samlMetadataUrl - serviceManagementReference + - servicePrincipalLockConfiguration - signInAudience - spa - tags @@ -5214,6 +5219,8 @@ paths: - samlMetadataUrl desc - serviceManagementReference - serviceManagementReference desc + - servicePrincipalLockConfiguration + - servicePrincipalLockConfiguration desc - signInAudience - signInAudience desc - spa @@ -8406,6 +8413,8 @@ paths: - samlMetadataUrl desc - serviceManagementReference - serviceManagementReference desc + - servicePrincipalLockConfiguration + - servicePrincipalLockConfiguration desc - signInAudience - signInAudience desc - spa @@ -8463,6 +8472,7 @@ paths: - requiredResourceAccess - samlMetadataUrl - serviceManagementReference + - servicePrincipalLockConfiguration - signInAudience - spa - tags @@ -8583,6 +8593,7 @@ paths: - requiredResourceAccess - samlMetadataUrl - serviceManagementReference + - servicePrincipalLockConfiguration - signInAudience - spa - tags @@ -17407,6 +17418,8 @@ components: type: string description: References application or service contact information from a Service or Asset Management database. Nullable. nullable: true + servicePrincipalLockConfiguration: + $ref: '#/components/schemas/microsoft.graph.servicePrincipalLockConfiguration' signInAudience: type: string description: 'Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount. See more in the table below. Supports $filter (eq, ne, not).' @@ -18340,6 +18353,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -18675,7 +18689,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -18900,6 +18914,26 @@ components: description: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. additionalProperties: type: object + microsoft.graph.servicePrincipalLockConfiguration: + title: servicePrincipalLockConfiguration + type: object + properties: + allProperties: + type: boolean + nullable: true + credentialsWithUsageSign: + type: boolean + nullable: true + credentialsWithUsageVerify: + type: boolean + nullable: true + isEnabled: + type: boolean + tokenEncryptionKeyId: + type: boolean + nullable: true + additionalProperties: + type: object microsoft.graph.spaApplication: title: spaApplication type: object @@ -19057,6 +19091,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.connectorGroupType: diff --git a/openApiDocs/beta/Bookings.yml b/openApiDocs/beta/Bookings.yml index f78a3f8387d..feb200778a2 100644 --- a/openApiDocs/beta/Bookings.yml +++ b/openApiDocs/beta/Bookings.yml @@ -3155,6 +3155,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.location: diff --git a/openApiDocs/beta/Calendar.yml b/openApiDocs/beta/Calendar.yml index 639f1e9691a..c725dbdf4f4 100644 --- a/openApiDocs/beta/Calendar.yml +++ b/openApiDocs/beta/Calendar.yml @@ -114570,6 +114570,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.onlineMeetingProviderType: diff --git a/openApiDocs/beta/ChangeNotifications.yml b/openApiDocs/beta/ChangeNotifications.yml index 5c1875eb948..f7df21a0707 100644 --- a/openApiDocs/beta/ChangeNotifications.yml +++ b/openApiDocs/beta/ChangeNotifications.yml @@ -295,6 +295,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.subscriptionCollectionResponse: diff --git a/openApiDocs/beta/CloudCommunications.yml b/openApiDocs/beta/CloudCommunications.yml index 2ae635fbac8..157b803c48f 100644 --- a/openApiDocs/beta/CloudCommunications.yml +++ b/openApiDocs/beta/CloudCommunications.yml @@ -9532,6 +9532,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.callRecords.modality: @@ -9613,6 +9614,7 @@ components: properties: hideBotAfterEscalation: type: boolean + description: Indicates whether to hide the app after the call is escalated. nullable: true isContentSharingNotificationEnabled: type: boolean diff --git a/openApiDocs/beta/Compliance.yml b/openApiDocs/beta/Compliance.yml index 11c7ffe292d..c91e3e97e47 100644 --- a/openApiDocs/beta/Compliance.yml +++ b/openApiDocs/beta/Compliance.yml @@ -8778,6 +8778,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.identitySet: @@ -13889,6 +13890,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -14081,7 +14083,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -21772,6 +21774,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -23761,6 +23764,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/CrossDeviceExperiences.yml b/openApiDocs/beta/CrossDeviceExperiences.yml index 77141a8cf54..91c7cbf215e 100644 --- a/openApiDocs/beta/CrossDeviceExperiences.yml +++ b/openApiDocs/beta/CrossDeviceExperiences.yml @@ -3177,6 +3177,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.Json: diff --git a/openApiDocs/beta/DeviceManagement.Actions.yml b/openApiDocs/beta/DeviceManagement.Actions.yml index ea1dda32108..d69db2ff5fe 100644 --- a/openApiDocs/beta/DeviceManagement.Actions.yml +++ b/openApiDocs/beta/DeviceManagement.Actions.yml @@ -996,6 +996,28 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + '/deviceManagement/comanagedDevices/{managedDevice-id}/microsoft.graph.enrollNowAction': + post: + tags: + - deviceManagement.Actions + summary: Invoke action enrollNowAction + description: Trigger comanagement enrollment action on ConfigurationManager client + operationId: deviceManagement.comanagedDevices_enrollNowAction + parameters: + - name: managedDevice-id + in: path + description: 'key: id of managedDevice' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: managedDevice + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/deviceManagement/comanagedDevices/{managedDevice-id}/microsoft.graph.locateDevice': post: tags: @@ -2621,6 +2643,78 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + /deviceManagement/deviceCompliancePolicies/microsoft.graph.getNoncompliantDevicesToRetire: + post: + tags: + - deviceManagement.Actions + summary: Invoke action getNoncompliantDevicesToRetire + operationId: deviceManagement.deviceCompliancePolicies_getNoncompliantDevicesToRetire + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + name: + type: string + nullable: true + select: + type: array + items: + type: string + nullable: true + search: + type: string + nullable: true + groupBy: + type: array + items: + type: string + nullable: true + orderBy: + type: array + items: + type: string + nullable: true + skip: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + top: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + sessionId: + type: string + nullable: true + filter: + type: string + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action /deviceManagement/deviceCompliancePolicies/microsoft.graph.hasPayloadLinks: post: tags: @@ -4435,6 +4529,28 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + '/deviceManagement/managedDevices/{managedDevice-id}/microsoft.graph.enrollNowAction': + post: + tags: + - deviceManagement.Actions + summary: Invoke action enrollNowAction + description: Trigger comanagement enrollment action on ConfigurationManager client + operationId: deviceManagement.managedDevices_enrollNowAction + parameters: + - name: managedDevice-id + in: path + description: 'key: id of managedDevice' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: managedDevice + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/deviceManagement/managedDevices/{managedDevice-id}/microsoft.graph.locateDevice': post: tags: @@ -5623,6 +5739,35 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + /deviceManagement/microsoft.graph.postOrganizationalMessageTenantConsent: + post: + tags: + - deviceManagement.Actions + summary: Invoke action postOrganizationalMessageTenantConsent + operationId: deviceManagement_postOrganizationalMessageTenantConsent + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + firstPartyMessageAllowed: + type: boolean + default: false + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.organizationalMessageTenantConsent' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action /deviceManagement/microsoft.graph.sendCustomNotificationToCompanyPortal: post: tags: @@ -5656,6 +5801,35 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + /deviceManagement/microsoft.graph.updateOrganizationalMessageTenantConsent: + post: + tags: + - deviceManagement.Actions + summary: Invoke action updateOrganizationalMessageTenantConsent + operationId: deviceManagement_updateOrganizationalMessageTenantConsent + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + firstPartyMessageAllowed: + type: boolean + default: false + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.organizationalMessageTenantConsent' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/deviceManagement/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponse-id}/microsoft.graph.createDownloadUrl': post: tags: @@ -5687,6 +5861,37 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + '/deviceManagement/microsoftTunnelServerLogCollectionResponses/{microsoftTunnelServerLogCollectionResponse-id}/microsoft.graph.generateDownloadUrl': + post: + tags: + - deviceManagement.Actions + summary: Invoke action generateDownloadUrl + operationId: deviceManagement.microsoftTunnelServerLogCollectionResponses_generateDownloadUrl + parameters: + - name: microsoftTunnelServerLogCollectionResponse-id + in: path + description: 'key: id of microsoftTunnelServerLogCollectionResponse' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: microsoftTunnelServerLogCollectionResponse + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + properties: + value: + type: string + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/deviceManagement/microsoftTunnelSites/{microsoftTunnelSite-id}/microsoft.graph.requestUpgrade': post: tags: @@ -5759,6 +5964,57 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + '/deviceManagement/microsoftTunnelSites/{microsoftTunnelSite-id}/microsoftTunnelServers/{microsoftTunnelServer-id}/microsoft.graph.generateServerLogCollectionRequest': + post: + tags: + - deviceManagement.Actions + summary: Invoke action generateServerLogCollectionRequest + operationId: deviceManagement.microsoftTunnelSites.microsoftTunnelServers_generateServerLogCollectionRequest + parameters: + - name: microsoftTunnelSite-id + in: path + description: 'key: id of microsoftTunnelSite' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: microsoftTunnelSite + - name: microsoftTunnelServer-id + in: path + description: 'key: id of microsoftTunnelServer' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: microsoftTunnelServer + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + startDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + format: date-time + endDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + format: date-time + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.microsoftTunnelServerLogCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/deviceManagement/microsoftTunnelSites/{microsoftTunnelSite-id}/microsoftTunnelServers/{microsoftTunnelServer-id}/microsoft.graph.getHealthMetrics': post: tags: @@ -8695,12 +8951,12 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action - /deviceManagement/reports/microsoft.graph.getNoncompliantDevicesAndSettingsReport: + /deviceManagement/reports/microsoft.graph.getMobileApplicationManagementAppRegistrationSummaryReport: post: tags: - deviceManagement.Actions - summary: Invoke action getNoncompliantDevicesAndSettingsReport - operationId: deviceManagement.reports_getNoncompliantDevicesAndSettingsReport + summary: Invoke action getMobileApplicationManagementAppRegistrationSummaryReport + operationId: deviceManagement.reports_getMobileApplicationManagementAppRegistrationSummaryReport requestBody: description: Action parameters content: @@ -8767,12 +9023,12 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action - /deviceManagement/reports/microsoft.graph.getPolicyNonComplianceMetadata: + /deviceManagement/reports/microsoft.graph.getNoncompliantDevicesAndSettingsReport: post: tags: - deviceManagement.Actions - summary: Invoke action getPolicyNonComplianceMetadata - operationId: deviceManagement.reports_getPolicyNonComplianceMetadata + summary: Invoke action getNoncompliantDevicesAndSettingsReport + operationId: deviceManagement.reports_getNoncompliantDevicesAndSettingsReport requestBody: description: Action parameters content: @@ -8839,12 +9095,12 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action - /deviceManagement/reports/microsoft.graph.getPolicyNonComplianceReport: + /deviceManagement/reports/microsoft.graph.getPolicyNonComplianceMetadata: post: tags: - deviceManagement.Actions - summary: Invoke action getPolicyNonComplianceReport - operationId: deviceManagement.reports_getPolicyNonComplianceReport + summary: Invoke action getPolicyNonComplianceMetadata + operationId: deviceManagement.reports_getPolicyNonComplianceMetadata requestBody: description: Action parameters content: @@ -8911,12 +9167,12 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action - /deviceManagement/reports/microsoft.graph.getPolicyNonComplianceSummaryReport: + /deviceManagement/reports/microsoft.graph.getPolicyNonComplianceReport: post: tags: - deviceManagement.Actions - summary: Invoke action getPolicyNonComplianceSummaryReport - operationId: deviceManagement.reports_getPolicyNonComplianceSummaryReport + summary: Invoke action getPolicyNonComplianceReport + operationId: deviceManagement.reports_getPolicyNonComplianceReport requestBody: description: Action parameters content: @@ -8983,12 +9239,84 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action - /deviceManagement/reports/microsoft.graph.getQuietTimePolicyUsersReport: + /deviceManagement/reports/microsoft.graph.getPolicyNonComplianceSummaryReport: post: tags: - deviceManagement.Actions - summary: Invoke action getQuietTimePolicyUsersReport - operationId: deviceManagement.reports_getQuietTimePolicyUsersReport + summary: Invoke action getPolicyNonComplianceSummaryReport + operationId: deviceManagement.reports_getPolicyNonComplianceSummaryReport + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + name: + type: string + nullable: true + select: + type: array + items: + type: string + nullable: true + search: + type: string + nullable: true + groupBy: + type: array + items: + type: string + nullable: true + orderBy: + type: array + items: + type: string + nullable: true + skip: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + top: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + sessionId: + type: string + nullable: true + filter: + type: string + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + /deviceManagement/reports/microsoft.graph.getQuietTimePolicyUsersReport: + post: + tags: + - deviceManagement.Actions + summary: Invoke action getQuietTimePolicyUsersReport + operationId: deviceManagement.reports_getQuietTimePolicyUsersReport requestBody: description: Action parameters content: @@ -10996,6 +11324,204 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + /deviceManagement/virtualEndpoint/reports/microsoft.graph.getDailyAggregatedRemoteConnectionReports: + post: + tags: + - deviceManagement.Actions + summary: Invoke action getDailyAggregatedRemoteConnectionReports + operationId: deviceManagement.virtualEndpoint.reports_getDailyAggregatedRemoteConnectionReports + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + filter: + type: string + nullable: true + select: + type: array + items: + type: string + nullable: true + search: + type: string + nullable: true + groupBy: + type: array + items: + type: string + nullable: true + orderBy: + type: array + items: + type: string + nullable: true + skip: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + top: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + /deviceManagement/virtualEndpoint/reports/microsoft.graph.getRemoteConnectionHistoricalReports: + post: + tags: + - deviceManagement.Actions + summary: Invoke action getRemoteConnectionHistoricalReports + operationId: deviceManagement.virtualEndpoint.reports_getRemoteConnectionHistoricalReports + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + filter: + type: string + nullable: true + select: + type: array + items: + type: string + nullable: true + search: + type: string + nullable: true + groupBy: + type: array + items: + type: string + nullable: true + orderBy: + type: array + items: + type: string + nullable: true + skip: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + top: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + /deviceManagement/virtualEndpoint/reports/microsoft.graph.getTotalAggregatedRemoteConnectionReports: + post: + tags: + - deviceManagement.Actions + summary: Invoke action getTotalAggregatedRemoteConnectionReports + operationId: deviceManagement.virtualEndpoint.reports_getTotalAggregatedRemoteConnectionReports + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + filter: + type: string + nullable: true + select: + type: array + items: + type: string + nullable: true + search: + type: string + nullable: true + groupBy: + type: array + items: + type: string + nullable: true + orderBy: + type: array + items: + type: string + nullable: true + skip: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + top: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/deviceManagement/virtualEndpoint/userSettings/{cloudPcUserSetting-id}/microsoft.graph.assign': post: tags: @@ -11835,6 +12361,11 @@ components: type: string description: Last modified time of the Assignment Filter. format: date-time + payloads: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.payloadByFilter' + description: Associated assignments for a specific filter platform: $ref: '#/components/schemas/microsoft.graph.devicePlatformType' roleScopeTags: @@ -12330,6 +12861,8 @@ components: nullable: true platforms: $ref: '#/components/schemas/microsoft.graph.deviceManagementConfigurationPlatforms' + priorityMetaData: + $ref: '#/components/schemas/microsoft.graph.deviceManagementPriorityMetaData' roleScopeTagIds: type: array items: @@ -12529,10 +13062,10 @@ components: modelAsString: false values: - value: cancelRetire - description: Cancel retire. + description: CancelRetire name: cancelRetire - value: confirmRetire - description: Retire these devices. + description: ConfirmRetire name: confirmRetire - value: unknownFutureValue description: Evolvable enumeration sentinel value. Do not use. @@ -13207,6 +13740,16 @@ components: additionalProperties: type: object description: Represent status details for device and payload and all associated applied filters. + microsoft.graph.organizationalMessageTenantConsent: + title: organizationalMessageTenantConsent + type: object + properties: + firstPartyMessageAllowed: + type: boolean + description: Indicates if first party message is allowed + additionalProperties: + type: object + description: This will allow the admin to see tenant consent info for specific tenant microsoft.graph.microsoftTunnelServerLogCollectionResponse: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -13634,8 +14177,28 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. + additionalProperties: + type: object + microsoft.graph.payloadByFilter: + title: payloadByFilter + type: object + properties: + assignmentFilterType: + $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentFilterType' + groupId: + type: string + description: The Azure AD security group ID + nullable: true + payloadId: + type: string + description: The policy identifier + nullable: true + payloadType: + $ref: '#/components/schemas/microsoft.graph.associatedAssignmentPayloadType' additionalProperties: type: object + description: This entity represents a single payload with requested assignment filter Id microsoft.graph.devicePlatformType: title: devicePlatformType enum: @@ -13855,6 +14418,11 @@ components: - value: unknownFutureValue description: Sentinel member for cases where the client cannot handle the new enum values. name: unknownFutureValue + microsoft.graph.deviceManagementPriorityMetaData: + title: deviceManagementPriorityMetaData + type: object + additionalProperties: + type: object microsoft.graph.deviceManagementConfigurationTechnologies: title: deviceManagementConfigurationTechnologies enum: @@ -14801,21 +15369,25 @@ components: - pending - completed - failed + - unknownFutureValue type: string - description: Enum type that represent the status of log collection. + description: Enum type that represent the status of log collection x-ms-enum: name: microsoftTunnelLogCollectionStatus modelAsString: false values: - value: pending - description: Log collection is in progress + description: Indicates that the log collection is in progress name: pending - value: completed - description: Log collection is completed + description: Indicates that the log collection is completed name: completed - value: failed - description: Log collection has failed + description: Indicates that the log collection has failed name: failed + - value: unknownFutureValue + description: Placeholder value for future expansion enums + name: unknownFutureValue microsoft.graph.appLogDecryptionAlgorithm: title: appLogDecryptionAlgorithm enum: @@ -14906,6 +15478,63 @@ components: - value: exclude description: 'Indicates out-filter, rule matching will not offer the payload to devices.' name: exclude + microsoft.graph.associatedAssignmentPayloadType: + title: associatedAssignmentPayloadType + enum: + - unknown + - deviceConfigurationAndCompliance + - application + - androidEnterpriseApp + - enrollmentConfiguration + - groupPolicyConfiguration + - zeroTouchDeploymentDeviceConfigProfile + - androidEnterpriseConfiguration + - deviceFirmwareConfigurationInterfacePolicy + - resourceAccessPolicy + - win32app + - deviceManagmentConfigurationAndCompliancePolicy + type: string + description: This enum represents associated assignment payload type + x-ms-enum: + name: associatedAssignmentPayloadType + modelAsString: false + values: + - value: unknown + description: Invalid payload type + name: unknown + - value: deviceConfigurationAndCompliance + description: Indicates that this filter is associated with a configuration or compliance policy payload type + name: deviceConfigurationAndCompliance + - value: application + description: Indicates that this assignment filter is associated with an application payload type + name: application + - value: androidEnterpriseApp + description: Indicates that this filter is associated with a Android Enterprise application payload type + name: androidEnterpriseApp + - value: enrollmentConfiguration + description: Indicates that this filter is associated with an enrollment restriction or enrollment status page policy payload type + name: enrollmentConfiguration + - value: groupPolicyConfiguration + description: Indicates that this filter is associated with an Administrative Template policy payload type + name: groupPolicyConfiguration + - value: zeroTouchDeploymentDeviceConfigProfile + description: Indicates that this assignment filter is associated with Zero touch deployment Device Configuration Profile payload type + name: zeroTouchDeploymentDeviceConfigProfile + - value: androidEnterpriseConfiguration + description: Indicates that this filter is associated with an Android Enterprise Configuration policy payload type + name: androidEnterpriseConfiguration + - value: deviceFirmwareConfigurationInterfacePolicy + description: Indicates that this assignment filter is associated with Device Firmware Configuration Interface(DCFI) payload type + name: deviceFirmwareConfigurationInterfacePolicy + - value: resourceAccessPolicy + description: 'Indicates that this filter is associated with a resource access policy (Wifi, VPN, Certificate) payload type' + name: resourceAccessPolicy + - value: win32app + description: Indicates that this filter is associated with a Win32 app payload type + name: win32app + - value: deviceManagmentConfigurationAndCompliancePolicy + description: Indicates that this filter is associated with a configuration or compliance policy on Device Configuration v2 Infrastructure payload type + name: deviceManagmentConfigurationAndCompliancePolicy microsoft.graph.deviceManagementComplianceActionType: title: deviceManagementComplianceActionType enum: @@ -14958,6 +15587,7 @@ components: - endpointSecurityAttackSurfaceReduction - endpointSecurityAccountProtection - endpointSecurityApplicationControl + - enrollmentConfiguration - baseline type: string description: Describes the TemplateFamily for the Template entity @@ -14989,6 +15619,9 @@ components: - value: endpointSecurityApplicationControl description: Template Family for ApplicationControl that helps mitigate security threats by restricting the applications that users can run and the code that runs in the System Core (kernel) name: endpointSecurityApplicationControl + - value: enrollmentConfiguration + description: Template Family for EnrollmentConfiguration + name: enrollmentConfiguration - value: baseline description: Template Family for Baseline name: baseline diff --git a/openApiDocs/beta/DeviceManagement.Administration.yml b/openApiDocs/beta/DeviceManagement.Administration.yml index 1135c193ff2..70697dc280a 100644 --- a/openApiDocs/beta/DeviceManagement.Administration.yml +++ b/openApiDocs/beta/DeviceManagement.Administration.yml @@ -13301,6 +13301,7 @@ paths: - onPremisesConnections - organizationSettings - provisioningPolicies + - reports - servicePlans - snapshots - supportedRegions @@ -13325,6 +13326,7 @@ paths: - onPremisesConnections - organizationSettings - provisioningPolicies + - reports - servicePlans - snapshots - supportedRegions @@ -13354,6 +13356,8 @@ paths: operationId: deviceManagement.VirtualEndpoint.GetOrganizationSettings provisioningPolicies: operationId: deviceManagement.VirtualEndpoint.ListProvisioningPolicies + reports: + operationId: deviceManagement.VirtualEndpoint.GetReports servicePlans: operationId: deviceManagement.VirtualEndpoint.ListServicePlans snapshots: @@ -15444,6 +15448,312 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation + /deviceManagement/virtualEndpoint/reports: + get: + tags: + - deviceManagement.virtualEndpoint + summary: Get reports from deviceManagement + operationId: deviceManagement.virtualEndpoint_GetReports + parameters: + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - exportJobs + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - exportJobs + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcReports' + links: + exportJobs: + operationId: deviceManagement.virtualEndpoint.Reports.ListExportJobs + getDailyAggregatedRemoteConnectionReports: + operationId: deviceManagement.virtualEndpoint.reports.getDailyAggregatedRemoteConnectionReports + getRealTimeRemoteConnectionLatency: + operationId: deviceManagement.virtualEndpoint.reports.getRealTimeRemoteConnectionLatency + getRealTimeRemoteConnectionStatus: + operationId: deviceManagement.virtualEndpoint.reports.getRealTimeRemoteConnectionStatus + getRemoteConnectionHistoricalReports: + operationId: deviceManagement.virtualEndpoint.reports.getRemoteConnectionHistoricalReports + getTotalAggregatedRemoteConnectionReports: + operationId: deviceManagement.virtualEndpoint.reports.getTotalAggregatedRemoteConnectionReports + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - deviceManagement.virtualEndpoint + summary: Update the navigation property reports in deviceManagement + operationId: deviceManagement.virtualEndpoint_UpdateReports + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcReports' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - deviceManagement.virtualEndpoint + summary: Delete navigation property reports for deviceManagement + operationId: deviceManagement.virtualEndpoint_DeleteReports + parameters: + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + /deviceManagement/virtualEndpoint/reports/exportJobs: + get: + tags: + - deviceManagement.virtualEndpoint + summary: Get exportJobs from deviceManagement + operationId: deviceManagement.virtualEndpoint.reports_ListExportJobs + 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 + - expirationDateTime + - expirationDateTime desc + - exportJobStatus + - exportJobStatus desc + - exportUrl + - exportUrl desc + - filter + - filter desc + - format + - format desc + - reportName + - reportName desc + - requestDateTime + - requestDateTime desc + - select + - select desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - expirationDateTime + - exportJobStatus + - exportUrl + - filter + - format + - reportName + - requestDateTime + - select + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.cloudPcExportJobCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - deviceManagement.virtualEndpoint + summary: Create new navigation property to exportJobs for deviceManagement + operationId: deviceManagement.virtualEndpoint.reports_CreateExportJobs + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/deviceManagement/virtualEndpoint/reports/exportJobs/{cloudPcExportJob-id}': + get: + tags: + - deviceManagement.virtualEndpoint + summary: Get exportJobs from deviceManagement + operationId: deviceManagement.virtualEndpoint.reports_GetExportJobs + parameters: + - name: cloudPcExportJob-id + in: path + description: 'key: id of cloudPcExportJob' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: cloudPcExportJob + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - expirationDateTime + - exportJobStatus + - exportUrl + - filter + - format + - reportName + - requestDateTime + - select + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - deviceManagement.virtualEndpoint + summary: Update the navigation property exportJobs in deviceManagement + operationId: deviceManagement.virtualEndpoint.reports_UpdateExportJobs + parameters: + - name: cloudPcExportJob-id + in: path + description: 'key: id of cloudPcExportJob' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: cloudPcExportJob + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - deviceManagement.virtualEndpoint + summary: Delete navigation property exportJobs for deviceManagement + operationId: deviceManagement.virtualEndpoint.reports_DeleteExportJobs + parameters: + - name: cloudPcExportJob-id + in: path + description: 'key: id of cloudPcExportJob' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: cloudPcExportJob + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation /deviceManagement/virtualEndpoint/servicePlans: get: tags: @@ -18281,6 +18591,8 @@ components: $ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningPolicy' description: Cloud PC provisioning policy. x-ms-navigationProperty: true + reports: + $ref: '#/components/schemas/microsoft.graph.cloudPcReports' servicePlans: type: array items: @@ -18715,6 +19027,55 @@ components: $ref: '#/components/schemas/microsoft.graph.cloudPcManagementAssignmentTarget' additionalProperties: type: object + microsoft.graph.cloudPcReports: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: cloudPcReports + type: object + properties: + exportJobs: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.cloudPcExportJob: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: cloudPcExportJob + 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 + format: date-time + nullable: true + exportJobStatus: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJobStatus' + exportUrl: + type: string + nullable: true + filter: + type: string + nullable: true + format: + type: string + nullable: true + reportName: + $ref: '#/components/schemas/microsoft.graph.cloudPcReportName' + requestDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 + select: + type: array + items: + type: string + nullable: true + additionalProperties: + type: object microsoft.graph.cloudPcServicePlan: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -18854,6 +19215,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.auditActor: @@ -20591,6 +20953,22 @@ components: type: object additionalProperties: type: object + microsoft.graph.cloudPcExportJobStatus: + title: cloudPcExportJobStatus + enum: + - notStarted + - inProgress + - completed + - unknownFutureValue + type: string + microsoft.graph.cloudPcReportName: + title: cloudPcReportName + enum: + - remoteConnectionHistoricalReports + - dailyAggregatedRemoteConnectionReports + - totalAggregatedRemoteConnectionReports + - unknownFutureValue + type: string microsoft.graph.cloudPcSnapshotStatus: title: cloudPcSnapshotStatus enum: @@ -21229,6 +21607,19 @@ components: nullable: true additionalProperties: type: object + microsoft.graph.cloudPcExportJobCollectionResponse: + title: Collection of cloudPcExportJob + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object microsoft.graph.cloudPcServicePlanCollectionResponse: title: Collection of cloudPcServicePlan type: object @@ -21988,6 +22379,12 @@ components: application/json: schema: $ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningPolicyAssignmentCollectionResponse' + microsoft.graph.cloudPcExportJobCollectionResponse: + description: Retrieved collection + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJobCollectionResponse' microsoft.graph.cloudPcServicePlanCollectionResponse: description: Retrieved collection content: diff --git a/openApiDocs/beta/DeviceManagement.Enrolment.yml b/openApiDocs/beta/DeviceManagement.Enrolment.yml index f994c6e6f53..b7c3796d49a 100644 --- a/openApiDocs/beta/DeviceManagement.Enrolment.yml +++ b/openApiDocs/beta/DeviceManagement.Enrolment.yml @@ -25013,6 +25013,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.androidDeviceOwnerEnrollmentMode: diff --git a/openApiDocs/beta/DeviceManagement.Functions.yml b/openApiDocs/beta/DeviceManagement.Functions.yml index 9b785bd49ef..5b2cef067db 100644 --- a/openApiDocs/beta/DeviceManagement.Functions.yml +++ b/openApiDocs/beta/DeviceManagement.Functions.yml @@ -1127,6 +1127,22 @@ paths: x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore + /deviceManagement/microsoft.graph.getOrganizationalMessageTenantConsent(): + get: + tags: + - deviceManagement.Functions + summary: Invoke function getOrganizationalMessageTenantConsent + operationId: deviceManagement_getOrganizationalMessageTenantConsent + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.organizationalMessageTenantConsent' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: function '/deviceManagement/microsoft.graph.getRoleScopeTagsByIds(ids={ids})': get: tags: @@ -2126,6 +2142,70 @@ paths: x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore + '/deviceManagement/virtualEndpoint/reports/microsoft.graph.getRealTimeRemoteConnectionLatency(cloudPcId=''{cloudPcId}'')': + get: + tags: + - deviceManagement.Functions + summary: Invoke function getRealTimeRemoteConnectionLatency + operationId: deviceManagement.virtualEndpoint.reports_getRealTimeRemoteConnectionLatency + parameters: + - name: cloudPcId + in: path + description: 'Usage: cloudPcId=''{cloudPcId}''' + required: true + style: simple + schema: + type: string + nullable: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: function + '/deviceManagement/virtualEndpoint/reports/microsoft.graph.getRealTimeRemoteConnectionStatus(cloudPcId=''{cloudPcId}'')': + get: + tags: + - deviceManagement.Functions + summary: Invoke function getRealTimeRemoteConnectionStatus + operationId: deviceManagement.virtualEndpoint.reports_getRealTimeRemoteConnectionStatus + parameters: + - name: cloudPcId + in: path + description: 'Usage: cloudPcId=''{cloudPcId}''' + required: true + style: simple + schema: + type: string + nullable: true + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: object + properties: + value: + type: string + format: base64url + nullable: true + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: function '/deviceManagement/virtualEndpoint/snapshots/microsoft.graph.getStorageAccounts(subscriptionId=''{subscriptionId}'')': get: tags: @@ -2881,6 +2961,16 @@ components: additionalProperties: type: object description: Contains the set of ResourceActions determining the allowed and not allowed permissions for each role. + microsoft.graph.organizationalMessageTenantConsent: + title: organizationalMessageTenantConsent + type: object + properties: + firstPartyMessageAllowed: + type: boolean + description: Indicates if first party message is allowed + additionalProperties: + type: object + description: This will allow the admin to see tenant consent info for specific tenant microsoft.graph.roleScopeTag: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -3051,17 +3141,17 @@ components: properties: averageBlueScreens: type: number - description: Average (mean) number of Blue Screens per device in the last 14 days. Valid values 0 to 9999999 + description: Average (mean) number of Blue Screens per device in the last 30 days. Valid values 0 to 9999999 format: double averageRestarts: type: number - description: Average (mean) number of Restarts per device in the last 14 days. Valid values 0 to 9999999 + description: Average (mean) number of Restarts per device in the last 30 days. Valid values 0 to 9999999 format: double blueScreenCount: maximum: 2147483647 minimum: -2147483648 type: integer - description: Number of Blue Screens in the last 14 days. Valid values 0 to 9999999 + description: Number of Blue Screens in the last 30 days. Valid values 0 to 9999999 format: int32 bootScore: maximum: 2147483647 @@ -3137,7 +3227,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer - description: Number of Restarts in the last 14 days. Valid values 0 to 9999999 + description: Number of Restarts in the last 30 days. Valid values 0 to 9999999 format: int32 startupPerformanceScore: type: number @@ -3815,6 +3905,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.roleScopeTagAutoAssignment: diff --git a/openApiDocs/beta/DeviceManagement.yml b/openApiDocs/beta/DeviceManagement.yml index 03bf3efbb7e..0de78323c2c 100644 --- a/openApiDocs/beta/DeviceManagement.yml +++ b/openApiDocs/beta/DeviceManagement.yml @@ -39,6 +39,7 @@ paths: - managedDeviceCleanupSettings - subscriptions - subscriptionState + - userExperienceAnalyticsAnomalySeverityOverview - userExperienceAnalyticsSettings - windowsMalwareOverview - monitoring @@ -109,6 +110,8 @@ paths: - oemWarrantyInformationOnboarding - remoteActionAudits - tenantAttachRBAC + - userExperienceAnalyticsAnomaly + - userExperienceAnalyticsAnomalyDevice - userExperienceAnalyticsAppHealthApplicationPerformance - userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion - userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails @@ -279,6 +282,8 @@ paths: - oemWarrantyInformationOnboarding - remoteActionAudits - tenantAttachRBAC + - userExperienceAnalyticsAnomaly + - userExperienceAnalyticsAnomalyDevice - userExperienceAnalyticsAppHealthApplicationPerformance - userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion - userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails @@ -514,6 +519,10 @@ paths: operationId: deviceManagement.ListRemoteActionAudits tenantAttachRBAC: operationId: deviceManagement.GetTenantAttachRBAC + userExperienceAnalyticsAnomaly: + operationId: deviceManagement.ListUserExperienceAnalyticsAnomaly + userExperienceAnalyticsAnomalyDevice: + operationId: deviceManagement.ListUserExperienceAnalyticsAnomalyDevice userExperienceAnalyticsAppHealthApplicationPerformance: operationId: deviceManagement.ListUserExperienceAnalyticsAppHealthApplicationPerformance userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion: @@ -712,16 +721,22 @@ paths: operationId: deviceManagement.getComanagementEligibleDevicesSummary getEffectivePermissions: operationId: deviceManagement.getEffectivePermissions + getOrganizationalMessageTenantConsent: + operationId: deviceManagement.getOrganizationalMessageTenantConsent getRoleScopeTagsByIds: operationId: deviceManagement.getRoleScopeTagsGraphBPreIds getRoleScopeTagsByResource: operationId: deviceManagement.getRoleScopeTagsGraphBPreResource getSuggestedEnrollmentLimit: operationId: deviceManagement.getSuggestedEnrollmentLimit + postOrganizationalMessageTenantConsent: + operationId: deviceManagement.postOrganizationalMessageTenantConsent scopedForResource: operationId: deviceManagement.scopedGraphFPreResource sendCustomNotificationToCompanyPortal: operationId: deviceManagement.sendCustomNotificationToCompanyPortal + updateOrganizationalMessageTenantConsent: + operationId: deviceManagement.updateOrganizationalMessageTenantConsent userExperienceAnalyticsSummarizeWorkFromAnywhereDevices: operationId: deviceManagement.userExperienceAnalyticsSummarizeWorkFromAnywhereDevices verifyWindowsEnrollmentAutoDiscovery: @@ -1692,6 +1707,8 @@ paths: - displayName desc - lastModifiedDateTime - lastModifiedDateTime desc + - payloads + - payloads desc - platform - platform desc - roleScopeTags @@ -1714,6 +1731,7 @@ paths: - description - displayName - lastModifiedDateTime + - payloads - platform - roleScopeTags - rule @@ -1792,6 +1810,7 @@ paths: - description - displayName - lastModifiedDateTime + - payloads - platform - roleScopeTags - rule @@ -2897,6 +2916,8 @@ paths: operationId: deviceManagement.comanagedDevices.managedDevice.disableLostMode enableLostMode: operationId: deviceManagement.comanagedDevices.managedDevice.enableLostMode + enrollNowAction: + operationId: deviceManagement.comanagedDevices.managedDevice.enrollNowAction getCloudPcRemoteActionResults: operationId: deviceManagement.comanagedDevices.managedDevice.getCloudPcRemoteActionResults getCloudPcReviewStatus: @@ -7688,6 +7709,8 @@ paths: - name desc - platforms - platforms desc + - priorityMetaData + - priorityMetaData desc - roleScopeTagIds - roleScopeTagIds desc - settingCount @@ -7715,6 +7738,7 @@ paths: - lastModifiedDateTime - name - platforms + - priorityMetaData - roleScopeTagIds - settingCount - technologies @@ -7801,6 +7825,7 @@ paths: - lastModifiedDateTime - name - platforms + - priorityMetaData - roleScopeTagIds - settingCount - technologies @@ -26875,6 +26900,8 @@ paths: operationId: deviceManagement.managedDevices.managedDevice.disableLostMode enableLostMode: operationId: deviceManagement.managedDevices.managedDevice.enableLostMode + enrollNowAction: + operationId: deviceManagement.managedDevices.managedDevice.enrollNowAction getCloudPcRemoteActionResults: operationId: deviceManagement.managedDevices.managedDevice.getCloudPcRemoteActionResults getCloudPcReviewStatus: @@ -29954,6 +29981,10 @@ paths: - network desc - roleScopeTagIds - roleScopeTagIds desc + - routeExcludes + - routeExcludes desc + - routeIncludes + - routeIncludes desc - routesExclude - routesExclude desc - routesInclude @@ -29982,6 +30013,8 @@ paths: - listenPort - network - roleScopeTagIds + - routeExcludes + - routeIncludes - routesExclude - routesInclude - splitDNS @@ -30066,6 +30099,8 @@ paths: - listenPort - network - roleScopeTagIds + - routeExcludes + - routeIncludes - routesExclude - routesInclude - splitDNS @@ -30504,6 +30539,8 @@ paths: links: createDownloadUrl: operationId: deviceManagement.microsoftTunnelServerLogCollectionResponses.microsoftTunnelServerLogCollectionResponse.createDownloadUrl + generateDownloadUrl: + operationId: deviceManagement.microsoftTunnelServerLogCollectionResponses.microsoftTunnelServerLogCollectionResponse.generateDownloadUrl default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation @@ -30844,6 +30881,8 @@ paths: - listenPort - network - roleScopeTagIds + - routeExcludes + - routeIncludes - routesExclude - routesInclude - splitDNS @@ -31099,6 +31138,8 @@ paths: links: createServerLogCollectionRequest: operationId: deviceManagement.microsoftTunnelSites.microsoftTunnelSite.microsoftTunnelServers.microsoftTunnelServer.createServerLogCollectionRequest + generateServerLogCollectionRequest: + operationId: deviceManagement.microsoftTunnelSites.microsoftTunnelSite.microsoftTunnelServers.microsoftTunnelServer.generateServerLogCollectionRequest getHealthMetrics: operationId: deviceManagement.microsoftTunnelSites.microsoftTunnelSite.microsoftTunnelServers.microsoftTunnelServer.getHealthMetrics getHealthMetricTimeSeries: @@ -35709,13 +35750,13 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformance: + /deviceManagement/userExperienceAnalyticsAnomaly: get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance - summary: Get userExperienceAnalyticsAppHealthApplicationPerformance from deviceManagement - description: User experience analytics appHealth Application Performance - operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformance + - deviceManagement.userExperienceAnalyticsAnomaly + summary: Get userExperienceAnalyticsAnomaly from deviceManagement + description: The user experience analytics anomaly entity contains anomaly details. + operationId: deviceManagement_ListUserExperienceAnalyticsAnomaly parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' @@ -35734,26 +35775,32 @@ paths: enum: - id - id desc - - activeDeviceCount - - activeDeviceCount desc - - appCrashCount - - appCrashCount desc - - appDisplayName - - appDisplayName desc - - appHangCount - - appHangCount desc - - appHealthScore - - appHealthScore desc - - appHealthStatus - - appHealthStatus desc - - appName - - appName desc - - appPublisher - - appPublisher desc - - appUsageDuration - - appUsageDuration desc - - meanTimeToFailureInMinutes - - meanTimeToFailureInMinutes desc + - anomalyFirstOccurrenceDateTime + - anomalyFirstOccurrenceDateTime desc + - anomalyId + - anomalyId desc + - anomalyLatestOccurrenceDateTime + - anomalyLatestOccurrenceDateTime desc + - anomalyName + - anomalyName desc + - anomalyType + - anomalyType desc + - assetName + - assetName desc + - assetPublisher + - assetPublisher desc + - assetVersion + - assetVersion desc + - detectionModelId + - detectionModelId desc + - deviceImpactedCount + - deviceImpactedCount desc + - issueId + - issueId desc + - severity + - severity desc + - state + - state desc type: string - name: $select in: query @@ -35766,16 +35813,19 @@ paths: items: enum: - id - - activeDeviceCount - - appCrashCount - - appDisplayName - - appHangCount - - appHealthScore - - appHealthStatus - - appName - - appPublisher - - appUsageDuration - - meanTimeToFailureInMinutes + - anomalyFirstOccurrenceDateTime + - anomalyId + - anomalyLatestOccurrenceDateTime + - anomalyName + - anomalyType + - assetName + - assetPublisher + - assetVersion + - detectionModelId + - deviceImpactedCount + - issueId + - severity + - state type: string - name: $expand in: query @@ -35791,7 +35841,7 @@ paths: type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformanceCollectionResponse' + $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAnomalyCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -35800,15 +35850,15 @@ paths: x-ms-docs-operation-type: operation post: tags: - - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance - summary: Create new navigation property to userExperienceAnalyticsAppHealthApplicationPerformance for deviceManagement - operationId: deviceManagement_CreateUserExperienceAnalyticsAppHealthApplicationPerformance + - deviceManagement.userExperienceAnalyticsAnomaly + summary: Create new navigation property to userExperienceAnalyticsAnomaly for deviceManagement + operationId: deviceManagement_CreateUserExperienceAnalyticsAnomaly requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomaly' required: true responses: '201': @@ -35816,26 +35866,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomaly' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformance/{userExperienceAnalyticsAppHealthApplicationPerformance-id}': + '/deviceManagement/userExperienceAnalyticsAnomaly/{userExperienceAnalyticsAnomaly-id}': get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance - summary: Get userExperienceAnalyticsAppHealthApplicationPerformance from deviceManagement - description: User experience analytics appHealth Application Performance - operationId: deviceManagement_GetUserExperienceAnalyticsAppHealthApplicationPerformance + - deviceManagement.userExperienceAnalyticsAnomaly + summary: Get userExperienceAnalyticsAnomaly from deviceManagement + description: The user experience analytics anomaly entity contains anomaly details. + operationId: deviceManagement_GetUserExperienceAnalyticsAnomaly parameters: - - name: userExperienceAnalyticsAppHealthApplicationPerformance-id + - name: userExperienceAnalyticsAnomaly-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthApplicationPerformance' + description: 'key: id of userExperienceAnalyticsAnomaly' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthApplicationPerformance + x-ms-docs-key-type: userExperienceAnalyticsAnomaly - name: $select in: query description: Select properties to be returned @@ -35847,16 +35897,19 @@ paths: items: enum: - id - - activeDeviceCount - - appCrashCount - - appDisplayName - - appHangCount - - appHealthScore - - appHealthStatus - - appName - - appPublisher - - appUsageDuration - - meanTimeToFailureInMinutes + - anomalyFirstOccurrenceDateTime + - anomalyId + - anomalyLatestOccurrenceDateTime + - anomalyName + - anomalyType + - assetName + - assetPublisher + - assetVersion + - detectionModelId + - deviceImpactedCount + - issueId + - severity + - state type: string - name: $expand in: query @@ -35876,30 +35929,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomaly' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance - summary: Update the navigation property userExperienceAnalyticsAppHealthApplicationPerformance in deviceManagement - operationId: deviceManagement_UpdateUserExperienceAnalyticsAppHealthApplicationPerformance + - deviceManagement.userExperienceAnalyticsAnomaly + summary: Update the navigation property userExperienceAnalyticsAnomaly in deviceManagement + operationId: deviceManagement_UpdateUserExperienceAnalyticsAnomaly parameters: - - name: userExperienceAnalyticsAppHealthApplicationPerformance-id + - name: userExperienceAnalyticsAnomaly-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthApplicationPerformance' + description: 'key: id of userExperienceAnalyticsAnomaly' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthApplicationPerformance + x-ms-docs-key-type: userExperienceAnalyticsAnomaly requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomaly' required: true responses: '204': @@ -35909,18 +35962,18 @@ paths: x-ms-docs-operation-type: operation delete: tags: - - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance - summary: Delete navigation property userExperienceAnalyticsAppHealthApplicationPerformance for deviceManagement - operationId: deviceManagement_DeleteUserExperienceAnalyticsAppHealthApplicationPerformance + - deviceManagement.userExperienceAnalyticsAnomaly + summary: Delete navigation property userExperienceAnalyticsAnomaly for deviceManagement + operationId: deviceManagement_DeleteUserExperienceAnalyticsAnomaly parameters: - - name: userExperienceAnalyticsAppHealthApplicationPerformance-id + - name: userExperienceAnalyticsAnomaly-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthApplicationPerformance' + description: 'key: id of userExperienceAnalyticsAnomaly' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthApplicationPerformance + x-ms-docs-key-type: userExperienceAnalyticsAnomaly - name: If-Match in: header description: ETag @@ -35933,13 +35986,13 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion: + /deviceManagement/userExperienceAnalyticsAnomalyDevice: get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion - summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion from deviceManagement - description: User experience analytics appHealth Application Performance by App Version - operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + - deviceManagement.userExperienceAnalyticsAnomalyDevice + summary: Get userExperienceAnalyticsAnomalyDevice from deviceManagement + description: The user experience analytics anomaly entity contains device details. + operationId: deviceManagement_ListUserExperienceAnalyticsAnomalyDevice parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' @@ -35958,20 +36011,24 @@ paths: enum: - id - id desc - - appCrashCount - - appCrashCount desc - - appDisplayName - - appDisplayName desc - - appName - - appName desc - - appPublisher - - appPublisher desc - - appUsageDuration - - appUsageDuration desc - - appVersion - - appVersion desc - - meanTimeToFailureInMinutes - - meanTimeToFailureInMinutes desc + - anomalyId + - anomalyId desc + - anomalyOnDeviceFirstOccurrenceDateTime + - anomalyOnDeviceFirstOccurrenceDateTime desc + - anomalyOnDeviceLatestOccurrenceDateTime + - anomalyOnDeviceLatestOccurrenceDateTime desc + - deviceId + - deviceId desc + - deviceManufacturer + - deviceManufacturer desc + - deviceModel + - deviceModel desc + - deviceName + - deviceName desc + - osName + - osName desc + - osVersion + - osVersion desc type: string - name: $select in: query @@ -35984,13 +36041,15 @@ paths: items: enum: - id - - appCrashCount - - appDisplayName - - appName - - appPublisher - - appUsageDuration - - appVersion - - meanTimeToFailureInMinutes + - anomalyId + - anomalyOnDeviceFirstOccurrenceDateTime + - anomalyOnDeviceLatestOccurrenceDateTime + - deviceId + - deviceManufacturer + - deviceModel + - deviceName + - osName + - osVersion type: string - name: $expand in: query @@ -36006,7 +36065,7 @@ paths: type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionCollectionResponse' + $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAnomalyDeviceCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -36015,15 +36074,15 @@ paths: x-ms-docs-operation-type: operation post: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion - summary: Create new navigation property to userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion for deviceManagement - operationId: deviceManagement_CreateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + - deviceManagement.userExperienceAnalyticsAnomalyDevice + summary: Create new navigation property to userExperienceAnalyticsAnomalyDevice for deviceManagement + operationId: deviceManagement_CreateUserExperienceAnalyticsAnomalyDevice requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDevice' required: true responses: '201': @@ -36031,26 +36090,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDevice' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion/{userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id}': + '/deviceManagement/userExperienceAnalyticsAnomalyDevice/{userExperienceAnalyticsAnomalyDevice-id}': get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion - summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion from deviceManagement - description: User experience analytics appHealth Application Performance by App Version - operationId: deviceManagement_GetUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + - deviceManagement.userExperienceAnalyticsAnomalyDevice + summary: Get userExperienceAnalyticsAnomalyDevice from deviceManagement + description: The user experience analytics anomaly entity contains device details. + operationId: deviceManagement_GetUserExperienceAnalyticsAnomalyDevice parameters: - - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id + - name: userExperienceAnalyticsAnomalyDevice-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + description: 'key: id of userExperienceAnalyticsAnomalyDevice' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + x-ms-docs-key-type: userExperienceAnalyticsAnomalyDevice - name: $select in: query description: Select properties to be returned @@ -36062,13 +36121,15 @@ paths: items: enum: - id - - appCrashCount - - appDisplayName - - appName - - appPublisher - - appUsageDuration - - appVersion - - meanTimeToFailureInMinutes + - anomalyId + - anomalyOnDeviceFirstOccurrenceDateTime + - anomalyOnDeviceLatestOccurrenceDateTime + - deviceId + - deviceManufacturer + - deviceModel + - deviceName + - osName + - osVersion type: string - name: $expand in: query @@ -36088,30 +36149,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDevice' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion - summary: Update the navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion in deviceManagement - operationId: deviceManagement_UpdateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + - deviceManagement.userExperienceAnalyticsAnomalyDevice + summary: Update the navigation property userExperienceAnalyticsAnomalyDevice in deviceManagement + operationId: deviceManagement_UpdateUserExperienceAnalyticsAnomalyDevice parameters: - - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id + - name: userExperienceAnalyticsAnomalyDevice-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + description: 'key: id of userExperienceAnalyticsAnomalyDevice' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + x-ms-docs-key-type: userExperienceAnalyticsAnomalyDevice requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDevice' required: true responses: '204': @@ -36121,18 +36182,18 @@ paths: x-ms-docs-operation-type: operation delete: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion - summary: Delete navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion for deviceManagement - operationId: deviceManagement_DeleteUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + - deviceManagement.userExperienceAnalyticsAnomalyDevice + summary: Delete navigation property userExperienceAnalyticsAnomalyDevice for deviceManagement + operationId: deviceManagement_DeleteUserExperienceAnalyticsAnomalyDevice parameters: - - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id + - name: userExperienceAnalyticsAnomalyDevice-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + description: 'key: id of userExperienceAnalyticsAnomalyDevice' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + x-ms-docs-key-type: userExperienceAnalyticsAnomalyDevice - name: If-Match in: header description: ETag @@ -36145,13 +36206,13 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails: + /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformance: get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails - summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails from deviceManagement - description: User experience analytics appHealth Application Performance by App Version details - operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance + summary: Get userExperienceAnalyticsAppHealthApplicationPerformance from deviceManagement + description: User experience analytics appHealth Application Performance + operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformance parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' @@ -36170,22 +36231,26 @@ paths: enum: - id - id desc + - activeDeviceCount + - activeDeviceCount desc - appCrashCount - appCrashCount desc - appDisplayName - appDisplayName desc + - appHangCount + - appHangCount desc + - appHealthScore + - appHealthScore desc + - appHealthStatus + - appHealthStatus desc - appName - appName desc - appPublisher - appPublisher desc - - appVersion - - appVersion desc - - deviceCountWithCrashes - - deviceCountWithCrashes desc - - isLatestUsedVersion - - isLatestUsedVersion desc - - isMostUsedVersion - - isMostUsedVersion desc + - appUsageDuration + - appUsageDuration desc + - meanTimeToFailureInMinutes + - meanTimeToFailureInMinutes desc type: string - name: $select in: query @@ -36198,14 +36263,16 @@ paths: items: enum: - id + - activeDeviceCount - appCrashCount - appDisplayName + - appHangCount + - appHealthScore + - appHealthStatus - appName - appPublisher - - appVersion - - deviceCountWithCrashes - - isLatestUsedVersion - - isMostUsedVersion + - appUsageDuration + - meanTimeToFailureInMinutes type: string - name: $expand in: query @@ -36221,7 +36288,7 @@ paths: type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetailsCollectionResponse' + $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformanceCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -36230,15 +36297,15 @@ paths: x-ms-docs-operation-type: operation post: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails - summary: Create new navigation property to userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails for deviceManagement - operationId: deviceManagement_CreateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance + summary: Create new navigation property to userExperienceAnalyticsAppHealthApplicationPerformance for deviceManagement + operationId: deviceManagement_CreateUserExperienceAnalyticsAppHealthApplicationPerformance requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' required: true responses: '201': @@ -36246,26 +36313,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails/{userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id}': + '/deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformance/{userExperienceAnalyticsAppHealthApplicationPerformance-id}': get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails - summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails from deviceManagement - description: User experience analytics appHealth Application Performance by App Version details - operationId: deviceManagement_GetUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance + summary: Get userExperienceAnalyticsAppHealthApplicationPerformance from deviceManagement + description: User experience analytics appHealth Application Performance + operationId: deviceManagement_GetUserExperienceAnalyticsAppHealthApplicationPerformance parameters: - - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id + - name: userExperienceAnalyticsAppHealthApplicationPerformance-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + description: 'key: id of userExperienceAnalyticsAppHealthApplicationPerformance' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + x-ms-docs-key-type: userExperienceAnalyticsAppHealthApplicationPerformance - name: $select in: query description: Select properties to be returned @@ -36277,14 +36344,16 @@ paths: items: enum: - id + - activeDeviceCount - appCrashCount - appDisplayName + - appHangCount + - appHealthScore + - appHealthStatus - appName - appPublisher - - appVersion - - deviceCountWithCrashes - - isLatestUsedVersion - - isMostUsedVersion + - appUsageDuration + - meanTimeToFailureInMinutes type: string - name: $expand in: query @@ -36304,30 +36373,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails - summary: Update the navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails in deviceManagement - operationId: deviceManagement_UpdateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance + summary: Update the navigation property userExperienceAnalyticsAppHealthApplicationPerformance in deviceManagement + operationId: deviceManagement_UpdateUserExperienceAnalyticsAppHealthApplicationPerformance parameters: - - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id + - name: userExperienceAnalyticsAppHealthApplicationPerformance-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + description: 'key: id of userExperienceAnalyticsAppHealthApplicationPerformance' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + x-ms-docs-key-type: userExperienceAnalyticsAppHealthApplicationPerformance requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance' required: true responses: '204': @@ -36337,18 +36406,18 @@ paths: x-ms-docs-operation-type: operation delete: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails - summary: Delete navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails for deviceManagement - operationId: deviceManagement_DeleteUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + - deviceManagement.userExperienceAnalyticsAppHealthApplicationPerformance + summary: Delete navigation property userExperienceAnalyticsAppHealthApplicationPerformance for deviceManagement + operationId: deviceManagement_DeleteUserExperienceAnalyticsAppHealthApplicationPerformance parameters: - - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id + - name: userExperienceAnalyticsAppHealthApplicationPerformance-id in: path - description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + description: 'key: id of userExperienceAnalyticsAppHealthApplicationPerformance' required: true style: simple schema: type: string - x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + x-ms-docs-key-type: userExperienceAnalyticsAppHealthApplicationPerformance - name: If-Match in: header description: ETag @@ -36361,13 +36430,441 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDeviceId: + /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion: get: tags: - - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId - summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDeviceId from deviceManagement - description: User experience analytics appHealth Application Performance by App Version Device Id - operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDeviceId + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion from deviceManagement + description: User experience analytics appHealth Application Performance by App Version + operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + 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 + - appCrashCount + - appCrashCount desc + - appDisplayName + - appDisplayName desc + - appName + - appName desc + - appPublisher + - appPublisher desc + - appUsageDuration + - appUsageDuration desc + - appVersion + - appVersion desc + - meanTimeToFailureInMinutes + - meanTimeToFailureInMinutes desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - appCrashCount + - appDisplayName + - appName + - appPublisher + - appUsageDuration + - appVersion + - meanTimeToFailureInMinutes + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + summary: Create new navigation property to userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion for deviceManagement + operationId: deviceManagement_CreateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion/{userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id}': + get: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion from deviceManagement + description: User experience analytics appHealth Application Performance by App Version + operationId: deviceManagement_GetUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + parameters: + - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id + in: path + description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - appCrashCount + - appDisplayName + - appName + - appPublisher + - appUsageDuration + - appVersion + - meanTimeToFailureInMinutes + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + summary: Update the navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion in deviceManagement + operationId: deviceManagement_UpdateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + parameters: + - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id + in: path + description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + summary: Delete navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersion for deviceManagement + operationId: deviceManagement_DeleteUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersion + parameters: + - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion-id + in: path + description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersion + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails: + get: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails from deviceManagement + description: User experience analytics appHealth Application Performance by App Version details + operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + 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 + - appCrashCount + - appCrashCount desc + - appDisplayName + - appDisplayName desc + - appName + - appName desc + - appPublisher + - appPublisher desc + - appVersion + - appVersion desc + - deviceCountWithCrashes + - deviceCountWithCrashes desc + - isLatestUsedVersion + - isLatestUsedVersion desc + - isMostUsedVersion + - isMostUsedVersion desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - appCrashCount + - appDisplayName + - appName + - appPublisher + - appVersion + - deviceCountWithCrashes + - isLatestUsedVersion + - isMostUsedVersion + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetailsCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + summary: Create new navigation property to userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails for deviceManagement + operationId: deviceManagement_CreateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails/{userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id}': + get: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails from deviceManagement + description: User experience analytics appHealth Application Performance by App Version details + operationId: deviceManagement_GetUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + parameters: + - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id + in: path + description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - appCrashCount + - appDisplayName + - appName + - appPublisher + - appVersion + - deviceCountWithCrashes + - isLatestUsedVersion + - isMostUsedVersion + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + summary: Update the navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails in deviceManagement + operationId: deviceManagement_UpdateUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + parameters: + - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id + in: path + description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + summary: Delete navigation property userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDetails for deviceManagement + operationId: deviceManagement_DeleteUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDetails + parameters: + - name: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails-id + in: path + description: 'key: id of userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + /deviceManagement/userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDeviceId: + get: + tags: + - deviceManagement.userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId + summary: Get userExperienceAnalyticsAppHealthApplicationPerformanceByAppVersionDeviceId from deviceManagement + description: User experience analytics appHealth Application Performance by App Version Device Id + operationId: deviceManagement_ListUserExperienceAnalyticsAppHealthApplicationPerformanceGraphBPreAppVersionDeviceId parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' @@ -46332,6 +46829,8 @@ components: $ref: '#/components/schemas/microsoft.graph.deviceManagementSubscriptions' subscriptionState: $ref: '#/components/schemas/microsoft.graph.deviceManagementSubscriptionState' + userExperienceAnalyticsAnomalySeverityOverview: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalySeverityOverview' userExperienceAnalyticsSettings: $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsSettings' windowsMalwareOverview: @@ -46688,6 +47187,18 @@ components: x-ms-navigationProperty: true tenantAttachRBAC: $ref: '#/components/schemas/microsoft.graph.tenantAttachRBAC' + userExperienceAnalyticsAnomaly: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomaly' + description: The user experience analytics anomaly entity contains anomaly details. + x-ms-navigationProperty: true + userExperienceAnalyticsAnomalyDevice: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDevice' + description: The user experience analytics anomaly entity contains device details. + x-ms-navigationProperty: true userExperienceAnalyticsAppHealthApplicationPerformance: type: array items: @@ -47472,6 +47983,11 @@ components: type: string description: Last modified time of the Assignment Filter. format: date-time + payloads: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.payloadByFilter' + description: Associated assignments for a specific filter platform: $ref: '#/components/schemas/microsoft.graph.devicePlatformType' roleScopeTags: @@ -48687,6 +49203,8 @@ components: nullable: true platforms: $ref: '#/components/schemas/microsoft.graph.deviceManagementConfigurationPlatforms' + priorityMetaData: + $ref: '#/components/schemas/microsoft.graph.deviceManagementPriorityMetaData' roleScopeTagIds: type: array items: @@ -51224,15 +51742,15 @@ components: nullable: true description: type: string - description: The MicrosoftTunnelConfiguration's description + description: The configuration's description (optional) nullable: true disableUdpConnections: type: boolean - description: 'When DisableUdpConnections is set, the clients and VPN server will not use DTLS connections to tansfer data.' + description: 'When DisableUdpConnections is set, the clients and VPN server will not use DTLS connections to transfer data.' nullable: true displayName: type: string - description: The MicrosoftTunnelConfiguration's display name + description: The display name for the server configuration. This property is required when a server is created. nullable: true dnsServers: type: array @@ -51243,7 +51761,7 @@ components: lastUpdateDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string - description: When the MicrosoftTunnelConfiguration was last updated + description: When the configuration was last updated format: date-time listenPort: maximum: 2147483647 @@ -51261,19 +51779,31 @@ components: items: type: string nullable: true - description: List of Scope Tags for this Entity instance. - routesExclude: + description: List of Scope Tags for this Entity instance + routeExcludes: type: array items: type: string nullable: true description: Subsets of the routes that will not be routed by the server + routeIncludes: + type: array + items: + type: string + nullable: true + description: The routes that will be routed by the server + routesExclude: + type: array + items: + type: string + nullable: true + description: 'Subsets of the routes that will not be routed by the server. This property is going to be deprecated with the option of using the new property, ''RouteExcludes''.' routesInclude: type: array items: type: string nullable: true - description: The routs that will be routed by the server + description: 'The routes that will be routed by the server. This property is going to be deprecated with the option of using the new property, ''RouteIncludes''.' splitDNS: type: array items: @@ -51291,23 +51821,23 @@ components: properties: defaultHealthyThreshold: type: integer - description: The default threshold for being healthy + description: 'The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized. Read-only.' format: int64 defaultUnhealthyThreshold: type: integer - description: The default threshold for being unhealthy + description: 'The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency unhealthy > 20ms, health metrics can be customized. Read-only.' format: int64 healthyThreshold: type: integer - description: The threshold for being healthy + description: 'The threshold for being healthy based on default health status metrics: CPU usage healthy < 50%, Memory usage healthy < 50%, Disk space healthy > 5GB, Latency healthy < 10ms, health metrics can be customized.' format: int64 unhealthyThreshold: type: integer - description: The threshold for being unhealthy + description: 'The threshold for being unhealthy based on default health status metrics: CPU usage unhealthy > 75%, Memory usage unhealthy > 75%, Disk space < 3GB, Latency Unhealthy > 20ms, health metrics can be customized.' format: int64 additionalProperties: type: object - description: Entity that represents the health thresholds of a health metric. + description: Entity that represents the health thresholds of a health metric microsoft.graph.microsoftTunnelServerLogCollectionResponse: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -51355,35 +51885,35 @@ components: properties: description: type: string - description: The MicrosoftTunnelSite's description + description: The site's description (optional) nullable: true displayName: type: string - description: The MicrosoftTunnelSite's display name + description: The display name for the site. This property is required when a site is created. nullable: true enableCertificatePinning: type: boolean description: 'When set to true, certificate pinning will be enforced on connections between the Microsoft Tunnel server and Microsoft Tunnel clients. When set to false, certificate pinning will be disabled.' internalNetworkProbeUrl: type: string - description: The MicrosoftTunnelSite's Internal Network Access Probe URL + description: The site's Internal Network Access Probe URL nullable: true publicAddress: type: string - description: The MicrosoftTunnelSite's public domain name or IP address + description: The site's public domain name or IP address nullable: true roleScopeTagIds: type: array items: type: string nullable: true - description: List of Scope Tags for this Entity instance. + description: List of Scope Tags for this Entity instance upgradeAutomatically: type: boolean description: 'The site''s automatic upgrade setting. True for automatic upgrades, false for manual control' upgradeAvailable: type: boolean - description: True if an upgrade is available + description: The site provides the state of when an upgrade is available upgradeWindowEndTime: pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$' type: string @@ -51426,12 +51956,12 @@ components: nullable: true displayName: type: string - description: The MicrosoftTunnelServer's display name + description: The display name for the server. This property is required when a server is created and cannot be cleared during updates. nullable: true lastCheckinDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string - description: When the MicrosoftTunnelServer last checked in + description: Indicates when the server last checked in format: date-time serverImageDigest: type: string @@ -51865,6 +52395,112 @@ components: additionalProperties: type: object description: Event representing an general failure. + microsoft.graph.userExperienceAnalyticsAnomaly: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: userExperienceAnalyticsAnomaly + type: object + properties: + anomalyFirstOccurrenceDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 first occurrence date and time for the anomaly. + format: date-time + anomalyId: + type: string + description: The unique identifier of the anomaly. + nullable: true + anomalyLatestOccurrenceDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 latest occurrence date and time for the anomaly. + format: date-time + anomalyName: + type: string + description: The name of the anomaly. + nullable: true + anomalyType: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyType' + assetName: + type: string + description: The name of the application or module that caused the anomaly. + nullable: true + assetPublisher: + type: string + description: The publisher of the application or module that caused the anomaly. + nullable: true + assetVersion: + type: string + description: The version of the application or module that caused the anomaly. + nullable: true + detectionModelId: + type: string + description: The unique identifier of the anomaly detection model. + nullable: true + deviceImpactedCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of devices impacted by the anomaly. Valid values -2147483648 to 2147483647 + format: int32 + issueId: + type: string + description: The unique identifier of the anomaly detection model. + nullable: true + severity: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalySeverity' + state: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyState' + additionalProperties: + type: object + description: The user experience analytics anomaly entity contains anomaly details. + microsoft.graph.userExperienceAnalyticsAnomalyDevice: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: userExperienceAnalyticsAnomalyDevice + type: object + properties: + anomalyId: + type: string + description: The unique identifier of the anomaly. + nullable: true + anomalyOnDeviceFirstOccurrenceDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 first occurance date and time for the anomaly on the device. + format: date-time + anomalyOnDeviceLatestOccurrenceDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 latest occurance date and time for the anomaly on the device. + format: date-time + deviceId: + type: string + description: The unique identifier of the device. + nullable: true + deviceManufacturer: + type: string + description: The manufacturer name of the device. + nullable: true + deviceModel: + type: string + description: The model name of the device. + nullable: true + deviceName: + type: string + description: The name of the device. + nullable: true + osName: + type: string + description: The name of the OS installed on the device. + nullable: true + osVersion: + type: string + description: The OS version installed on the device. + nullable: true + additionalProperties: + type: object + description: The user experience analytics anomaly entity contains device details. microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformance: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -52691,17 +53327,17 @@ components: properties: averageBlueScreens: type: number - description: Average (mean) number of Blue Screens per device in the last 14 days. Valid values 0 to 9999999 + description: Average (mean) number of Blue Screens per device in the last 30 days. Valid values 0 to 9999999 format: double averageRestarts: type: number - description: Average (mean) number of Restarts per device in the last 14 days. Valid values 0 to 9999999 + description: Average (mean) number of Restarts per device in the last 30 days. Valid values 0 to 9999999 format: double blueScreenCount: maximum: 2147483647 minimum: -2147483648 type: integer - description: Number of Blue Screens in the last 14 days. Valid values 0 to 9999999 + description: Number of Blue Screens in the last 30 days. Valid values 0 to 9999999 format: int32 bootScore: maximum: 2147483647 @@ -52777,7 +53413,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer - description: Number of Restarts in the last 14 days. Valid values 0 to 9999999 + description: Number of Restarts in the last 30 days. Valid values 0 to 9999999 format: int32 startupPerformanceScore: type: number @@ -53739,6 +54375,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.deviceManagementSettings: @@ -53874,6 +54511,9 @@ components: showAzureADEnterpriseApps: type: boolean description: Boolean that indicates if AzureAD Enterprise Apps will be shown in Company Portal + showConfigurationManagerApps: + type: boolean + description: Boolean that indicates if ConfigurationManagerApps will be shown in Company Portal showDisplayNameNextToLogo: type: boolean description: Boolean that represents whether the administrator-supplied display name will be shown next to the logo image. @@ -54069,6 +54709,43 @@ components: - value: lockedOut description: LockedOut name: lockedOut + microsoft.graph.userExperienceAnalyticsAnomalySeverityOverview: + title: userExperienceAnalyticsAnomalySeverityOverview + type: object + properties: + highSeverityAnomalyCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of high severity anomalies which have been detected. Valid values -2147483648 to 2147483647 + format: int32 + informationalSeverityAnomalyCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of informational severity anomalies which have been detected. Valid values -2147483648 to 2147483647 + format: int32 + lowSeverityAnomalyCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of low severity anomalies which have been detected. Valid values -2147483648 to 2147483647 + format: int32 + mediumSeverityAnomalyCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of medium severity anomalies which have been detected. Valid values -2147483648 to 2147483647 + format: int32 + otherSeverityAnomalyCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of anomalies which have been detected with undefined severity. Valid values -2147483648 to 2147483647 + format: int32 + additionalProperties: + type: object + description: The user experience analytics anomaly severity overview entity contains the count information for each severity of anomaly. microsoft.graph.userExperienceAnalyticsSettings: title: userExperienceAnalyticsSettings type: object @@ -54202,6 +54879,8 @@ components: $ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningPolicy' description: Cloud PC provisioning policy. x-ms-navigationProperty: true + reports: + $ref: '#/components/schemas/microsoft.graph.cloudPcReports' servicePlans: type: array items: @@ -56528,6 +57207,9 @@ components: allowSessionsToUnenrolledDevices: type: boolean description: Indicates if sessions to unenrolled devices are allowed for the account. This setting is configurable by the admin. Default value is false. + blockChat: + type: boolean + description: Indicates if sessions to block chat function. This setting is configurable by the admin. Default value is false. remoteAssistanceState: $ref: '#/components/schemas/microsoft.graph.remoteAssistanceState' additionalProperties: @@ -57422,6 +58104,25 @@ components: additionalProperties: type: object description: Single configuration item inside an Android application's custom configuration schema. + microsoft.graph.payloadByFilter: + title: payloadByFilter + type: object + properties: + assignmentFilterType: + $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentFilterType' + groupId: + type: string + description: The Azure AD security group ID + nullable: true + payloadId: + type: string + description: The policy identifier + nullable: true + payloadType: + $ref: '#/components/schemas/microsoft.graph.associatedAssignmentPayloadType' + additionalProperties: + type: object + description: This entity represents a single payload with requested assignment filter Id microsoft.graph.devicePlatformType: title: devicePlatformType enum: @@ -60433,6 +61134,11 @@ components: - value: template description: Visible to template name: template + microsoft.graph.deviceManagementPriorityMetaData: + title: deviceManagementPriorityMetaData + type: object + additionalProperties: + type: object microsoft.graph.deviceManagementConfigurationPolicyTemplateReference: title: deviceManagementConfigurationPolicyTemplateReference type: object @@ -60500,6 +61206,7 @@ components: - endpointSecurityAttackSurfaceReduction - endpointSecurityAccountProtection - endpointSecurityApplicationControl + - enrollmentConfiguration - baseline type: string description: Describes the TemplateFamily for the Template entity @@ -60531,6 +61238,9 @@ components: - value: endpointSecurityApplicationControl description: Template Family for ApplicationControl that helps mitigate security threats by restricting the applications that users can run and the code that runs in the System Core (kernel) name: endpointSecurityApplicationControl + - value: enrollmentConfiguration + description: Template Family for EnrollmentConfiguration + name: enrollmentConfiguration - value: baseline description: Template Family for Baseline name: baseline @@ -61475,21 +62185,25 @@ components: - pending - completed - failed + - unknownFutureValue type: string - description: Enum type that represent the status of log collection. + description: Enum type that represent the status of log collection x-ms-enum: name: microsoftTunnelLogCollectionStatus modelAsString: false values: - value: pending - description: Log collection is in progress + description: Indicates that the log collection is in progress name: pending - value: completed - description: Log collection is completed + description: Indicates that the log collection is completed name: completed - value: failed - description: Log collection has failed + description: Indicates that the log collection has failed name: failed + - value: unknownFutureValue + description: Placeholder value for future expansion enums + name: unknownFutureValue microsoft.graph.microsoftTunnelServerHealthStatus: title: microsoftTunnelServerHealthStatus enum: @@ -61500,6 +62214,7 @@ components: - offline - upgradeInProgress - upgradeFailed + - unknownFutureValue type: string description: Enum of possible MicrosoftTunnelServer health status types x-ms-enum: @@ -61507,26 +62222,29 @@ components: modelAsString: false values: - value: unknown - description: The state is unknown + description: 'Indicates that the health status of the server is unknown. This occurs when no health status has been reported, for example when the server is initialized, but has not yet been evaluated for its health.' name: unknown - value: healthy - description: The state is healthy + description: Indicates that the health status of the server is healthy. This should be the normal operational health status. name: healthy - value: unhealthy - description: The state is unhealthy + description: 'Indicates that the health status of the server is unhealthy. This is normally a transient condition that will last up to 5 minutes. If the server cannot be remediated while reporting unhealthy state, the health state will change to ''warning''. If it can be remediated, the health state will return to ''healthy''.' name: unhealthy - value: warning - description: The state is warning + description: 'Indicates a warning based on the Tunnel Gateway server''s CPU usage, memory usage, latency, TLS certificate, version' name: warning - value: offline - description: The state is offline + description: Indicates the server state is offline name: offline - value: upgradeInProgress - description: The state is upgradeInProgress + description: 'Indicates the upgrade in progress during the upgrade cycle of when Intune begins upgrading servers, one server at a time' name: upgradeInProgress - value: upgradeFailed - description: The state is upgradeFailed + description: 'Indicates the failure of the upgrade during the upgrade cycle of when Intune begins upgrading servers, one server at a time' name: upgradeFailed + - value: unknownFutureValue + description: Evolvable enumeration sentinel value. Do not use enums. + name: unknownFutureValue microsoft.graph.mobileAppTroubleshootingHistoryItem: title: mobileAppTroubleshootingHistoryItem type: object @@ -61622,6 +62340,10 @@ components: - getFileVaultKey - setDeviceName - activateDeviceEsim + - deprovision + - disable + - reenable + - moveDeviceToOrganizationalUnit type: string description: Remote actions Intune supports. x-ms-enum: @@ -61629,77 +62351,89 @@ components: modelAsString: false values: - value: unknown - description: User initiates an unknown action. + description: Indicate user initiates an unknown action. name: unknown - value: factoryReset - description: 'User initiates an action to factory reset a device. ' + description: 'Indicate user initiates an action to factory reset a device. ' name: factoryReset - value: removeCompanyData - description: 'User initiates an action to remove company data from a device. ' + description: 'Indicate user initiates an action to remove company data from a device. ' name: removeCompanyData - value: resetPasscode - description: 'User initiates an action to remove the passcode of an iOS device, or reset the passcode of Android / Windows device. ' + description: 'Indicate user initiates an action to remove the passcode of an iOS device, or reset the passcode of Android / Windows device. ' name: resetPasscode - value: remoteLock - description: User initiates an action to remote lock a device. + description: Indicate user initiates an action to remote lock a device. name: remoteLock - value: enableLostMode - description: User initiates an action to enable lost mode on a supervised iOS device. + description: Indicate user initiates an action to enable lost mode on a supervised iOS device. name: enableLostMode - value: disableLostMode - description: User initiates an action to disable lost mode on a supervised iOS device. + description: Indicate user initiates an action to disable lost mode on a supervised iOS device. name: disableLostMode - value: locateDevice - description: User initiates an action to locate a supervised iOS device. + description: Indicate user initiates an action to locate a supervised iOS device. name: locateDevice - value: rebootNow - description: User initiates an action to reboot a Windows device. + description: Indicate user initiates an action to reboot the device. name: rebootNow - value: recoverPasscode - description: User initiates an action to reset the pin for passport for work on windows phone device. + description: Indicate user initiates an action to reset the pin for passport for work on windows phone device. name: recoverPasscode - value: cleanWindowsDevice - description: User initiates an action to clean up windows device. + description: Indicate user initiates an action to clean up windows device. name: cleanWindowsDevice - value: logoutSharedAppleDeviceActiveUser - description: User initiates an action to log out current user on shared apple device. + description: Indicate user initiates an action to log out current user on shared apple device. name: logoutSharedAppleDeviceActiveUser - value: quickScan - description: User initiates an action to run quick scan on device. + description: Indicate user initiates an action to run quick scan on device. name: quickScan - value: fullScan - description: User initiates an action to run full scan on device. + description: Indicate user initiates an action to run full scan on device. name: fullScan - value: windowsDefenderUpdateSignatures - description: User initiates an action to update malware signatures on device. + description: Indicate user initiates an action to update malware signatures on device. name: windowsDefenderUpdateSignatures - value: factoryResetKeepEnrollmentData - description: User initiates an action remote wipe device with keeping enrollment data. + description: Indicate user initiates an action remote wipe device with keeping enrollment data. name: factoryResetKeepEnrollmentData - value: updateDeviceAccount - description: User initiates an action to update account on device. + description: Indicate user initiates an action to update account on device. name: updateDeviceAccount - value: automaticRedeployment - description: User initiates an action to automatice redeploy the device + description: Indicate user initiates an action to automatic redeploy the device name: automaticRedeployment - value: shutDown - description: User initiates an action to shut down the device. + description: Indicate user initiates an action to shut down the device. name: shutDown - value: rotateBitLockerKeys - description: User initiates an action to Rotate BitLockerKeys on the device. + description: Indicate user initiates an action to Rotate BitLockerKeys on the device. name: rotateBitLockerKeys - value: rotateFileVaultKey - description: User initiates an action to Rotate FileVaultKey on mac. + description: Indicate user initiates an action to Rotate FileVaultKey on mac. name: rotateFileVaultKey - value: getFileVaultKey - description: User initiates an action to Get FileVaultKey on mac. + description: Indicate user initiates an action to Get FileVaultKey on mac. name: getFileVaultKey - value: setDeviceName - description: User initiates an action to Set Device Name on the device. + description: Indicate user initiates an action to Set Device Name on the device. name: setDeviceName - value: activateDeviceEsim - description: User initiates an action to Activate eSIM on the device. + description: Indicate user initiates an action to Activate eSIM on the device. name: activateDeviceEsim + - value: deprovision + description: Indicate user initiates an action to deprovision the device. + name: deprovision + - value: disable + description: Indicate user initiates an action to disable the device. + name: disable + - value: reenable + description: Indicate user initiates an action to reenable the device. + name: reenable + - value: moveDeviceToOrganizationalUnit + description: Indicate user initiates an action to move the device to a new organizational unit. + name: moveDeviceToOrganizationalUnit microsoft.graph.actionState: title: actionState enum: @@ -61862,6 +62596,105 @@ components: additionalProperties: type: object description: Object containing detailed information about the error and its remediation. + microsoft.graph.userExperienceAnalyticsAnomalyType: + title: userExperienceAnalyticsAnomalyType + enum: + - device + - application + - stopError + - driver + - other + - unknownFutureValue + type: string + description: 'Indicates the category of the anomaly. Eg: anomaly type can be device, application, stop error, driver or other.' + x-ms-enum: + name: userExperienceAnalyticsAnomalyType + modelAsString: false + values: + - value: device + description: Indicates the detected anomaly is due to certain devices. + name: device + - value: application + description: Indicates the detected anomaly is due to a specific application. + name: application + - value: stopError + description: Indicates the detected anomaly is due to a specific stop error. + name: stopError + - value: driver + description: Indicates the detected anomaly is due to a specific driver. + name: driver + - value: other + description: Indicates the category of detected anomaly is undefined. + name: other + - value: unknownFutureValue + description: Evolvable enumeration sentinel value. Do not use. + name: unknownFutureValue + microsoft.graph.userExperienceAnalyticsAnomalySeverity: + title: userExperienceAnalyticsAnomalySeverity + enum: + - high + - medium + - low + - informational + - other + - unknownFutureValue + type: string + description: 'Indicates the severity of the anomaly. Eg: anomaly severity can be high, medium, low, informational or other.' + x-ms-enum: + name: userExperienceAnalyticsAnomalySeverity + modelAsString: false + values: + - value: high + description: Indicates the anomaly is of high severity. + name: high + - value: medium + description: Indicates the anomaly is of medium severity. + name: medium + - value: low + description: Indicates the anomaly is of low severity. + name: low + - value: informational + description: Indicates the anomaly is of informational severity. + name: informational + - value: other + description: Indicates the severity of anomaly is undefined. + name: other + - value: unknownFutureValue + description: Evolvable enumeration sentinel value. Do not use. + name: unknownFutureValue + microsoft.graph.userExperienceAnalyticsAnomalyState: + title: userExperienceAnalyticsAnomalyState + enum: + - new + - active + - disabled + - removed + - other + - unknownFutureValue + type: string + description: 'Indicates the state of the anomaly. Eg: anomaly severity can be new, active, disabled, removed or other.' + x-ms-enum: + name: userExperienceAnalyticsAnomalyState + modelAsString: false + values: + - value: new + description: Indicates the state of anomaly is new. + name: new + - value: active + description: Indicates the state of anomaly is active. + name: active + - value: disabled + description: Indicates the state of anomaly is disabled. + name: disabled + - value: removed + description: Indicates the state of anomaly is removed. + name: removed + - value: other + description: Indicates the state of anomaly is undefined. + name: other + - value: unknownFutureValue + description: Evolvable enumeration sentinel value. Do not use. + name: unknownFutureValue microsoft.graph.userExperienceAnalyticsHealthState: title: userExperienceAnalyticsHealthState enum: @@ -63209,6 +64042,32 @@ components: nullable: true additionalProperties: type: object + microsoft.graph.userExperienceAnalyticsAnomalyCollectionResponse: + title: Collection of userExperienceAnalyticsAnomaly + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomaly' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.userExperienceAnalyticsAnomalyDeviceCollectionResponse: + title: Collection of userExperienceAnalyticsAnomalyDevice + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDevice' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformanceCollectionResponse: title: Collection of userExperienceAnalyticsAppHealthApplicationPerformance type: object @@ -64458,6 +65317,19 @@ components: x-ms-navigationProperty: true additionalProperties: type: object + microsoft.graph.cloudPcReports: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: cloudPcReports + type: object + properties: + exportJobs: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJob' + x-ms-navigationProperty: true + additionalProperties: + type: object microsoft.graph.cloudPcServicePlan: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -66039,6 +66911,10 @@ components: description: 'Date and time in the device time zone when the download will start (e.g., 2018-07-25T10:20:32). The default value is UTC now and the maximum is 10 days from deployment creation.' format: date-time nullable: true + firmwareTargetArtifactDescription: + type: string + description: 'A description provided by Zebra for the the firmware artifact to update the device to (e.g.: LifeGuard Update 120 (released 29-June-2022).' + nullable: true firmwareTargetBoardSupportPackageVersion: type: string description: 'Deployment''s Board Support Package (BSP. E.g.: ''01.18.02.00''). Required only for custom update type.' @@ -67168,6 +68044,84 @@ components: - hidden type: string description: Data type for a configuration item inside an Android application's custom configuration schema + microsoft.graph.deviceAndAppManagementAssignmentFilterType: + title: deviceAndAppManagementAssignmentFilterType + enum: + - none + - include + - exclude + type: string + description: Represents type of the assignment filter. + x-ms-enum: + name: deviceAndAppManagementAssignmentFilterType + modelAsString: false + values: + - value: none + description: Default value. Do not use. + name: none + - value: include + description: 'Indicates in-filter, rule matching will offer the payload to devices.' + name: include + - value: exclude + description: 'Indicates out-filter, rule matching will not offer the payload to devices.' + name: exclude + microsoft.graph.associatedAssignmentPayloadType: + title: associatedAssignmentPayloadType + enum: + - unknown + - deviceConfigurationAndCompliance + - application + - androidEnterpriseApp + - enrollmentConfiguration + - groupPolicyConfiguration + - zeroTouchDeploymentDeviceConfigProfile + - androidEnterpriseConfiguration + - deviceFirmwareConfigurationInterfacePolicy + - resourceAccessPolicy + - win32app + - deviceManagmentConfigurationAndCompliancePolicy + type: string + description: This enum represents associated assignment payload type + x-ms-enum: + name: associatedAssignmentPayloadType + modelAsString: false + values: + - value: unknown + description: Invalid payload type + name: unknown + - value: deviceConfigurationAndCompliance + description: Indicates that this filter is associated with a configuration or compliance policy payload type + name: deviceConfigurationAndCompliance + - value: application + description: Indicates that this assignment filter is associated with an application payload type + name: application + - value: androidEnterpriseApp + description: Indicates that this filter is associated with a Android Enterprise application payload type + name: androidEnterpriseApp + - value: enrollmentConfiguration + description: Indicates that this filter is associated with an enrollment restriction or enrollment status page policy payload type + name: enrollmentConfiguration + - value: groupPolicyConfiguration + description: Indicates that this filter is associated with an Administrative Template policy payload type + name: groupPolicyConfiguration + - value: zeroTouchDeploymentDeviceConfigProfile + description: Indicates that this assignment filter is associated with Zero touch deployment Device Configuration Profile payload type + name: zeroTouchDeploymentDeviceConfigProfile + - value: androidEnterpriseConfiguration + description: Indicates that this filter is associated with an Android Enterprise Configuration policy payload type + name: androidEnterpriseConfiguration + - value: deviceFirmwareConfigurationInterfacePolicy + description: Indicates that this assignment filter is associated with Device Firmware Configuration Interface(DCFI) payload type + name: deviceFirmwareConfigurationInterfacePolicy + - value: resourceAccessPolicy + description: 'Indicates that this filter is associated with a resource access policy (Wifi, VPN, Certificate) payload type' + name: resourceAccessPolicy + - value: win32app + description: Indicates that this filter is associated with a Win32 app payload type + name: win32app + - value: deviceManagmentConfigurationAndCompliancePolicy + description: Indicates that this filter is associated with a configuration or compliance policy on Device Configuration v2 Infrastructure payload type + name: deviceManagmentConfigurationAndCompliancePolicy microsoft.graph.cloudPcStatusDetails: title: cloudPcStatusDetails type: object @@ -67953,6 +68907,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -68188,7 +69143,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -70929,27 +71884,6 @@ components: - deviceConfiguration - deviceIntent type: string - microsoft.graph.deviceAndAppManagementAssignmentFilterType: - title: deviceAndAppManagementAssignmentFilterType - enum: - - none - - include - - exclude - type: string - description: Represents type of the assignment filter. - x-ms-enum: - name: deviceAndAppManagementAssignmentFilterType - modelAsString: false - values: - - value: none - description: Default value. Do not use. - name: none - - value: include - description: 'Indicates in-filter, rule matching will offer the payload to devices.' - name: include - - value: exclude - description: 'Indicates out-filter, rule matching will not offer the payload to devices.' - name: exclude microsoft.graph.deviceManagementConfigurationSettingInstanceTemplateReference: title: deviceManagementConfigurationSettingInstanceTemplateReference type: object @@ -71551,6 +72485,42 @@ components: $ref: '#/components/schemas/microsoft.graph.cloudPcManagementAssignmentTarget' additionalProperties: type: object + microsoft.graph.cloudPcExportJob: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: cloudPcExportJob + 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 + format: date-time + nullable: true + exportJobStatus: + $ref: '#/components/schemas/microsoft.graph.cloudPcExportJobStatus' + exportUrl: + type: string + nullable: true + filter: + type: string + nullable: true + format: + type: string + nullable: true + reportName: + $ref: '#/components/schemas/microsoft.graph.cloudPcReportName' + requestDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 + select: + type: array + items: + type: string + nullable: true + additionalProperties: + type: object microsoft.graph.cloudPcSnapshotStatus: title: cloudPcSnapshotStatus enum: @@ -75777,6 +76747,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -78013,6 +78984,22 @@ components: type: object additionalProperties: type: object + microsoft.graph.cloudPcExportJobStatus: + title: cloudPcExportJobStatus + enum: + - notStarted + - inProgress + - completed + - unknownFutureValue + type: string + microsoft.graph.cloudPcReportName: + title: cloudPcReportName + enum: + - remoteConnectionHistoricalReports + - dailyAggregatedRemoteConnectionReports + - totalAggregatedRemoteConnectionReports + - unknownFutureValue + type: string microsoft.graph.organizationalMessageLogoType: title: organizationalMessageLogoType enum: @@ -84106,6 +85093,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions @@ -88221,6 +89209,18 @@ components: application/json: schema: $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEventCollectionResponse' + microsoft.graph.userExperienceAnalyticsAnomalyCollectionResponse: + description: Retrieved collection + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyCollectionResponse' + microsoft.graph.userExperienceAnalyticsAnomalyDeviceCollectionResponse: + description: Retrieved collection + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.userExperienceAnalyticsAnomalyDeviceCollectionResponse' microsoft.graph.userExperienceAnalyticsAppHealthApplicationPerformanceCollectionResponse: description: Retrieved collection content: diff --git a/openApiDocs/beta/Devices.CloudPrint.yml b/openApiDocs/beta/Devices.CloudPrint.yml index c31314b5ab6..585b12820e0 100644 --- a/openApiDocs/beta/Devices.CloudPrint.yml +++ b/openApiDocs/beta/Devices.CloudPrint.yml @@ -14478,7 +14478,7 @@ components: latestSimulationDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 latest attack simulation and training campaign that the user was included in. + description: Date and time of the latest attack simulation and training campaign that the user was included in. format: date-time nullable: true simulationCount: @@ -14500,7 +14500,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.userTrainingStatusInfo' - description: List of assigned trainings' and their statuses for the user. + description: List of assigned trainings and their statuses for the user. additionalProperties: type: object microsoft.graph.applicationSignInSummary: @@ -15312,6 +15312,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.deviceHealth: @@ -16790,7 +16791,7 @@ components: nullable: true userId: type: string - description: This is the id property value of the user resource that represents the user in the Azure AD tenant. + description: This is the id property value of the user resource that represents the user in the Azure Active Directory tenant. nullable: true additionalProperties: type: object @@ -18857,6 +18858,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -19049,7 +19051,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -27773,6 +27775,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -35315,6 +35318,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Devices.CorporateManagement.yml b/openApiDocs/beta/Devices.CorporateManagement.yml index cdb706e814c..291de2da26c 100644 --- a/openApiDocs/beta/Devices.CorporateManagement.yml +++ b/openApiDocs/beta/Devices.CorporateManagement.yml @@ -276,6 +276,8 @@ paths: - minimumWipeAppVersion desc - minimumWipeOsVersion - minimumWipeOsVersion desc + - mobileThreatDefensePartnerPriority + - mobileThreatDefensePartnerPriority desc - mobileThreatDefenseRemediationAction - mobileThreatDefenseRemediationAction desc - notificationRestriction @@ -437,6 +439,7 @@ paths: - minimumWarningOsVersion - minimumWipeAppVersion - minimumWipeOsVersion + - mobileThreatDefensePartnerPriority - mobileThreatDefenseRemediationAction - notificationRestriction - organizationalCredentialsRequired @@ -607,6 +610,7 @@ paths: - minimumWarningOsVersion - minimumWipeAppVersion - minimumWipeOsVersion + - mobileThreatDefensePartnerPriority - mobileThreatDefenseRemediationAction - notificationRestriction - organizationalCredentialsRequired @@ -1239,6 +1243,8 @@ paths: - minimumWipeAppVersion desc - minimumWipeOsVersion - minimumWipeOsVersion desc + - mobileThreatDefensePartnerPriority + - mobileThreatDefensePartnerPriority desc - mobileThreatDefenseRemediationAction - mobileThreatDefenseRemediationAction desc - notificationRestriction @@ -1418,6 +1424,7 @@ paths: - minimumWarningOsVersion - minimumWipeAppVersion - minimumWipeOsVersion + - mobileThreatDefensePartnerPriority - mobileThreatDefenseRemediationAction - notificationRestriction - organizationalCredentialsRequired @@ -1595,6 +1602,7 @@ paths: - minimumWarningOsVersion - minimumWipeAppVersion - minimumWipeOsVersion + - mobileThreatDefensePartnerPriority - mobileThreatDefenseRemediationAction - notificationRestriction - organizationalCredentialsRequired @@ -3964,6 +3972,8 @@ paths: - minimumWipeAppVersion desc - minimumWipeOsVersion - minimumWipeOsVersion desc + - mobileThreatDefensePartnerPriority + - mobileThreatDefensePartnerPriority desc - mobileThreatDefenseRemediationAction - mobileThreatDefenseRemediationAction desc - notificationRestriction @@ -4079,6 +4089,7 @@ paths: - minimumWarningOsVersion - minimumWipeAppVersion - minimumWipeOsVersion + - mobileThreatDefensePartnerPriority - mobileThreatDefenseRemediationAction - notificationRestriction - organizationalCredentialsRequired @@ -4226,6 +4237,7 @@ paths: - minimumWarningOsVersion - minimumWipeAppVersion - minimumWipeOsVersion + - mobileThreatDefensePartnerPriority - mobileThreatDefenseRemediationAction - notificationRestriction - organizationalCredentialsRequired @@ -19980,6 +19992,8 @@ paths: operationId: users.user.managedDevices.managedDevice.disableLostMode enableLostMode: operationId: users.user.managedDevices.managedDevice.enableLostMode + enrollNowAction: + operationId: users.user.managedDevices.managedDevice.enrollNowAction getCloudPcRemoteActionResults: operationId: users.user.managedDevices.managedDevice.getCloudPcRemoteActionResults getCloudPcReviewStatus: @@ -28207,6 +28221,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.microsoftStoreForBusinessPortalSelectionOptions: @@ -28494,6 +28509,8 @@ components: type: string description: Versions less than or equal to the specified version will wipe the managed app and the associated company data. nullable: true + mobileThreatDefensePartnerPriority: + $ref: '#/components/schemas/microsoft.graph.mobileThreatDefensePartnerPriority' mobileThreatDefenseRemediationAction: $ref: '#/components/schemas/microsoft.graph.managedAppRemediationAction' notificationRestriction: @@ -33186,6 +33203,9 @@ components: - unmanaged - mdm - androidEnterprise + - androidEnterpriseDedicatedDevicesWithAzureAdSharedMode + - androidOpenSourceProjectUserAssociated + - androidOpenSourceProjectUserless type: string description: Management levels for apps x-ms-enum: @@ -33204,6 +33224,15 @@ components: - value: androidEnterprise description: Android Enterprise name: androidEnterprise + - value: androidEnterpriseDedicatedDevicesWithAzureAdSharedMode + description: Android Enterprise dedicated devices with Azure AD Shared mode + name: androidEnterpriseDedicatedDevicesWithAzureAdSharedMode + - value: androidOpenSourceProjectUserAssociated + description: Android Open Source Project (AOSP) devices + name: androidOpenSourceProjectUserAssociated + - value: androidOpenSourceProjectUserless + description: Android Open Source Project (AOSP) userless devices + name: androidOpenSourceProjectUserless microsoft.graph.managedAppDataIngestionLocation: title: managedAppDataIngestionLocation enum: @@ -33346,6 +33375,27 @@ components: - value: microsoftEdge description: Microsoft Edge name: microsoftEdge + microsoft.graph.mobileThreatDefensePartnerPriority: + title: mobileThreatDefensePartnerPriority + enum: + - defenderOverThirdPartyPartner + - thirdPartyPartnerOverDefender + - unknownFutureValue + type: string + description: 'Determines the conflict resolution strategy, when more than one Mobile Threat Defense provider is enabled.' + x-ms-enum: + name: mobileThreatDefensePartnerPriority + modelAsString: false + values: + - value: defenderOverThirdPartyPartner + description: Indicates use of Microsoft Defender Endpoint over 3rd party MTD connectors + name: defenderOverThirdPartyPartner + - value: thirdPartyPartnerOverDefender + description: Indicates use of a 3rd party MTD connector over Microsoft Defender Endpoint + name: thirdPartyPartnerOverDefender + - value: unknownFutureValue + description: Evolvable enumeration sentinel value. Do not use. + name: unknownFutureValue microsoft.graph.managedAppNotificationRestriction: title: managedAppNotificationRestriction enum: @@ -34454,6 +34504,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -34689,7 +34740,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -40611,6 +40662,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -48603,6 +48655,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Devices.ServiceAnnouncement.yml b/openApiDocs/beta/Devices.ServiceAnnouncement.yml index 368bfdb99b4..69d64cbb22e 100644 --- a/openApiDocs/beta/Devices.ServiceAnnouncement.yml +++ b/openApiDocs/beta/Devices.ServiceAnnouncement.yml @@ -3074,6 +3074,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.serviceHealthStatus: diff --git a/openApiDocs/beta/DirectoryObjects.yml b/openApiDocs/beta/DirectoryObjects.yml index c48c7365f20..9952151479e 100644 --- a/openApiDocs/beta/DirectoryObjects.yml +++ b/openApiDocs/beta/DirectoryObjects.yml @@ -598,6 +598,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.directoryObjectCollectionResponse: diff --git a/openApiDocs/beta/Education.yml b/openApiDocs/beta/Education.yml index 873a55deb1b..5d64679d198 100644 --- a/openApiDocs/beta/Education.yml +++ b/openApiDocs/beta/Education.yml @@ -17825,6 +17825,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.educationCourse: @@ -19696,6 +19697,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -19888,7 +19890,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -27841,6 +27843,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -35387,6 +35390,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Files.yml b/openApiDocs/beta/Files.yml index 3d792dab59e..849754e0d7a 100644 --- a/openApiDocs/beta/Files.yml +++ b/openApiDocs/beta/Files.yml @@ -69901,6 +69901,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.itemActionSet: @@ -73558,6 +73559,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -73793,7 +73795,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -81474,6 +81476,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -88991,6 +88994,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Financials.yml b/openApiDocs/beta/Financials.yml index 2069ae50895..68821280030 100644 --- a/openApiDocs/beta/Financials.yml +++ b/openApiDocs/beta/Financials.yml @@ -34344,6 +34344,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.postalAddressType: diff --git a/openApiDocs/beta/Groups.yml b/openApiDocs/beta/Groups.yml index 08e8f4bab60..8c67d46f687 100644 --- a/openApiDocs/beta/Groups.yml +++ b/openApiDocs/beta/Groups.yml @@ -43738,6 +43738,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.assignedLabel: @@ -49986,6 +49987,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -50178,7 +50180,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -53195,6 +53197,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions @@ -56861,6 +56864,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. diff --git a/openApiDocs/beta/Identity.DirectoryManagement.yml b/openApiDocs/beta/Identity.DirectoryManagement.yml index fec4111805a..21d6b53f0ba 100644 --- a/openApiDocs/beta/Identity.DirectoryManagement.yml +++ b/openApiDocs/beta/Identity.DirectoryManagement.yml @@ -17323,7 +17323,11 @@ paths: get: tags: - organization.organizationSettings - summary: Get contactInsights from organization + summary: List contactInsights + description: Get the properties of an insightsSettings object for displaying or returning contact insights in an organization. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/organizationsettings-list-contactinsights?view=graph-rest-1.0 operationId: organization.settings_GetContactInsights parameters: - name: organization-id @@ -17373,7 +17377,11 @@ paths: patch: tags: - organization.organizationSettings - summary: Update the navigation property contactInsights in organization + summary: Update insightsSettings + description: "Update the privacy settings to display or return the specified type of insights in an organization. The type of settings can be contact insights, item insights, or people insights. To learn more about customizing insights privacy for your organization, see:\n- Customize item insights privacy \n- Customize people insights privacy" + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/insightssettings-update?view=graph-rest-1.0 operationId: organization.settings_UpdateContactInsights parameters: - name: organization-id @@ -17482,7 +17490,7 @@ paths: tags: - organization.organizationSettings summary: Update insightsSettings - description: "Update the privacy settings to display or return the specified type of insights in an organization. The type of settings can be item insights or people insights. To learn more about customizing insights privacy for your organization, see:\n- Customize item insights privacy \n- Customize people insights privacy" + description: "Update the privacy settings to display or return the specified type of insights in an organization. The type of settings can be contact insights, item insights, or people insights. To learn more about customizing insights privacy for your organization, see:\n- Customize item insights privacy \n- Customize people insights privacy" externalDocs: description: Find more info here url: https://docs.microsoft.com/graph/api/insightssettings-update?view=graph-rest-1.0 @@ -17706,7 +17714,7 @@ paths: tags: - organization.organizationSettings summary: Update insightsSettings - description: "Update the privacy settings to display or return the specified type of insights in an organization. The type of settings can be item insights or people insights. To learn more about customizing insights privacy for your organization, see:\n- Customize item insights privacy \n- Customize people insights privacy" + description: "Update the privacy settings to display or return the specified type of insights in an organization. The type of settings can be contact insights, item insights, or people insights. To learn more about customizing insights privacy for your organization, see:\n- Customize item insights privacy \n- Customize people insights privacy" externalDocs: description: Find more info here url: https://docs.microsoft.com/graph/api/insightssettings-update?view=graph-rest-1.0 @@ -20057,6 +20065,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.identity: diff --git a/openApiDocs/beta/Identity.Governance.yml b/openApiDocs/beta/Identity.Governance.yml index a7bbb900a3a..e1c64948932 100644 --- a/openApiDocs/beta/Identity.Governance.yml +++ b/openApiDocs/beta/Identity.Governance.yml @@ -63816,7 +63816,7 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Get executionScope from identityGovernance - description: The unique identifier of the Azure AD identity that last modified the workflow object.. + description: The unique identifier of the Azure AD identity that last modified the workflow object. operationId: identityGovernance.lifecycleWorkflows.deletedItems.workflows_ListExecutionScope parameters: - name: workflow-id @@ -64256,7 +64256,7 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Get executionScope from identityGovernance - description: The unique identifier of the Azure AD identity that last modified the workflow object.. + description: The unique identifier of the Azure AD identity that last modified the workflow object. operationId: identityGovernance.lifecycleWorkflows.deletedItems.workflows_GetExecutionScope parameters: - name: workflow-id @@ -64851,7 +64851,7 @@ paths: tags: - identityGovernance.Actions summary: Invoke action activate - description: Activate (run on-demand) a workflow object. + description: 'Run a workflow object on-demand. You can run any workflow on-demand, including scheduled workflows. Workflows created from the ''Real-time employee termination'' template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions.' externalDocs: description: Find more info here url: https://docs.microsoft.com/graph/api/identitygovernance-workflow-activate?view=graph-rest-1.0 @@ -72910,7 +72910,7 @@ paths: get: tags: - identityGovernance.lifecycleWorkflowsContainer - summary: List workflows (lifecycle workflows) + summary: List workflows (in Lifecycle Workflows) description: Get the workflow resources from the workflows navigation property. externalDocs: description: Find more info here @@ -73021,7 +73021,7 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Create workflow (lifecycle workflow) - description: Create a new workflow object. + description: Create a new workflow object. You can create up to 50 workflows in a tenant. externalDocs: description: Find more info here url: https://docs.microsoft.com/graph/api/identitygovernance-lifecycleworkflowscontainer-post-workflows?view=graph-rest-1.0 @@ -73217,7 +73217,7 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Get executionScope from identityGovernance - description: The unique identifier of the Azure AD identity that last modified the workflow object.. + description: The unique identifier of the Azure AD identity that last modified the workflow object. operationId: identityGovernance.lifecycleWorkflows.workflows_ListExecutionScope parameters: - name: workflow-id @@ -73657,7 +73657,7 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Get executionScope from identityGovernance - description: The unique identifier of the Azure AD identity that last modified the workflow object.. + description: The unique identifier of the Azure AD identity that last modified the workflow object. operationId: identityGovernance.lifecycleWorkflows.workflows_GetExecutionScope parameters: - name: workflow-id @@ -74252,7 +74252,7 @@ paths: tags: - identityGovernance.Actions summary: Invoke action activate - description: Activate (run on-demand) a workflow object. + description: 'Run a workflow object on-demand. You can run any workflow on-demand, including scheduled workflows. Workflows created from the ''Real-time employee termination'' template are run on-demand only. When you run a workflow on demand, the tasks are executed regardless of whether the user state matches the scope and trigger execution conditions.' externalDocs: description: Find more info here url: https://docs.microsoft.com/graph/api/identitygovernance-workflow-activate?view=graph-rest-1.0 @@ -101034,7 +101034,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.user' - description: The unique identifier of the Azure AD identity that last modified the workflow object.. + description: The unique identifier of the Azure AD identity that last modified the workflow object. x-ms-navigationProperty: true runs: type: array @@ -101197,7 +101197,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.keyValuePair' - description: Arguments included within the task. + description: 'Arguments included within the task. For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks.' category: $ref: '#/components/schemas/microsoft.graph.identityGovernance.lifecycleTaskCategory' continueOnError: @@ -101448,12 +101448,12 @@ components: nullable: true displayName: type: string - description: The display name of the taskDefinition. + description: The display name of the taskDefinition`. parameters: type: array items: $ref: '#/components/schemas/microsoft.graph.identityGovernance.parameter' - description: The parameters that must be supplied when creating a task. + description: The parameters that must be supplied when creating a workflow task object. version: maximum: 2147483647 minimum: -2147483648 @@ -101516,7 +101516,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer - description: The interval in hours at which all workflows running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24. + description: The interval in hours at which all workflows running in the tenant should be scheduled for execution. This interval has a minimum value of 1 and a maximum value of 24. The default value is 3 hours. format: int32 additionalProperties: type: object @@ -102294,6 +102294,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.userIdentity: @@ -103915,6 +103916,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -104150,7 +104152,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -112864,6 +112866,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -122046,6 +122049,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Identity.SignIns.yml b/openApiDocs/beta/Identity.SignIns.yml index 77ca6686604..6dc0c97cca1 100644 --- a/openApiDocs/beta/Identity.SignIns.yml +++ b/openApiDocs/beta/Identity.SignIns.yml @@ -4661,6 +4661,7 @@ paths: - authenticationContextClassReferences - namedLocations - policies + - templates type: string - name: $expand in: query @@ -4677,6 +4678,7 @@ paths: - authenticationContextClassReferences - namedLocations - policies + - templates type: string responses: '200': @@ -4694,6 +4696,8 @@ paths: operationId: identity.ConditionalAccess.ListNamedLocations policies: operationId: identity.ConditionalAccess.ListPolicies + templates: + operationId: identity.ConditionalAccess.ListTemplates default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation @@ -6242,6 +6246,204 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation + /identity/conditionalAccess/templates: + get: + tags: + - identity.conditionalAccessRoot + summary: Get templates from identity + operationId: identity.conditionalAccess_ListTemplates + 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 + - description + - description desc + - details + - details desc + - name + - name desc + - scenarios + - scenarios desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - description + - details + - name + - scenarios + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.conditionalAccessTemplateCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identity.conditionalAccessRoot + summary: Create new navigation property to templates for identity + operationId: identity.conditionalAccess_CreateTemplates + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identity/conditionalAccess/templates/{conditionalAccessTemplate-id}': + get: + tags: + - identity.conditionalAccessRoot + summary: Get templates from identity + operationId: identity.conditionalAccess_GetTemplates + parameters: + - name: conditionalAccessTemplate-id + in: path + description: 'key: id of conditionalAccessTemplate' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: conditionalAccessTemplate + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - description + - details + - name + - scenarios + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identity.conditionalAccessRoot + summary: Update the navigation property templates in identity + operationId: identity.conditionalAccess_UpdateTemplates + parameters: + - name: conditionalAccessTemplate-id + in: path + description: 'key: id of conditionalAccessTemplate' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: conditionalAccessTemplate + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identity.conditionalAccessRoot + summary: Delete navigation property templates for identity + operationId: identity.conditionalAccess_DeleteTemplates + parameters: + - name: conditionalAccessTemplate-id + in: path + description: 'key: id of conditionalAccessTemplate' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: conditionalAccessTemplate + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation /identity/continuousAccessEvaluationPolicy: get: tags: @@ -33069,6 +33271,11 @@ components: $ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicy' description: Read-only. Nullable. Returns a collection of the specified Conditional Access policies. x-ms-navigationProperty: true + templates: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate' + x-ms-navigationProperty: true additionalProperties: type: object microsoft.graph.authenticationContextClassReference: @@ -33079,7 +33286,7 @@ components: properties: description: type: string - description: 'A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user-facing admin experiences. For example, a selection UX.' + description: 'A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user facing admin experiences. For example, selection UX.' nullable: true displayName: type: string @@ -33087,7 +33294,7 @@ components: nullable: true isAvailable: type: boolean - description: 'Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it is set to false, it should not be shown in admin UX experiences because the value is not currently available for selection. Supports $filter (eq).' + description: 'Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it is set to false, it should not be shown in selection UX used to tag resources with authentication context class values. It will still be shown in the Conditionall Access policy authoring experience. Supports $filter (eq).' nullable: true additionalProperties: type: object @@ -33288,6 +33495,22 @@ components: $ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicyState' additionalProperties: type: object + microsoft.graph.conditionalAccessTemplate: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: conditionalAccessTemplate + type: object + properties: + description: + type: string + details: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicyDetail' + name: + type: string + scenarios: + $ref: '#/components/schemas/microsoft.graph.templateScenarios' + additionalProperties: + type: object microsoft.graph.continuousAccessEvaluationPolicy: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -34859,7 +35082,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -36397,6 +36620,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object ReferenceNumeric: @@ -36621,6 +36845,29 @@ components: - disabled - enabledForReportingButNotEnforced type: string + microsoft.graph.conditionalAccessPolicyDetail: + title: conditionalAccessPolicyDetail + type: object + properties: + conditions: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessConditionSet' + grantControls: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessGrantControls' + sessionControls: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessSessionControls' + additionalProperties: + type: object + microsoft.graph.templateScenarios: + title: templateScenarios + enum: + - new + - secureFoundation + - zeroTrust + - remoteWork + - protectAdmins + - emergingThreats + - unknownFutureValue + type: string microsoft.graph.customCalloutExtension: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' @@ -37653,6 +37900,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -41537,6 +41785,19 @@ components: nullable: true additionalProperties: type: object + microsoft.graph.conditionalAccessTemplateCollectionResponse: + title: Collection of conditionalAccessTemplate + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplate' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object microsoft.graph.customAuthenticationExtensionCollectionResponse: title: Collection of customAuthenticationExtension type: object @@ -47437,6 +47698,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -56482,6 +56744,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions @@ -60202,6 +60465,12 @@ components: application/json: schema: $ref: '#/components/schemas/microsoft.graph.conditionalAccessPolicyCollectionResponse' + microsoft.graph.conditionalAccessTemplateCollectionResponse: + description: Retrieved collection + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.conditionalAccessTemplateCollectionResponse' microsoft.graph.customAuthenticationExtensionCollectionResponse: description: Retrieved collection content: diff --git a/openApiDocs/beta/Mail.yml b/openApiDocs/beta/Mail.yml index 93e98ceeb6d..35248296d88 100644 --- a/openApiDocs/beta/Mail.yml +++ b/openApiDocs/beta/Mail.yml @@ -9463,6 +9463,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.inferenceClassificationType: diff --git a/openApiDocs/beta/ManagedTenants.yml b/openApiDocs/beta/ManagedTenants.yml index 462f2b2d617..33b975b7630 100644 --- a/openApiDocs/beta/ManagedTenants.yml +++ b/openApiDocs/beta/ManagedTenants.yml @@ -7580,10 +7580,11 @@ components: nullable: true deviceSpecification: type: string + description: The specification of the cloud PC device. Required. Read-only. nullable: true displayName: type: string - description: The display name for the cloud PC. Required. Read-only. + description: The display name of the cloud PC device. Required. Read-only. nullable: true lastRefreshedDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -7593,22 +7594,23 @@ components: nullable: true managedDeviceId: type: string - description: The managed device identifier for the cloud PC. Optional. Read-only. + description: The managed device identifier of the cloud PC device. Optional. Read-only. nullable: true managedDeviceName: type: string - description: The managed device display name for the cloud PC. Optional. Read-only. + description: The managed device display name of the cloud PC device. Optional. Read-only. nullable: true provisioningPolicyId: type: string - description: The provisioning policy identifier for the cloud PC. Required. Read-only. + description: The provisioning policy identifier for the cloud PC device. Required. Read-only. nullable: true servicePlanName: type: string - description: The service plan name for the cloud PC. Required. Read-only. + description: The service plan name of the cloud PC device. Required. Read-only. nullable: true servicePlanType: type: string + description: The service plan type of the cloud PC device. Required. Read-only. nullable: true tenantDisplayName: type: string @@ -7620,7 +7622,7 @@ components: nullable: true userPrincipalName: type: string - description: The user principal name (UPN) of the user assigned to the cloud PC. Required. Read-only. + description: The user principal name (UPN) of the user assigned to the cloud PC device. Required. Read-only. nullable: true additionalProperties: type: object @@ -7737,6 +7739,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer + description: The total number of cloud PC devices that have the Business SKU. Optional. Read-only. format: int32 nullable: true totalCloudPcConnectionStatus: @@ -7757,6 +7760,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer + description: The total number of cloud PC devices that have the Enterprise SKU. Optional. Read-only. format: int32 nullable: true additionalProperties: @@ -8782,6 +8786,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.managedTenants.managementCategory: diff --git a/openApiDocs/beta/Notes.yml b/openApiDocs/beta/Notes.yml index 1576da315b6..8e23cb4ed85 100644 --- a/openApiDocs/beta/Notes.yml +++ b/openApiDocs/beta/Notes.yml @@ -24209,6 +24209,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.onenoteEntityHierarchyModel: diff --git a/openApiDocs/beta/People.yml b/openApiDocs/beta/People.yml index c3ef64027fa..43ea7ac6cdd 100644 --- a/openApiDocs/beta/People.yml +++ b/openApiDocs/beta/People.yml @@ -6483,6 +6483,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -7034,6 +7035,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.settings: diff --git a/openApiDocs/beta/PersonalContacts.yml b/openApiDocs/beta/PersonalContacts.yml index 2aae8bc2b7c..150691ad58b 100644 --- a/openApiDocs/beta/PersonalContacts.yml +++ b/openApiDocs/beta/PersonalContacts.yml @@ -6660,6 +6660,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.outlookItem: diff --git a/openApiDocs/beta/Planner.yml b/openApiDocs/beta/Planner.yml index b3504ae4e5d..3ff5a833f1e 100644 --- a/openApiDocs/beta/Planner.yml +++ b/openApiDocs/beta/Planner.yml @@ -13288,6 +13288,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.plannerPlanContainer: @@ -13594,6 +13595,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.identity: title: identity diff --git a/openApiDocs/beta/Reports.yml b/openApiDocs/beta/Reports.yml index 4c382fc34cc..7a58da64d35 100644 --- a/openApiDocs/beta/Reports.yml +++ b/openApiDocs/beta/Reports.yml @@ -1441,6 +1441,8 @@ paths: operationId: deviceManagement.reports.getHistoricalReport getMalwareSummaryReport: operationId: deviceManagement.reports.getMalwareSummaryReport + getMobileApplicationManagementAppRegistrationSummaryReport: + operationId: deviceManagement.reports.getMobileApplicationManagementAppRegistrationSummaryReport getNoncompliantDevicesAndSettingsReport: operationId: deviceManagement.reports.getNoncompliantDevicesAndSettingsReport getPolicyNonComplianceMetadata: @@ -10631,7 +10633,7 @@ components: latestSimulationDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 latest attack simulation and training campaign that the user was included in. + description: Date and time of the latest attack simulation and training campaign that the user was included in. format: date-time nullable: true simulationCount: @@ -10653,7 +10655,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.userTrainingStatusInfo' - description: List of assigned trainings' and their statuses for the user. + description: List of assigned trainings and their statuses for the user. additionalProperties: type: object microsoft.graph.applicationSignInSummary: @@ -11409,6 +11411,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.keyValue: @@ -12112,7 +12115,7 @@ components: nullable: true userId: type: string - description: This is the id property value of the user resource that represents the user in the Azure AD tenant. + description: This is the id property value of the user resource that represents the user in the Azure Active Directory tenant. nullable: true additionalProperties: type: object diff --git a/openApiDocs/beta/SchemaExtensions.yml b/openApiDocs/beta/SchemaExtensions.yml index e1240b93303..a8d4b97cf12 100644 --- a/openApiDocs/beta/SchemaExtensions.yml +++ b/openApiDocs/beta/SchemaExtensions.yml @@ -264,6 +264,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.extensionSchemaProperty: diff --git a/openApiDocs/beta/Search.yml b/openApiDocs/beta/Search.yml index 162eac266d6..14adc4beafd 100644 --- a/openApiDocs/beta/Search.yml +++ b/openApiDocs/beta/Search.yml @@ -3148,6 +3148,8 @@ components: nullable: true resultTemplateOptions: $ref: '#/components/schemas/microsoft.graph.resultTemplateOption' + sharePointOneDriveOptions: + $ref: '#/components/schemas/microsoft.graph.sharePointOneDriveOptions' size: maximum: 2147483647 minimum: -2147483648 @@ -3247,6 +3249,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.externalConnectors.activitySettings: @@ -3268,6 +3271,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.externalConnectors.displayTemplate' + description: Enables the developer to define the appearance of the content and configure conditions that dictate when the template should be displayed. Maximum of two eDiscovery result templates per connection. additionalProperties: type: object microsoft.graph.externalConnectors.configuration: @@ -3633,6 +3637,14 @@ components: nullable: true additionalProperties: type: object + microsoft.graph.sharePointOneDriveOptions: + title: sharePointOneDriveOptions + type: object + properties: + includeContent: + $ref: '#/components/schemas/microsoft.graph.searchContent' + additionalProperties: + type: object microsoft.graph.sortProperty: title: sortProperty type: object @@ -4007,6 +4019,13 @@ components: description: Contains the actual search terms of the request. additionalProperties: type: object + microsoft.graph.searchContent: + title: searchContent + enum: + - sharedContent + - privateContent + - unknownFutureValue + type: string microsoft.graph.searchAggregation: title: searchAggregation type: object diff --git a/openApiDocs/beta/Security.yml b/openApiDocs/beta/Security.yml index e92e5d0948f..6e8d7a53c9b 100644 --- a/openApiDocs/beta/Security.yml +++ b/openApiDocs/beta/Security.yml @@ -1023,7 +1023,7 @@ paths: tags: - security.attackSimulationRoot summary: Get simulationAutomations from security - description: Represents simulation automations created to run on a tenant. + description: Represents simulation automation created to run on a tenant. operationId: security.attackSimulation_GetSimulationAutomations parameters: - name: simulationAutomation-id @@ -17597,7 +17597,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.simulationAutomation' - description: Represents simulation automations created to run on a tenant. + description: Represents simulation automation created to run on a tenant. x-ms-navigationProperty: true simulations: type: array @@ -17723,7 +17723,7 @@ components: nullable: true isAutomated: type: boolean - description: Flag representing if the attack simulation and training campaign was created from a simulation automation flow. Supports $filter and $orderby. + description: Flag that represents if the attack simulation and training campaign was created from a simulation automation flow. Supports $filter and $orderby. nullable: true lastModifiedBy: $ref: '#/components/schemas/microsoft.graph.emailIdentity' @@ -20378,6 +20378,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.securityProviderStatus: @@ -21173,7 +21174,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.userSimulationDetails' - description: Represents users of a tenant and their online actions in an attack simulation and training campaign. + description: The tenant users and their online actions in an attack simulation and training campaign. additionalProperties: type: object microsoft.graph.simulationStatus: @@ -24480,24 +24481,24 @@ components: attackSimDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string - description: Specifies the date time of the attack simulation. + description: The date and time of the attack simulation. format: date-time nullable: true attackSimDurationTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string - description: Specifies the duration (in time) for the attack simulation + description: The duration (in time) for the attack simulation. format: duration nullable: true attackSimId: 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: Specifies the activity id for the attack simulation. + description: The activity ID for the attack simulation. format: uuid nullable: true attackSimUserId: type: string - description: Specifies the user id of the user who got the attack simulation email + description: The unique identifier for the user who got the attack simulation email. nullable: true additionalProperties: type: object @@ -25425,12 +25426,12 @@ components: nullable: true isCompromised: type: boolean - description: Flag representing if user was compromised in an attack simulation and training campaign. + description: Indicates whether a user was compromised in an attack simulation and training campaign. nullable: true reportedPhishDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-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 user reported delivered payload as phish in the attack simulation and training campaign. + description: Date and time when a user reported the delivered payload as phishing in the attack simulation and training campaign. format: date-time nullable: true simulationEvents: @@ -27987,6 +27988,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -28179,7 +28181,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -30894,7 +30896,7 @@ components: nullable: true potentialScoreImpact: type: number - description: Potential improvement in security score of the tenant from the recommended action. + description: Potential improvement in the tenant security score from the recommended action. format: double nullable: true title: @@ -30979,7 +30981,7 @@ components: nullable: true userId: type: string - description: This is the id property value of the user resource that represents the user in the Azure AD tenant. + description: This is the id property value of the user resource that represents the user in the Azure Active Directory tenant. nullable: true additionalProperties: type: object @@ -36037,6 +36039,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -37803,7 +37806,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: integer - description: Count of occurence of the simulation event in an attack simulation and training campaign. + description: Count of the simulation event occurrence in an attack simulation and training campaign. format: int32 nullable: true eventName: @@ -37870,7 +37873,7 @@ components: nullable: true potentialScoreImpact: type: number - description: Potential improvement in security posture of the tenant after completion of the training by the user. + description: Potential improvement in the tenant security posture after completion of the training by the user. format: double nullable: true additionalProperties: @@ -38445,6 +38448,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Sites.yml b/openApiDocs/beta/Sites.yml index e07659c851f..bc525e16c4a 100644 --- a/openApiDocs/beta/Sites.yml +++ b/openApiDocs/beta/Sites.yml @@ -76296,6 +76296,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.booleanColumn: @@ -79428,6 +79429,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -79663,7 +79665,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -87456,6 +87458,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -94987,6 +94990,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Teams.yml b/openApiDocs/beta/Teams.yml index 1f62a0fa4d9..01084eb251e 100644 --- a/openApiDocs/beta/Teams.yml +++ b/openApiDocs/beta/Teams.yml @@ -66125,6 +66125,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.teamsAppDistributionMethod: @@ -68806,6 +68807,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -68998,7 +69000,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -77571,6 +77573,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -83761,6 +83764,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Users.Actions.yml b/openApiDocs/beta/Users.Actions.yml index b0deeaf1dde..6ba0ea33dd3 100644 --- a/openApiDocs/beta/Users.Actions.yml +++ b/openApiDocs/beta/Users.Actions.yml @@ -28509,6 +28509,36 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action + '/users/{user-id}/managedDevices/{managedDevice-id}/microsoft.graph.enrollNowAction': + post: + tags: + - users.Actions + summary: Invoke action enrollNowAction + description: Trigger comanagement enrollment action on ConfigurationManager client + operationId: users.managedDevices_enrollNowAction + parameters: + - name: user-id + in: path + description: 'key: id of user' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - name: managedDevice-id + in: path + description: 'key: id of managedDevice' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: managedDevice + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action '/users/{user-id}/managedDevices/{managedDevice-id}/microsoft.graph.locateDevice': post: tags: @@ -36626,6 +36656,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.attachmentType: @@ -41721,6 +41752,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -41956,7 +41988,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -49643,6 +49675,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -56304,6 +56337,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Users.Functions.yml b/openApiDocs/beta/Users.Functions.yml index ad229f83f3d..457fd45a0ea 100644 --- a/openApiDocs/beta/Users.Functions.yml +++ b/openApiDocs/beta/Users.Functions.yml @@ -21013,6 +21013,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.Json: @@ -24824,6 +24825,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -25016,7 +25018,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -32128,6 +32130,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -37160,6 +37163,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/Users.yml b/openApiDocs/beta/Users.yml index 971641bb88f..37eccd71c21 100644 --- a/openApiDocs/beta/Users.yml +++ b/openApiDocs/beta/Users.yml @@ -13591,7 +13591,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true startTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -14794,6 +14794,7 @@ components: description: 'The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity''s api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.' publisherName: type: string + description: The name of the Azure AD tenant that published the application. nullable: true replyUrls: type: array @@ -18097,6 +18098,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.servicePlanInfo: @@ -23342,6 +23344,7 @@ components: ageGroup: type: string description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and cannot be changed.' + nullable: true countryCode: type: string description: Contains the two-character country code associated with the users account. @@ -32489,6 +32492,7 @@ components: - group - unknownFutureValue - roster + - project type: string microsoft.graph.plannerCategoryDescriptions: title: plannerCategoryDescriptions diff --git a/openApiDocs/beta/WindowsUpdates.yml b/openApiDocs/beta/WindowsUpdates.yml index afc5513d97d..f592477d678 100644 --- a/openApiDocs/beta/WindowsUpdates.yml +++ b/openApiDocs/beta/WindowsUpdates.yml @@ -3249,6 +3249,7 @@ components: properties: id: type: string + description: The unique identifier for an entity. Read-only. additionalProperties: type: object microsoft.graph.windowsUpdates.deployableContent: diff --git a/openApiDocs/v1.0/Applications.yml b/openApiDocs/v1.0/Applications.yml index acbdc4e8b09..905b6895eba 100644 --- a/openApiDocs/v1.0/Applications.yml +++ b/openApiDocs/v1.0/Applications.yml @@ -8362,7 +8362,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true additionalProperties: type: object @@ -8649,6 +8649,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.stsPolicy: diff --git a/openApiDocs/v1.0/Bookings.yml b/openApiDocs/v1.0/Bookings.yml index 85c11b97aa1..d79808bd486 100644 --- a/openApiDocs/v1.0/Bookings.yml +++ b/openApiDocs/v1.0/Bookings.yml @@ -2790,6 +2790,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.physicalAddress: diff --git a/openApiDocs/v1.0/Calendar.yml b/openApiDocs/v1.0/Calendar.yml index c64ad48ea0f..e3b4947b89b 100644 --- a/openApiDocs/v1.0/Calendar.yml +++ b/openApiDocs/v1.0/Calendar.yml @@ -45251,6 +45251,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.onlineMeetingProviderType: diff --git a/openApiDocs/v1.0/ChangeNotifications.yml b/openApiDocs/v1.0/ChangeNotifications.yml index 310ca21c2d9..7701544b41d 100644 --- a/openApiDocs/v1.0/ChangeNotifications.yml +++ b/openApiDocs/v1.0/ChangeNotifications.yml @@ -289,6 +289,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.subscriptionCollectionResponse: diff --git a/openApiDocs/v1.0/CloudCommunications.yml b/openApiDocs/v1.0/CloudCommunications.yml index de6bc9925ee..46a5a20e202 100644 --- a/openApiDocs/v1.0/CloudCommunications.yml +++ b/openApiDocs/v1.0/CloudCommunications.yml @@ -1428,7 +1428,11 @@ paths: get: tags: - communications.call - summary: Get contentSharingSessions from communications + summary: List contentSharingSessions + description: Retrieve a list of contentSharingSession objects in a call. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/call-list-contentsharingsessions?view=graph-rest-1.0 operationId: communications.calls_ListContentSharingSessions parameters: - name: call-id @@ -1652,6 +1656,10 @@ paths: tags: - communications.Actions summary: Invoke action addLargeGalleryView + description: Add the large gallery view to a call. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/call-addlargegalleryview?view=graph-rest-1.0 operationId: communications.calls_addLargeGalleryView parameters: - name: call-id @@ -5630,6 +5638,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.modality' + description: 'The list of requested modalities. Possible values are: unknown, audio, video, videoBasedScreenSharing, data.' resultInfo: $ref: '#/components/schemas/microsoft.graph.resultInfo' source: @@ -5638,11 +5647,13 @@ components: $ref: '#/components/schemas/microsoft.graph.callState' subject: type: string + description: The subject of the conversation. nullable: true targets: type: array items: $ref: '#/components/schemas/microsoft.graph.invitationParticipantInfo' + description: The targets of the call. Required information for creating peer to peer call. tenantId: type: string nullable: true @@ -6186,6 +6197,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.callRecords.modality: @@ -6267,9 +6279,11 @@ components: properties: hideBotAfterEscalation: type: boolean + description: Indicates whether to hide the app after the call is escalated. nullable: true isContentSharingNotificationEnabled: type: boolean + description: Indicates whether content sharing notifications should be enabled for the call. nullable: true additionalProperties: type: object diff --git a/openApiDocs/v1.0/CrossDeviceExperiences.yml b/openApiDocs/v1.0/CrossDeviceExperiences.yml index c6844764432..94867799023 100644 --- a/openApiDocs/v1.0/CrossDeviceExperiences.yml +++ b/openApiDocs/v1.0/CrossDeviceExperiences.yml @@ -812,6 +812,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.Json: diff --git a/openApiDocs/v1.0/DeviceManagement.Actions.yml b/openApiDocs/v1.0/DeviceManagement.Actions.yml index 6b5a8fbb0a8..327268a5fb5 100644 --- a/openApiDocs/v1.0/DeviceManagement.Actions.yml +++ b/openApiDocs/v1.0/DeviceManagement.Actions.yml @@ -2280,6 +2280,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.deviceAndAppManagementAssignmentTarget: diff --git a/openApiDocs/v1.0/DeviceManagement.Administration.yml b/openApiDocs/v1.0/DeviceManagement.Administration.yml index 0e95f2ed0c5..915b4a817c3 100644 --- a/openApiDocs/v1.0/DeviceManagement.Administration.yml +++ b/openApiDocs/v1.0/DeviceManagement.Administration.yml @@ -3829,6 +3829,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.complianceManagementPartnerAssignment: diff --git a/openApiDocs/v1.0/DeviceManagement.Enrolment.yml b/openApiDocs/v1.0/DeviceManagement.Enrolment.yml index 11e1ef0bcd6..11f1a786595 100644 --- a/openApiDocs/v1.0/DeviceManagement.Enrolment.yml +++ b/openApiDocs/v1.0/DeviceManagement.Enrolment.yml @@ -10361,6 +10361,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.deviceAndAppManagementAssignmentTarget: diff --git a/openApiDocs/v1.0/DeviceManagement.yml b/openApiDocs/v1.0/DeviceManagement.yml index a1b6752d23b..9dd5e37d30b 100644 --- a/openApiDocs/v1.0/DeviceManagement.yml +++ b/openApiDocs/v1.0/DeviceManagement.yml @@ -8895,6 +8895,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.deviceManagementSettings: diff --git a/openApiDocs/v1.0/Devices.CloudPrint.yml b/openApiDocs/v1.0/Devices.CloudPrint.yml index 824c4e71cce..f5f74875633 100644 --- a/openApiDocs/v1.0/Devices.CloudPrint.yml +++ b/openApiDocs/v1.0/Devices.CloudPrint.yml @@ -4214,6 +4214,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.printerLocation: @@ -6813,7 +6814,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true additionalProperties: type: object diff --git a/openApiDocs/v1.0/Devices.CorporateManagement.yml b/openApiDocs/v1.0/Devices.CorporateManagement.yml index bca9ebb35eb..ab66545b65b 100644 --- a/openApiDocs/v1.0/Devices.CorporateManagement.yml +++ b/openApiDocs/v1.0/Devices.CorporateManagement.yml @@ -12326,6 +12326,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.targetedManagedAppProtection: diff --git a/openApiDocs/v1.0/Devices.ServiceAnnouncement.yml b/openApiDocs/v1.0/Devices.ServiceAnnouncement.yml index ed90d74e14a..71aaabc8349 100644 --- a/openApiDocs/v1.0/Devices.ServiceAnnouncement.yml +++ b/openApiDocs/v1.0/Devices.ServiceAnnouncement.yml @@ -1963,6 +1963,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.serviceHealthStatus: diff --git a/openApiDocs/v1.0/DirectoryObjects.yml b/openApiDocs/v1.0/DirectoryObjects.yml index 1bc47255a66..fcbb5e5437f 100644 --- a/openApiDocs/v1.0/DirectoryObjects.yml +++ b/openApiDocs/v1.0/DirectoryObjects.yml @@ -642,6 +642,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.directoryObjectCollectionResponse: diff --git a/openApiDocs/v1.0/Education.yml b/openApiDocs/v1.0/Education.yml index 2d96fd70e38..b5c0c946c24 100644 --- a/openApiDocs/v1.0/Education.yml +++ b/openApiDocs/v1.0/Education.yml @@ -16414,6 +16414,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.educationCourse: @@ -17865,7 +17866,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true additionalProperties: type: object diff --git a/openApiDocs/v1.0/Files.yml b/openApiDocs/v1.0/Files.yml index c2d4f929be3..159eea04f20 100644 --- a/openApiDocs/v1.0/Files.yml +++ b/openApiDocs/v1.0/Files.yml @@ -57458,6 +57458,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.contentTypeInfo: @@ -59967,7 +59968,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true additionalProperties: type: object diff --git a/openApiDocs/v1.0/Groups.yml b/openApiDocs/v1.0/Groups.yml index ca3d6cb133d..b648a980489 100644 --- a/openApiDocs/v1.0/Groups.yml +++ b/openApiDocs/v1.0/Groups.yml @@ -30940,6 +30940,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.assignedLabel: @@ -36496,7 +36497,7 @@ components: description: The id of the resource service principal to which access is authorized. This identifies the API which the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). scope: type: string - description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal.' + description: 'A space-separated list of the claim values for delegated permissions which should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the oauth2PermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.' nullable: true additionalProperties: type: object diff --git a/openApiDocs/v1.0/Identity.DirectoryManagement.yml b/openApiDocs/v1.0/Identity.DirectoryManagement.yml index 50474999363..c37019ecad6 100644 --- a/openApiDocs/v1.0/Identity.DirectoryManagement.yml +++ b/openApiDocs/v1.0/Identity.DirectoryManagement.yml @@ -11420,6 +11420,7 @@ components: properties: id: type: string + description: The unique idenfier for an entity. Read-only. additionalProperties: type: object microsoft.graph.alternativeSecurityId: diff --git a/openApiDocs/v1.0/Identity.Governance.yml b/openApiDocs/v1.0/Identity.Governance.yml index bfcef3105b6..fb8e85a0057 100644 --- a/openApiDocs/v1.0/Identity.Governance.yml +++ b/openApiDocs/v1.0/Identity.Governance.yml @@ -6862,8 +6862,11 @@ paths: - displayName - isHidden - modifiedDateTime + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -6876,8 +6879,11 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': @@ -6946,8 +6952,11 @@ paths: - displayName - isHidden - modifiedDateTime + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -6960,8 +6969,11 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': @@ -6971,6 +6983,10 @@ paths: schema: $ref: '#/components/schemas/microsoft.graph.accessPackage' links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.AccessPackages.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackage-id: $request.path.accessPackage-id assignmentPolicies: operationId: identityGovernance.entitlementManagement.AccessPackages.ListAssignmentPolicies parameters: @@ -6979,6 +6995,14 @@ paths: operationId: identityGovernance.entitlementManagement.AccessPackages.GetCatalog parameters: accessPackage-id: $request.path.accessPackage-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.AccessPackages.ListIncompatibleAccessPackages + parameters: + accessPackage-id: $request.path.accessPackage-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.AccessPackages.ListIncompatibleGroups + parameters: + accessPackage-id: $request.path.accessPackage-id getApplicablePolicyRequirements: operationId: identityGovernance.entitlementManagement.accessPackages.accessPackage.getApplicablePolicyRequirements default: @@ -7037,6 +7061,195 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith': + get: + tags: + - identityGovernance.entitlementManagement + summary: Get accessPackagesIncompatibleWith from identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_ListAccessPackagesIncompatibleGraphWPre + parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - $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 + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - isHidden + - isHidden desc + - modifiedDateTime + - modifiedDateTime desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.accessPackageCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith/{accessPackage-id1}': + get: + tags: + - identityGovernance.entitlementManagement + summary: Get accessPackagesIncompatibleWith from identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_GetAccessPackagesIncompatibleGraphWPre + parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - name: accessPackage-id1 + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.accessPackages.AccessPackagesIncompatibleGraphWPre.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + assignmentPolicies: + operationId: identityGovernance.entitlementManagement.accessPackages.AccessPackagesIncompatibleWith.ListAssignmentPolicies + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + catalog: + operationId: identityGovernance.entitlementManagement.accessPackages.AccessPackagesIncompatibleWith.GetCatalog + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.accessPackages.AccessPackagesIncompatibleWith.ListIncompatibleAccessPackages + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.accessPackages.AccessPackagesIncompatibleWith.ListIncompatibleGroups + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/assignmentPolicies': get: tags: @@ -7363,8 +7576,11 @@ paths: - displayName - isHidden - modifiedDateTime + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -7377,8 +7593,11 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': @@ -7388,6 +7607,11 @@ paths: schema: $ref: '#/components/schemas/microsoft.graph.accessPackage' links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.accessPackages.assignmentPolicies.AccessPackage.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id assignmentPolicies: operationId: identityGovernance.entitlementManagement.accessPackages.assignmentPolicies.AccessPackage.ListAssignmentPolicies parameters: @@ -7398,6 +7622,16 @@ paths: parameters: accessPackage-id: $request.path.accessPackage-id accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.accessPackages.assignmentPolicies.AccessPackage.ListIncompatibleAccessPackages + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.accessPackages.assignmentPolicies.AccessPackage.ListIncompatibleGroups + parameters: + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation @@ -7537,16 +7771,12 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/microsoft.graph.getApplicablePolicyRequirements': - post: + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages': + get: tags: - - identityGovernance.Actions - summary: Invoke action getApplicablePolicyRequirements - description: 'In Azure AD entitlement management, this action retrieves a list of accessPackageAssignmentRequestRequirements objects that the currently signed-in user can use to create an accessPackageAssignmentRequest. Each requirement object corresponds to an access package assignment policy that the currently signed-in user is allowed to request an assignment for.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/accesspackage-getapplicablepolicyrequirements?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.accessPackages_getApplicablePolicyRequirements + - identityGovernance.entitlementManagement + summary: Get incompatibleAccessPackages from identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_ListIncompatibleAccessPackages parameters: - name: accessPackage-id in: path @@ -7556,48 +7786,14 @@ paths: schema: type: string x-ms-docs-key-type: accessPackage - responses: - '200': - description: Success - content: - application/json: - schema: - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestRequirements' - additionalProperties: - type: object - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - '/identityGovernance/entitlementManagement/accessPackages/microsoft.graph.filterByCurrentUser(on=''{on}'')': - get: - tags: - - identityGovernance.Functions - summary: Invoke function filterByCurrentUser - operationId: identityGovernance.entitlementManagement.accessPackages_filterGraphBPreCurrentUser - parameters: - - name: on - in: path - description: 'Usage: on=''{on}''' - required: true - style: simple - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageFilterByCurrentUserOptions' - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - - name: $select + - name: $orderby in: query - description: Select properties to be returned + description: Order items by property values style: form explode: false schema: @@ -7606,17 +7802,21 @@ paths: items: enum: - id + - id desc - createdDateTime + - createdDateTime desc - description + - description desc - displayName + - displayName desc - isHidden + - isHidden desc - modifiedDateTime - - assignmentPolicies - - catalog + - modifiedDateTime desc type: string - - name: $orderby + - name: $select in: query - description: Order items by property values + description: Select properties to be returned style: form explode: false schema: @@ -7625,50 +7825,100 @@ paths: items: enum: - id - - id desc - createdDateTime - - createdDateTime desc - description - - description desc - displayName - - displayName desc - isHidden - - isHidden desc - modifiedDateTime - - modifiedDateTime desc + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': - description: Success - content: - application/json: - schema: - title: Collection of accessPackage - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.accessPackage' - additionalProperties: - type: object + $ref: '#/components/responses/microsoft.graph.accessPackageCollectionResponse' default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore - /identityGovernance/entitlementManagement/assignmentPolicies: + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages/{accessPackage-id1}/$ref': + delete: + tags: + - identityGovernance.entitlementManagement + summary: Delete ref of navigation property incompatibleAccessPackages for identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_DeleteIncompatibleAccessPackagesGraphBPreRef + parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - name: accessPackage-id1 + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + - name: '@id' + in: query + description: Delete Uri + style: form + explode: false + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleAccessPackages/$ref': get: tags: - identityGovernance.entitlementManagement - summary: List assignmentPolicies - description: 'In Azure AD entitlement management, retrieve a list of accessPackageAssignmentPolicy objects. If the delegated user is in a directory role, the resulting list includes all the assignment policies that the caller has access to read, across all catalogs and access packages. If the delegated user is an access package manager or catalog owner, they should instead retrieve the policies for the access packages they can read with list accessPackages by including `$expand=accessPackageAssignmentPolicies` as a query parameter.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-assignmentpolicies?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_ListAssignmentPolicies + summary: Get ref of incompatibleAccessPackages from identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_ListIncompatibleAccessPackagesGraphBPreRef parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -7686,71 +7936,20 @@ paths: enum: - id - id desc - - allowedTargetScope - - allowedTargetScope desc - - automaticRequestSettings - - automaticRequestSettings desc - createdDateTime - createdDateTime desc - description - description desc - displayName - displayName desc - - expiration - - expiration desc + - isHidden + - isHidden desc - modifiedDateTime - modifiedDateTime desc - - requestApprovalSettings - - requestApprovalSettings desc - - requestorSettings - - requestorSettings desc - - reviewSettings - - reviewSettings desc - - specificAllowedTargets - - specificAllowedTargets desc - type: string - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - allowedTargetScope - - automaticRequestSettings - - createdDateTime - - description - - displayName - - expiration - - modifiedDateTime - - requestApprovalSettings - - requestorSettings - - reviewSettings - - specificAllowedTargets - - accessPackage - - catalog - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - accessPackage - - catalog type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentPolicyCollectionResponse' + $ref: '#/components/responses/StringCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -7760,45 +7959,136 @@ paths: post: tags: - identityGovernance.entitlementManagement - summary: Create assignmentPolicies - description: 'In Azure AD entitlement management, create a new accessPackageAssignmentPolicy object. The request will include a reference to the accessPackage that will contain this policy, which must already exist.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-post-assignmentpolicies?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_CreateAssignmentPolicies + summary: Create new navigation property ref to incompatibleAccessPackages for identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_CreateIncompatibleAccessPackagesGraphBPreRef + parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' - required: true + $ref: '#/components/requestBodies/refPostBody' responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + '204': + description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}': + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups': get: tags: - identityGovernance.entitlementManagement - summary: Get assignmentPolicies from identityGovernance - description: Access package assignment policies govern which subjects can request or be assigned an access package via an access package assignment. - operationId: identityGovernance.entitlementManagement_GetAssignmentPolicies + summary: Get incompatibleGroups from identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_ListIncompatibleGroups parameters: - - name: accessPackageAssignmentPolicy-id + - name: accessPackage-id in: path - description: 'key: id of accessPackageAssignmentPolicy' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy + x-ms-docs-key-type: accessPackage + - $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 + - assignedLabels + - assignedLabels desc + - assignedLicenses + - assignedLicenses desc + - classification + - classification desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - expirationDateTime + - expirationDateTime desc + - groupTypes + - groupTypes desc + - hasMembersWithLicenseErrors + - hasMembersWithLicenseErrors desc + - isAssignableToRole + - isAssignableToRole desc + - licenseProcessingState + - licenseProcessingState desc + - mail + - mail desc + - mailEnabled + - mailEnabled desc + - mailNickname + - mailNickname desc + - membershipRule + - membershipRule desc + - membershipRuleProcessingState + - membershipRuleProcessingState desc + - onPremisesDomainName + - onPremisesDomainName desc + - onPremisesLastSyncDateTime + - onPremisesLastSyncDateTime desc + - onPremisesNetBiosName + - onPremisesNetBiosName desc + - onPremisesProvisioningErrors + - onPremisesProvisioningErrors desc + - onPremisesSamAccountName + - onPremisesSamAccountName desc + - onPremisesSecurityIdentifier + - onPremisesSecurityIdentifier desc + - onPremisesSyncEnabled + - onPremisesSyncEnabled desc + - preferredDataLocation + - preferredDataLocation desc + - preferredLanguage + - preferredLanguage desc + - proxyAddresses + - proxyAddresses desc + - renewedDateTime + - renewedDateTime desc + - securityEnabled + - securityEnabled desc + - securityIdentifier + - securityIdentifier desc + - theme + - theme desc + - visibility + - visibility desc + - allowExternalSenders + - allowExternalSenders desc + - autoSubscribeNewMembers + - autoSubscribeNewMembers desc + - hideFromAddressLists + - hideFromAddressLists desc + - hideFromOutlookClients + - hideFromOutlookClients desc + - isSubscribedByMail + - isSubscribedByMail desc + - unseenCount + - unseenCount desc + - isArchived + - isArchived desc + type: string - name: $select in: query description: Select properties to be returned @@ -7810,19 +8100,72 @@ paths: items: enum: - id - - allowedTargetScope - - automaticRequestSettings + - deletedDateTime + - assignedLabels + - assignedLicenses + - classification - createdDateTime - description - displayName - - expiration - - modifiedDateTime - - requestApprovalSettings - - requestorSettings - - reviewSettings - - specificAllowedTargets - - accessPackage - - catalog + - expirationDateTime + - groupTypes + - hasMembersWithLicenseErrors + - isAssignableToRole + - licenseProcessingState + - mail + - mailEnabled + - mailNickname + - membershipRule + - membershipRuleProcessingState + - onPremisesDomainName + - onPremisesLastSyncDateTime + - onPremisesNetBiosName + - onPremisesProvisioningErrors + - onPremisesSamAccountName + - onPremisesSecurityIdentifier + - onPremisesSyncEnabled + - preferredDataLocation + - preferredLanguage + - proxyAddresses + - renewedDateTime + - securityEnabled + - securityIdentifier + - theme + - visibility + - allowExternalSenders + - autoSubscribeNewMembers + - hideFromAddressLists + - hideFromOutlookClients + - isSubscribedByMail + - unseenCount + - isArchived + - appRoleAssignments + - createdOnBehalfOf + - memberOf + - members + - membersWithLicenseErrors + - owners + - permissionGrants + - settings + - transitiveMemberOf + - transitiveMembers + - acceptedSenders + - calendar + - calendarView + - conversations + - events + - rejectedSenders + - threads + - drive + - drives + - sites + - extensions + - groupLifecyclePolicies + - planner + - onenote + - photo + - photos + - team type: string - name: $expand in: query @@ -7835,100 +8178,108 @@ paths: items: enum: - '*' - - accessPackage - - catalog + - appRoleAssignments + - createdOnBehalfOf + - memberOf + - members + - membersWithLicenseErrors + - owners + - permissionGrants + - settings + - transitiveMemberOf + - transitiveMembers + - acceptedSenders + - calendar + - calendarView + - conversations + - events + - rejectedSenders + - threads + - drive + - drives + - sites + - extensions + - groupLifecyclePolicies + - planner + - onenote + - photo + - photos + - team type: string responses: '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' - links: - accessPackage: - operationId: identityGovernance.entitlementManagement.AssignmentPolicies.GetAccessPackage - parameters: - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id - catalog: - operationId: identityGovernance.entitlementManagement.AssignmentPolicies.GetCatalog - parameters: - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + $ref: '#/components/responses/microsoft.graph.groupCollectionResponse' default: $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore x-ms-docs-operation-type: operation - put: + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/{group-id}/$ref': + delete: tags: - identityGovernance.entitlementManagement - summary: Update the navigation property assignmentPolicies in identityGovernance - operationId: identityGovernance.entitlementManagement_SetAssignmentPolicies + summary: Delete ref of navigation property incompatibleGroups for identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_DeleteIncompatibleGroupsGraphBPreRef parameters: - - name: accessPackageAssignmentPolicy-id + - name: accessPackage-id in: path - description: 'key: id of accessPackageAssignmentPolicy' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - delete: - tags: - - identityGovernance.entitlementManagement - summary: Delete navigation property assignmentPolicies for identityGovernance - operationId: identityGovernance.entitlementManagement_DeleteAssignmentPolicies - parameters: - - name: accessPackageAssignmentPolicy-id + x-ms-docs-key-type: accessPackage + - name: group-id in: path - description: 'key: id of accessPackageAssignmentPolicy' + description: 'key: id of group' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy + x-ms-docs-key-type: group - name: If-Match in: header description: ETag style: simple schema: type: string + - name: '@id' + in: query + description: Delete Uri + style: form + explode: false + schema: + type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/accessPackage': + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/incompatibleGroups/$ref': get: tags: - identityGovernance.entitlementManagement - summary: Get accessPackage from identityGovernance - description: Access package containing this policy. Read-only. - operationId: identityGovernance.entitlementManagement.assignmentPolicies_GetAccessPackage + summary: Get ref of incompatibleGroups from identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_ListIncompatibleGroupsGraphBPreRef parameters: - - name: accessPackageAssignmentPolicy-id + - name: accessPackage-id in: path - description: 'key: id of accessPackageAssignmentPolicy' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy - - name: $select + x-ms-docs-key-type: accessPackage + - $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: Select properties to be returned + description: Order items by property values style: form explode: false schema: @@ -7937,63 +8288,175 @@ paths: items: enum: - id + - id desc + - deletedDateTime + - deletedDateTime desc + - assignedLabels + - assignedLabels desc + - assignedLicenses + - assignedLicenses desc + - classification + - classification desc - createdDateTime + - createdDateTime desc - description + - description desc - displayName - - isHidden - - modifiedDateTime - - assignmentPolicies - - catalog + - displayName desc + - expirationDateTime + - expirationDateTime desc + - groupTypes + - groupTypes desc + - hasMembersWithLicenseErrors + - hasMembersWithLicenseErrors desc + - isAssignableToRole + - isAssignableToRole desc + - licenseProcessingState + - licenseProcessingState desc + - mail + - mail desc + - mailEnabled + - mailEnabled desc + - mailNickname + - mailNickname desc + - membershipRule + - membershipRule desc + - membershipRuleProcessingState + - membershipRuleProcessingState desc + - onPremisesDomainName + - onPremisesDomainName desc + - onPremisesLastSyncDateTime + - onPremisesLastSyncDateTime desc + - onPremisesNetBiosName + - onPremisesNetBiosName desc + - onPremisesProvisioningErrors + - onPremisesProvisioningErrors desc + - onPremisesSamAccountName + - onPremisesSamAccountName desc + - onPremisesSecurityIdentifier + - onPremisesSecurityIdentifier desc + - onPremisesSyncEnabled + - onPremisesSyncEnabled desc + - preferredDataLocation + - preferredDataLocation desc + - preferredLanguage + - preferredLanguage desc + - proxyAddresses + - proxyAddresses desc + - renewedDateTime + - renewedDateTime desc + - securityEnabled + - securityEnabled desc + - securityIdentifier + - securityIdentifier desc + - theme + - theme desc + - visibility + - visibility desc + - allowExternalSenders + - allowExternalSenders desc + - autoSubscribeNewMembers + - autoSubscribeNewMembers desc + - hideFromAddressLists + - hideFromAddressLists desc + - hideFromOutlookClients + - hideFromOutlookClients desc + - isSubscribedByMail + - isSubscribedByMail desc + - unseenCount + - unseenCount desc + - isArchived + - isArchived desc type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false + responses: + '200': + $ref: '#/components/responses/StringCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.entitlementManagement + summary: Create new navigation property ref to incompatibleGroups for identityGovernance + operationId: identityGovernance.entitlementManagement.accessPackages_CreateIncompatibleGroupsGraphBPreRef + parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - assignmentPolicies - - catalog - type: string + type: string + x-ms-docs-key-type: accessPackage + requestBody: + $ref: '#/components/requestBodies/refPostBody' + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/accessPackages/{accessPackage-id}/microsoft.graph.getApplicablePolicyRequirements': + post: + tags: + - identityGovernance.Actions + summary: Invoke action getApplicablePolicyRequirements + description: 'In Azure AD entitlement management, this action retrieves a list of accessPackageAssignmentRequestRequirements objects that the currently signed-in user can use to create an accessPackageAssignmentRequest. Each requirement object corresponds to an access package assignment policy that the currently signed-in user is allowed to request an assignment for.' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/accesspackage-getapplicablepolicyrequirements?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.accessPackages_getApplicablePolicyRequirements + parameters: + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage responses: '200': - description: Retrieved navigation property + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackage' - links: - assignmentPolicies: - operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.ListAssignmentPolicies - parameters: - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id - catalog: - operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.GetCatalog - parameters: - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestRequirements' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/catalog': + x-ms-docs-operation-type: action + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/accessPackages/microsoft.graph.filterByCurrentUser(on=''{on}'')': get: tags: - - identityGovernance.entitlementManagement - summary: Get catalog from identityGovernance - description: Catalog of the access package containing this policy. Read-only. - operationId: identityGovernance.entitlementManagement.assignmentPolicies_GetCatalog + - identityGovernance.Functions + summary: Invoke function filterByCurrentUser + operationId: identityGovernance.entitlementManagement.accessPackages_filterGraphBPreCurrentUser parameters: - - name: accessPackageAssignmentPolicy-id + - name: on in: path - description: 'key: id of accessPackageAssignmentPolicy' + description: 'Usage: on=''{on}''' required: true style: simple schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy + $ref: '#/components/schemas/microsoft.graph.accessPackageFilterByCurrentUserOptions' + - $ref: '#/components/parameters/top' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned @@ -8005,18 +8468,20 @@ paths: items: enum: - id - - catalogType - createdDateTime - description - displayName - - isExternallyVisible + - isHidden - modifiedDateTime - - state - - accessPackages + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - - name: $expand + - name: $orderby in: query - description: Expand related entities + description: Order items by property values style: form explode: false schema: @@ -8024,34 +8489,50 @@ paths: type: array items: enum: - - '*' - - accessPackages + - id + - id desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - isHidden + - isHidden desc + - modifiedDateTime + - modifiedDateTime desc type: string responses: '200': - description: Retrieved navigation property + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' - links: - accessPackages: - operationId: identityGovernance.entitlementManagement.assignmentPolicies.Catalog.ListAccessPackages - parameters: - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + title: Collection of accessPackage + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - /identityGovernance/entitlementManagement/assignmentRequests: + x-ms-docs-operation-type: function + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + /identityGovernance/entitlementManagement/assignmentPolicies: get: tags: - identityGovernance.entitlementManagement - summary: List assignmentRequests - description: 'In Azure AD entitlement management, retrieve a list of accessPackageAssignmentRequest objects. The resulting list includes all the assignment requests, current and well as expired, that the caller has access to read, across all catalogs and access packages.' + summary: List assignmentPolicies + description: 'In Azure AD entitlement management, retrieve a list of accessPackageAssignmentPolicy objects. If the delegated user is in a directory role, the resulting list includes all the assignment policies that the caller has access to read, across all catalogs and access packages. If the delegated user is an access package manager or catalog owner, they should instead retrieve the policies for the access packages they can read with list accessPackages by including `$expand=accessPackageAssignmentPolicies` as a query parameter.' externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-assignmentrequests?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_ListAssignmentRequests + url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-assignmentpolicies?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_ListAssignmentPolicies parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' @@ -8070,18 +8551,28 @@ paths: enum: - id - id desc - - completedDateTime - - completedDateTime desc + - allowedTargetScope + - allowedTargetScope desc + - automaticRequestSettings + - automaticRequestSettings desc - createdDateTime - createdDateTime desc - - requestType - - requestType desc - - schedule - - schedule desc - - state - - state desc - - status - - status desc + - description + - description desc + - displayName + - displayName desc + - expiration + - expiration desc + - modifiedDateTime + - modifiedDateTime desc + - requestApprovalSettings + - requestApprovalSettings desc + - requestorSettings + - requestorSettings desc + - reviewSettings + - reviewSettings desc + - specificAllowedTargets + - specificAllowedTargets desc type: string - name: $select in: query @@ -8094,15 +8585,19 @@ paths: items: enum: - id - - completedDateTime + - allowedTargetScope + - automaticRequestSettings - createdDateTime - - requestType - - schedule - - state - - status + - description + - displayName + - expiration + - modifiedDateTime + - requestApprovalSettings + - requestorSettings + - reviewSettings + - specificAllowedTargets - accessPackage - - assignment - - requestor + - catalog type: string - name: $expand in: query @@ -8116,12 +8611,11 @@ paths: enum: - '*' - accessPackage - - assignment - - requestor + - catalog type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentRequestCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentPolicyCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -8131,18 +8625,18 @@ paths: post: tags: - identityGovernance.entitlementManagement - summary: Create accessPackageAssignmentRequest - description: 'In Azure AD Entitlement Management, create a new accessPackageAssignmentRequest object. This operation is used to assign a user to an access package, or to remove an access package assignment.' + summary: Create assignmentPolicies + description: 'In Azure AD entitlement management, create a new accessPackageAssignmentPolicy object. The request will include a reference to the accessPackage that will contain this policy, which must already exist.' externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-post-assignmentrequests?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_CreateAssignmentRequests + url: https://docs.microsoft.com/graph/api/entitlementmanagement-post-assignmentpolicies?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_CreateAssignmentPolicies requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' required: true responses: '201': @@ -8150,26 +8644,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}': + '/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}': get: tags: - identityGovernance.entitlementManagement - summary: Get assignmentRequests from identityGovernance - description: Access package assignment requests created by or on behalf of a subject. - operationId: identityGovernance.entitlementManagement_GetAssignmentRequests + summary: Get assignmentPolicies from identityGovernance + description: Access package assignment policies govern which subjects can request or be assigned an access package via an access package assignment. + operationId: identityGovernance.entitlementManagement_GetAssignmentPolicies parameters: - - name: accessPackageAssignmentRequest-id + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of accessPackageAssignmentRequest' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentRequest + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: $select in: query description: Select properties to be returned @@ -8181,15 +8675,19 @@ paths: items: enum: - id - - completedDateTime + - allowedTargetScope + - automaticRequestSettings - createdDateTime - - requestType - - schedule - - state - - status + - description + - displayName + - expiration + - modifiedDateTime + - requestApprovalSettings + - requestorSettings + - reviewSettings + - specificAllowedTargets - accessPackage - - assignment - - requestor + - catalog type: string - name: $expand in: query @@ -8203,8 +8701,7 @@ paths: enum: - '*' - accessPackage - - assignment - - requestor + - catalog type: string responses: '200': @@ -8212,47 +8709,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' links: accessPackage: - operationId: identityGovernance.entitlementManagement.AssignmentRequests.GetAccessPackage - parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id - assignment: - operationId: identityGovernance.entitlementManagement.AssignmentRequests.GetAssignment + operationId: identityGovernance.entitlementManagement.AssignmentPolicies.GetAccessPackage parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id - requestor: - operationId: identityGovernance.entitlementManagement.AssignmentRequests.GetRequestor + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + catalog: + operationId: identityGovernance.entitlementManagement.AssignmentPolicies.GetCatalog parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id - cancel: - operationId: identityGovernance.entitlementManagement.assignmentRequests.accessPackageAssignmentRequest.cancel - reprocess: - operationId: identityGovernance.entitlementManagement.assignmentRequests.accessPackageAssignmentRequest.reprocess + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - patch: + put: tags: - identityGovernance.entitlementManagement - summary: Update the navigation property assignmentRequests in identityGovernance - operationId: identityGovernance.entitlementManagement_UpdateAssignmentRequests + summary: Update the navigation property assignmentPolicies in identityGovernance + operationId: identityGovernance.entitlementManagement_SetAssignmentPolicies parameters: - - name: accessPackageAssignmentRequest-id + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of accessPackageAssignmentRequest' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentRequest + x-ms-docs-key-type: accessPackageAssignmentPolicy requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' required: true responses: '204': @@ -8263,17 +8752,17 @@ paths: delete: tags: - identityGovernance.entitlementManagement - summary: Delete navigation property assignmentRequests for identityGovernance - operationId: identityGovernance.entitlementManagement_DeleteAssignmentRequests + summary: Delete navigation property assignmentPolicies for identityGovernance + operationId: identityGovernance.entitlementManagement_DeleteAssignmentPolicies parameters: - - name: accessPackageAssignmentRequest-id + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of accessPackageAssignmentRequest' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentRequest + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: If-Match in: header description: ETag @@ -8286,22 +8775,22 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/accessPackage': + '/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/accessPackage': get: tags: - identityGovernance.entitlementManagement summary: Get accessPackage from identityGovernance - description: The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand. - operationId: identityGovernance.entitlementManagement.assignmentRequests_GetAccessPackage + description: Access package containing this policy. Read-only. + operationId: identityGovernance.entitlementManagement.assignmentPolicies_GetAccessPackage parameters: - - name: accessPackageAssignmentRequest-id + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of accessPackageAssignmentRequest' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentRequest + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: $select in: query description: Select properties to be returned @@ -8318,8 +8807,11 @@ paths: - displayName - isHidden - modifiedDateTime + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -8332,8 +8824,11 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': @@ -8343,33 +8838,45 @@ paths: schema: $ref: '#/components/schemas/microsoft.graph.accessPackage' links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id assignmentPolicies: - operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.ListAssignmentPolicies + operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.ListAssignmentPolicies parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id catalog: - operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.GetCatalog + operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.GetCatalog parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.ListIncompatibleAccessPackages + parameters: + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.assignmentPolicies.AccessPackage.ListIncompatibleGroups + parameters: + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/assignment': + '/identityGovernance/entitlementManagement/assignmentPolicies/{accessPackageAssignmentPolicy-id}/catalog': get: tags: - identityGovernance.entitlementManagement - summary: Get assignment from identityGovernance - description: 'For a requestType of userAdd or adminAdd, this is an access package assignment requested to be created. For a requestType of userRemove, adminRemove or systemRemove, this has the id property of an existing assignment to be removed. Supports $expand.' - operationId: identityGovernance.entitlementManagement.assignmentRequests_GetAssignment + summary: Get catalog from identityGovernance + description: Catalog of the access package containing this policy. Read-only. + operationId: identityGovernance.entitlementManagement.assignmentPolicies_GetCatalog parameters: - - name: accessPackageAssignmentRequest-id + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of accessPackageAssignmentRequest' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignmentRequest + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: $select in: query description: Select properties to be returned @@ -8381,13 +8888,14 @@ paths: items: enum: - id - - expiredDateTime - - schedule + - catalogType + - createdDateTime + - description + - displayName + - isExternallyVisible + - modifiedDateTime - state - - status - - accessPackage - - assignmentPolicy - - target + - accessPackages type: string - name: $expand in: query @@ -8400,9 +8908,7 @@ paths: items: enum: - '*' - - accessPackage - - assignmentPolicy - - target + - accessPackages type: string responses: '200': @@ -8410,175 +8916,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' links: - accessPackage: - operationId: identityGovernance.entitlementManagement.assignmentRequests.Assignment.GetAccessPackage - parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id - assignmentPolicy: - operationId: identityGovernance.entitlementManagement.assignmentRequests.Assignment.GetAssignmentPolicy - parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id - target: - operationId: identityGovernance.entitlementManagement.assignmentRequests.Assignment.GetTarget + accessPackages: + operationId: identityGovernance.entitlementManagement.assignmentPolicies.Catalog.ListAccessPackages parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.cancel': - post: - tags: - - identityGovernance.Actions - summary: Invoke action cancel - description: 'In Azure AD Entitlement Management, cancel accessPackageAssignmentRequest objects that are in a cancellable state: `accepted`, `pendingApproval`, `pendingNotBefore`, `pendingApprovalEscalated`.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/accesspackageassignmentrequest-cancel?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.assignmentRequests_cancel - parameters: - - name: accessPackageAssignmentRequest-id - in: path - description: 'key: id of accessPackageAssignmentRequest' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentRequest - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.reprocess': - post: - tags: - - identityGovernance.Actions - summary: Invoke action reprocess - operationId: identityGovernance.entitlementManagement.assignmentRequests_reprocess - parameters: - - name: accessPackageAssignmentRequest-id - in: path - description: 'key: id of accessPackageAssignmentRequest' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentRequest - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/requestor': + /identityGovernance/entitlementManagement/assignmentRequests: get: tags: - identityGovernance.entitlementManagement - summary: Get requestor from identityGovernance - description: 'The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand.' - operationId: identityGovernance.entitlementManagement.assignmentRequests_GetRequestor + summary: List assignmentRequests + description: 'In Azure AD entitlement management, retrieve a list of accessPackageAssignmentRequest objects. The resulting list includes all the assignment requests, current and well as expired, that the caller has access to read, across all catalogs and access packages.' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-assignmentrequests?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_ListAssignmentRequests parameters: - - name: accessPackageAssignmentRequest-id - in: path - description: 'key: id of accessPackageAssignmentRequest' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentRequest - - name: $select + - $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: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - displayName - - email - - objectId - - onPremisesSecurityIdentifier - - principalName - - subjectType - - connectedOrganization - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - connectedOrganization - type: string - responses: - '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageSubject' - links: - connectedOrganization: - operationId: identityGovernance.entitlementManagement.assignmentRequests.Requestor.GetConnectedOrganization - parameters: - accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignmentRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')': - get: - tags: - - identityGovernance.Functions - summary: Invoke function filterByCurrentUser - operationId: identityGovernance.entitlementManagement.assignmentRequests_filterGraphBPreCurrentUser - parameters: - - name: on - in: path - description: 'Usage: on=''{on}''' - required: true - style: simple - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestFilterByCurrentUserOptions' - - $ref: '#/components/parameters/top' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/count' - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - completedDateTime - - createdDateTime - - requestType - - schedule - - state - - status - - accessPackage - - assignment - - requestor - type: string - - name: $orderby - in: query - description: Order items by property values + description: Order items by property values style: form explode: false schema: @@ -8601,64 +8966,6 @@ paths: - status - status desc type: string - responses: - '200': - description: Success - content: - application/json: - schema: - title: Collection of accessPackageAssignmentRequest - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' - additionalProperties: - type: object - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: function - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - /identityGovernance/entitlementManagement/assignments: - get: - tags: - - identityGovernance.entitlementManagement - summary: List assignments - description: 'In Azure AD entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes all the assignments, current and well as expired, that the caller has access to read, across all catalogs and access packages. If the caller is on behalf of a delegated user who is assigned only to catalog-specific delegated administrative roles, the request must supply a filter to indicate a specific access package, such as: `$filter=accessPackage/id eq ''a914b616-e04e-476b-aa37-91038f0b165b''`.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-assignments?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_ListAssignments - 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 - - expiredDateTime - - expiredDateTime desc - - schedule - - schedule desc - - state - - state desc - - status - - status desc - type: string - name: $select in: query description: Select properties to be returned @@ -8670,13 +8977,15 @@ paths: items: enum: - id - - expiredDateTime + - completedDateTime + - createdDateTime + - requestType - schedule - state - status - accessPackage - - assignmentPolicy - - target + - assignment + - requestor type: string - name: $expand in: query @@ -8690,12 +8999,12 @@ paths: enum: - '*' - accessPackage - - assignmentPolicy - - target + - assignment + - requestor type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentRequestCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -8705,14 +9014,18 @@ paths: post: tags: - identityGovernance.entitlementManagement - summary: Create new navigation property to assignments for identityGovernance - operationId: identityGovernance.entitlementManagement_CreateAssignments + summary: Create accessPackageAssignmentRequest + description: 'In Azure AD Entitlement Management, create a new accessPackageAssignmentRequest object. This operation is used to assign a user to an access package, or to remove an access package assignment.' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagement-post-assignmentrequests?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_CreateAssignmentRequests requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' required: true responses: '201': @@ -8720,26 +9033,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}': + '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}': get: tags: - identityGovernance.entitlementManagement - summary: Get assignments from identityGovernance - description: The assignment of an access package to a subject for a period of time. - operationId: identityGovernance.entitlementManagement_GetAssignments + summary: Get assignmentRequests from identityGovernance + description: Access package assignment requests created by or on behalf of a subject. + operationId: identityGovernance.entitlementManagement_GetAssignmentRequests parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest - name: $select in: query description: Select properties to be returned @@ -8751,13 +9064,15 @@ paths: items: enum: - id - - expiredDateTime + - completedDateTime + - createdDateTime + - requestType - schedule - state - status - accessPackage - - assignmentPolicy - - target + - assignment + - requestor type: string - name: $expand in: query @@ -8771,8 +9086,8 @@ paths: enum: - '*' - accessPackage - - assignmentPolicy - - target + - assignment + - requestor type: string responses: '200': @@ -8780,45 +9095,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' links: accessPackage: - operationId: identityGovernance.entitlementManagement.Assignments.GetAccessPackage + operationId: identityGovernance.entitlementManagement.AssignmentRequests.GetAccessPackage parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id - assignmentPolicy: - operationId: identityGovernance.entitlementManagement.Assignments.GetAssignmentPolicy + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + assignment: + operationId: identityGovernance.entitlementManagement.AssignmentRequests.GetAssignment parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id - target: - operationId: identityGovernance.entitlementManagement.Assignments.GetTarget + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + requestor: + operationId: identityGovernance.entitlementManagement.AssignmentRequests.GetRequestor parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + cancel: + operationId: identityGovernance.entitlementManagement.assignmentRequests.accessPackageAssignmentRequest.cancel reprocess: - operationId: identityGovernance.entitlementManagement.assignments.accessPackageAssignment.reprocess + operationId: identityGovernance.entitlementManagement.assignmentRequests.accessPackageAssignmentRequest.reprocess default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - identityGovernance.entitlementManagement - summary: Update the navigation property assignments in identityGovernance - operationId: identityGovernance.entitlementManagement_UpdateAssignments + summary: Update the navigation property assignmentRequests in identityGovernance + operationId: identityGovernance.entitlementManagement_UpdateAssignmentRequests parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' required: true responses: '204': @@ -8829,17 +9146,17 @@ paths: delete: tags: - identityGovernance.entitlementManagement - summary: Delete navigation property assignments for identityGovernance - operationId: identityGovernance.entitlementManagement_DeleteAssignments + summary: Delete navigation property assignmentRequests for identityGovernance + operationId: identityGovernance.entitlementManagement_DeleteAssignmentRequests parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest - name: If-Match in: header description: ETag @@ -8852,22 +9169,22 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/accessPackage': + '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/accessPackage': get: tags: - identityGovernance.entitlementManagement summary: Get accessPackage from identityGovernance - description: Read-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters. - operationId: identityGovernance.entitlementManagement.assignments_GetAccessPackage + description: The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand. + operationId: identityGovernance.entitlementManagement.assignmentRequests_GetAccessPackage parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest - name: $select in: query description: Select properties to be returned @@ -8884,8 +9201,11 @@ paths: - displayName - isHidden - modifiedDateTime + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -8898,8 +9218,11 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': @@ -8909,33 +9232,45 @@ paths: schema: $ref: '#/components/schemas/microsoft.graph.accessPackage' links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id assignmentPolicies: - operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.ListAssignmentPolicies + operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.ListAssignmentPolicies parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id catalog: - operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.GetCatalog + operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.GetCatalog parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.ListIncompatibleAccessPackages + parameters: + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.assignmentRequests.AccessPackage.ListIncompatibleGroups + parameters: + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/assignmentPolicy': + '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/assignment': get: tags: - identityGovernance.entitlementManagement - summary: Get assignmentPolicy from identityGovernance - description: Read-only. Supports $filter (eq) on the id property and $expand query parameters. - operationId: identityGovernance.entitlementManagement.assignments_GetAssignmentPolicy + summary: Get assignment from identityGovernance + description: 'For a requestType of userAdd or adminAdd, this is an access package assignment requested to be created. For a requestType of userRemove, adminRemove or systemRemove, this has the id property of an existing assignment to be removed. Supports $expand.' + operationId: identityGovernance.entitlementManagement.assignmentRequests_GetAssignment parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest - name: $select in: query description: Select properties to be returned @@ -8947,19 +9282,13 @@ paths: items: enum: - id - - allowedTargetScope - - automaticRequestSettings - - createdDateTime - - description - - displayName - - expiration - - modifiedDateTime - - requestApprovalSettings - - requestorSettings - - reviewSettings - - specificAllowedTargets + - expiredDateTime + - schedule + - state + - status - accessPackage - - catalog + - assignmentPolicy + - target type: string - name: $expand in: query @@ -8973,7 +9302,8 @@ paths: enum: - '*' - accessPackage - - catalog + - assignmentPolicy + - target type: string responses: '200': @@ -8981,56 +9311,85 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' links: accessPackage: - operationId: identityGovernance.entitlementManagement.assignments.AssignmentPolicy.GetAccessPackage + operationId: identityGovernance.entitlementManagement.assignmentRequests.Assignment.GetAccessPackage parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id - catalog: - operationId: identityGovernance.entitlementManagement.assignments.AssignmentPolicy.GetCatalog + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + assignmentPolicy: + operationId: identityGovernance.entitlementManagement.assignmentRequests.Assignment.GetAssignmentPolicy parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id + target: + operationId: identityGovernance.entitlementManagement.assignmentRequests.Assignment.GetTarget + parameters: + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/microsoft.graph.reprocess': + '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.cancel': + post: + tags: + - identityGovernance.Actions + summary: Invoke action cancel + description: 'In Azure AD Entitlement Management, cancel accessPackageAssignmentRequest objects that are in a cancellable state: `accepted`, `pendingApproval`, `pendingNotBefore`, `pendingApprovalEscalated`.' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/accesspackageassignmentrequest-cancel?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.assignmentRequests_cancel + parameters: + - name: accessPackageAssignmentRequest-id + in: path + description: 'key: id of accessPackageAssignmentRequest' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageAssignmentRequest + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/microsoft.graph.reprocess': post: tags: - identityGovernance.Actions summary: Invoke action reprocess - operationId: identityGovernance.entitlementManagement.assignments_reprocess + operationId: identityGovernance.entitlementManagement.assignmentRequests_reprocess parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action - '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/target': + '/identityGovernance/entitlementManagement/assignmentRequests/{accessPackageAssignmentRequest-id}/requestor': get: tags: - identityGovernance.entitlementManagement - summary: Get target from identityGovernance - description: The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId. - operationId: identityGovernance.entitlementManagement.assignments_GetTarget + summary: Get requestor from identityGovernance + description: 'The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand.' + operationId: identityGovernance.entitlementManagement.assignmentRequests_GetRequestor parameters: - - name: accessPackageAssignment-id + - name: accessPackageAssignmentRequest-id in: path - description: 'key: id of accessPackageAssignment' + description: 'key: id of accessPackageAssignmentRequest' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageAssignment + x-ms-docs-key-type: accessPackageAssignmentRequest - name: $select in: query description: Select properties to be returned @@ -9072,18 +9431,18 @@ paths: $ref: '#/components/schemas/microsoft.graph.accessPackageSubject' links: connectedOrganization: - operationId: identityGovernance.entitlementManagement.assignments.Target.GetConnectedOrganization + operationId: identityGovernance.entitlementManagement.assignmentRequests.Requestor.GetConnectedOrganization parameters: - accessPackageAssignment-id: $request.path.accessPackageAssignment-id + accessPackageAssignmentRequest-id: $request.path.accessPackageAssignmentRequest-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/assignments/microsoft.graph.filterByCurrentUser(on=''{on}'')': + '/identityGovernance/entitlementManagement/assignmentRequests/microsoft.graph.filterByCurrentUser(on=''{on}'')': get: tags: - identityGovernance.Functions summary: Invoke function filterByCurrentUser - operationId: identityGovernance.entitlementManagement.assignments_filterGraphBPreCurrentUser + operationId: identityGovernance.entitlementManagement.assignmentRequests_filterGraphBPreCurrentUser parameters: - name: on in: path @@ -9091,7 +9450,7 @@ paths: required: true style: simple schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentFilterByCurrentUserOptions' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestFilterByCurrentUserOptions' - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -9108,13 +9467,15 @@ paths: items: enum: - id - - expiredDateTime + - completedDateTime + - createdDateTime + - requestType - schedule - state - status - accessPackage - - assignmentPolicy - - target + - assignment + - requestor type: string - name: $orderby in: query @@ -9128,8 +9489,12 @@ paths: enum: - id - id desc - - expiredDateTime - - expiredDateTime desc + - completedDateTime + - completedDateTime desc + - createdDateTime + - createdDateTime desc + - requestType + - requestType desc - schedule - schedule desc - state @@ -9143,13 +9508,13 @@ paths: content: application/json: schema: - title: Collection of accessPackageAssignment + title: Collection of accessPackageAssignmentRequest type: object properties: value: type: array items: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' additionalProperties: type: object default: @@ -9158,16 +9523,16 @@ paths: x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore - /identityGovernance/entitlementManagement/catalogs: + /identityGovernance/entitlementManagement/assignments: get: tags: - identityGovernance.entitlementManagement - summary: List catalogs - description: Retrieve a list of accessPackageCatalog objects. + summary: List assignments + description: 'In Azure AD entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes all the assignments, current and well as expired, that the caller has access to read, across all catalogs and access packages. If the caller is on behalf of a delegated user who is assigned only to catalog-specific delegated administrative roles, the request must supply a filter to indicate a specific access package, such as: `$filter=accessPackage/id eq ''a914b616-e04e-476b-aa37-91038f0b165b''`.' externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-catalogs?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_ListCatalogs + url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-assignments?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_ListAssignments parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' @@ -9186,20 +9551,14 @@ paths: enum: - id - id desc - - catalogType - - catalogType desc - - createdDateTime - - createdDateTime desc - - description - - description desc - - displayName - - displayName desc - - isExternallyVisible - - isExternallyVisible desc - - modifiedDateTime - - modifiedDateTime desc + - expiredDateTime + - expiredDateTime desc + - schedule + - schedule desc - state - state desc + - status + - status desc type: string - name: $select in: query @@ -9212,14 +9571,13 @@ paths: items: enum: - id - - catalogType - - createdDateTime - - description - - displayName - - isExternallyVisible - - modifiedDateTime + - expiredDateTime + - schedule - state - - accessPackages + - status + - accessPackage + - assignmentPolicy + - target type: string - name: $expand in: query @@ -9232,11 +9590,13 @@ paths: items: enum: - '*' - - accessPackages + - accessPackage + - assignmentPolicy + - target type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.accessPackageCatalogCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -9246,18 +9606,14 @@ paths: post: tags: - identityGovernance.entitlementManagement - summary: Create accessPackageCatalog - description: Create a new accessPackageCatalog object. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-post-catalogs?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_CreateCatalogs + summary: Create new navigation property to assignments for identityGovernance + operationId: identityGovernance.entitlementManagement_CreateAssignments requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' required: true responses: '201': @@ -9265,26 +9621,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}': + '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}': get: tags: - identityGovernance.entitlementManagement - summary: Get catalogs from identityGovernance - description: A container for access packages. - operationId: identityGovernance.entitlementManagement_GetCatalogs + summary: Get assignments from identityGovernance + description: The assignment of an access package to a subject for a period of time. + operationId: identityGovernance.entitlementManagement_GetAssignments parameters: - - name: accessPackageCatalog-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackageCatalog' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageCatalog + x-ms-docs-key-type: accessPackageAssignment - name: $select in: query description: Select properties to be returned @@ -9296,14 +9652,13 @@ paths: items: enum: - id - - catalogType - - createdDateTime - - description - - displayName - - isExternallyVisible - - modifiedDateTime + - expiredDateTime + - schedule - state - - accessPackages + - status + - accessPackage + - assignmentPolicy + - target type: string - name: $expand in: query @@ -9316,7 +9671,9 @@ paths: items: enum: - '*' - - accessPackages + - accessPackage + - assignmentPolicy + - target type: string responses: '200': @@ -9324,35 +9681,45 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' links: - accessPackages: - operationId: identityGovernance.entitlementManagement.Catalogs.ListAccessPackages + accessPackage: + operationId: identityGovernance.entitlementManagement.Assignments.GetAccessPackage parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + assignmentPolicy: + operationId: identityGovernance.entitlementManagement.Assignments.GetAssignmentPolicy + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + target: + operationId: identityGovernance.entitlementManagement.Assignments.GetTarget + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + reprocess: + operationId: identityGovernance.entitlementManagement.assignments.accessPackageAssignment.reprocess default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - identityGovernance.entitlementManagement - summary: Update the navigation property catalogs in identityGovernance - operationId: identityGovernance.entitlementManagement_UpdateCatalogs + summary: Update the navigation property assignments in identityGovernance + operationId: identityGovernance.entitlementManagement_UpdateAssignments parameters: - - name: accessPackageCatalog-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackageCatalog' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageCatalog + x-ms-docs-key-type: accessPackageAssignment requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' required: true responses: '204': @@ -9363,17 +9730,17 @@ paths: delete: tags: - identityGovernance.entitlementManagement - summary: Delete navigation property catalogs for identityGovernance - operationId: identityGovernance.entitlementManagement_DeleteCatalogs + summary: Delete navigation property assignments for identityGovernance + operationId: identityGovernance.entitlementManagement_DeleteAssignments parameters: - - name: accessPackageCatalog-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackageCatalog' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageCatalog + x-ms-docs-key-type: accessPackageAssignment - name: If-Match in: header description: ETag @@ -9386,50 +9753,22 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages': + '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/accessPackage': get: tags: - identityGovernance.entitlementManagement - summary: Get accessPackages from identityGovernance - description: The access packages in this catalog. Read-only. Nullable. - operationId: identityGovernance.entitlementManagement.catalogs_ListAccessPackages + summary: Get accessPackage from identityGovernance + description: Read-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters. + operationId: identityGovernance.entitlementManagement.assignments_GetAccessPackage parameters: - - name: accessPackageCatalog-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackageCatalog' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageCatalog - - $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 - - createdDateTime - - createdDateTime desc - - description - - description desc - - displayName - - displayName desc - - isHidden - - isHidden desc - - modifiedDateTime - - modifiedDateTime desc - type: string + x-ms-docs-key-type: accessPackageAssignment - name: $select in: query description: Select properties to be returned @@ -9446,8 +9785,11 @@ paths: - displayName - isHidden - modifiedDateTime + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -9460,73 +9802,59 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith - assignmentPolicies - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.accessPackageCollectionResponse' - default: - $ref: '#/components/responses/error' - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - x-ms-docs-operation-type: operation - post: - tags: - - identityGovernance.entitlementManagement - summary: Create new navigation property to accessPackages for identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs_CreateAccessPackages - parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackage' - required: true - responses: - '201': - description: Created navigation property. + description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.accessPackage' + links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + assignmentPolicies: + operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.ListAssignmentPolicies + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + catalog: + operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.GetCatalog + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.ListIncompatibleAccessPackages + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.assignments.AccessPackage.ListIncompatibleGroups + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}': + '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/assignmentPolicy': get: tags: - identityGovernance.entitlementManagement - summary: Get accessPackages from identityGovernance - description: The access packages in this catalog. Read-only. Nullable. - operationId: identityGovernance.entitlementManagement.catalogs_GetAccessPackages + summary: Get assignmentPolicy from identityGovernance + description: Read-only. Supports $filter (eq) on the id property and $expand query parameters. + operationId: identityGovernance.entitlementManagement.assignments_GetAssignmentPolicy parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackage' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackage + x-ms-docs-key-type: accessPackageAssignment - name: $select in: query description: Select properties to be returned @@ -9538,12 +9866,18 @@ paths: items: enum: - id + - allowedTargetScope + - automaticRequestSettings - createdDateTime - description - displayName - - isHidden + - expiration - modifiedDateTime - - assignmentPolicies + - requestApprovalSettings + - requestorSettings + - reviewSettings + - specificAllowedTargets + - accessPackage - catalog type: string - name: $expand @@ -9557,7 +9891,7 @@ paths: items: enum: - '*' - - assignmentPolicies + - accessPackage - catalog type: string responses: @@ -9566,123 +9900,59 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackage' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' links: - assignmentPolicies: - operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.ListAssignmentPolicies + accessPackage: + operationId: identityGovernance.entitlementManagement.assignments.AssignmentPolicy.GetAccessPackage parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id + accessPackageAssignment-id: $request.path.accessPackageAssignment-id catalog: - operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.GetCatalog + operationId: identityGovernance.entitlementManagement.assignments.AssignmentPolicy.GetCatalog parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id - getApplicablePolicyRequirements: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackageCatalog.accessPackages.accessPackage.getApplicablePolicyRequirements - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.entitlementManagement - summary: Update the navigation property accessPackages in identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs_UpdateAccessPackages - parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackage' - required: true - responses: - '204': - description: Success + accessPackageAssignment-id: $request.path.accessPackageAssignment-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - delete: + '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/microsoft.graph.reprocess': + post: tags: - - identityGovernance.entitlementManagement - summary: Delete navigation property accessPackages for identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs_DeleteAccessPackages + - identityGovernance.Actions + summary: Invoke action reprocess + operationId: identityGovernance.entitlementManagement.assignments_reprocess parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackage' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackage - - name: If-Match - in: header - description: ETag - style: simple - schema: - type: string + x-ms-docs-key-type: accessPackageAssignment responses: '204': description: Success default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies': + x-ms-docs-operation-type: action + '/identityGovernance/entitlementManagement/assignments/{accessPackageAssignment-id}/target': get: tags: - identityGovernance.entitlementManagement - summary: Get assignmentPolicies from identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListAssignmentPolicies + summary: Get target from identityGovernance + description: The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId. + operationId: identityGovernance.entitlementManagement.assignments_GetTarget parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id + - name: accessPackageAssignment-id in: path - description: 'key: id of accessPackage' + description: 'key: id of accessPackageAssignment' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackage - - $ref: '#/components/parameters/top' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/count' - - name: $orderby + x-ms-docs-key-type: accessPackageAssignment + - name: $select in: query - description: Order items by property values + description: Select properties to be returned style: form explode: false schema: @@ -9691,30 +9961,54 @@ paths: items: enum: - id - - id desc - - allowedTargetScope - - allowedTargetScope desc - - automaticRequestSettings - - automaticRequestSettings desc - - createdDateTime - - createdDateTime desc - - description - - description desc - displayName - - displayName desc - - expiration - - expiration desc - - modifiedDateTime - - modifiedDateTime desc - - requestApprovalSettings - - requestApprovalSettings desc - - requestorSettings - - requestorSettings desc - - reviewSettings - - reviewSettings desc - - specificAllowedTargets - - specificAllowedTargets desc + - email + - objectId + - onPremisesSecurityIdentifier + - principalName + - subjectType + - connectedOrganization + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - connectedOrganization type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackageSubject' + links: + connectedOrganization: + operationId: identityGovernance.entitlementManagement.assignments.Target.GetConnectedOrganization + parameters: + accessPackageAssignment-id: $request.path.accessPackageAssignment-id + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + /identityGovernance/entitlementManagement/assignments/microsoft.graph.additionalAccess(): + get: + tags: + - identityGovernance.Functions + summary: Invoke function additionalAccess + operationId: identityGovernance.entitlementManagement.assignments_additionalAccess + parameters: + - $ref: '#/components/parameters/top' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned @@ -9726,23 +10020,17 @@ paths: items: enum: - id - - allowedTargetScope - - automaticRequestSettings - - createdDateTime - - description - - displayName - - expiration - - modifiedDateTime - - requestApprovalSettings - - requestorSettings - - reviewSettings - - specificAllowedTargets + - expiredDateTime + - schedule + - state + - status - accessPackage - - catalog + - assignmentPolicy + - target type: string - - name: $expand + - name: $orderby in: query - description: Expand related entities + description: Order items by property values style: form explode: false schema: @@ -9750,89 +10038,146 @@ paths: type: array items: enum: - - '*' - - accessPackage - - catalog + - id + - id desc + - expiredDateTime + - expiredDateTime desc + - schedule + - schedule desc + - state + - state desc + - status + - status desc type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentPolicyCollectionResponse' + description: Success + content: + application/json: + schema: + title: Collection of accessPackageAssignment + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + additionalProperties: + type: object default: $ref: '#/components/responses/error' + x-ms-docs-operation-type: function x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore - x-ms-docs-operation-type: operation - post: + '/identityGovernance/entitlementManagement/assignments/microsoft.graph.additionalAccess(accessPackageId=''{accessPackageId}'',incompatibleAccessPackageId=''{incompatibleAccessPackageId}'')': + get: tags: - - identityGovernance.entitlementManagement - summary: Create new navigation property to assignmentPolicies for identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_CreateAssignmentPolicies + - identityGovernance.Functions + summary: Invoke function additionalAccess + operationId: identityGovernance.entitlementManagement.assignments_additionalAccess parameters: - - name: accessPackageCatalog-id + - name: accessPackageId in: path - description: 'key: id of accessPackageCatalog' + description: 'Usage: accessPackageId=''{accessPackageId}''' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id + nullable: true + - name: incompatibleAccessPackageId in: path - description: 'key: id of accessPackage' + description: 'Usage: incompatibleAccessPackageId=''{incompatibleAccessPackageId}''' required: true style: simple schema: type: string - x-ms-docs-key-type: accessPackage - requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' - required: true + nullable: true + - $ref: '#/components/parameters/top' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - expiredDateTime + - schedule + - state + - status + - accessPackage + - assignmentPolicy + - target + type: string + - name: $orderby + in: query + description: Order items by property values + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - id desc + - expiredDateTime + - expiredDateTime desc + - schedule + - schedule desc + - state + - state desc + - status + - status desc + type: string responses: - '201': - description: Created navigation property. + '200': + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + title: Collection of accessPackageAssignment + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}': + x-ms-docs-operation-type: function + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/assignments/microsoft.graph.filterByCurrentUser(on=''{on}'')': get: tags: - - identityGovernance.entitlementManagement - summary: Get assignmentPolicies from identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_GetAssignmentPolicies + - identityGovernance.Functions + summary: Invoke function filterByCurrentUser + operationId: identityGovernance.entitlementManagement.assignments_filterGraphBPreCurrentUser parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - - name: accessPackageAssignmentPolicy-id + - name: on in: path - description: 'key: id of accessPackageAssignmentPolicy' + description: 'Usage: on=''{on}''' required: true style: simple schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentFilterByCurrentUserOptions' + - $ref: '#/components/parameters/top' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned @@ -9844,23 +10189,17 @@ paths: items: enum: - id - - allowedTargetScope - - automaticRequestSettings - - createdDateTime - - description - - displayName - - expiration - - modifiedDateTime - - requestApprovalSettings - - requestorSettings - - reviewSettings - - specificAllowedTargets + - expiredDateTime + - schedule + - state + - status - accessPackage - - catalog + - assignmentPolicy + - target type: string - - name: $expand + - name: $orderby in: query - description: Expand related entities + description: Order items by property values style: form explode: false schema: @@ -9868,150 +10207,81 @@ paths: type: array items: enum: - - '*' - - accessPackage - - catalog + - id + - id desc + - expiredDateTime + - expiredDateTime desc + - schedule + - schedule desc + - state + - state desc + - status + - status desc type: string responses: '200': - description: Retrieved navigation property + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' - links: - accessPackage: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AssignmentPolicies.GetAccessPackage - parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id - catalog: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AssignmentPolicies.GetCatalog - parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.entitlementManagement - summary: Update the navigation property assignmentPolicies in identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_UpdateAssignmentPolicies - parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - - name: accessPackageAssignmentPolicy-id - in: path - description: 'key: id of accessPackageAssignmentPolicy' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - delete: - tags: - - identityGovernance.entitlementManagement - summary: Delete navigation property assignmentPolicies for identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_DeleteAssignmentPolicies - parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - - name: accessPackageAssignmentPolicy-id - in: path - description: 'key: id of accessPackageAssignmentPolicy' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy - - name: If-Match - in: header - description: ETag - style: simple - schema: - type: string - responses: - '204': - description: Success + title: Collection of accessPackageAssignment + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/accessPackage': + x-ms-docs-operation-type: function + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + /identityGovernance/entitlementManagement/catalogs: get: tags: - identityGovernance.entitlementManagement - summary: Get accessPackage from identityGovernance - description: Access package containing this policy. Read-only. - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies_GetAccessPackage + summary: List catalogs + description: Retrieve a list of accessPackageCatalog objects. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-catalogs?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_ListCatalogs parameters: - - name: accessPackageCatalog-id - in: path - description: 'key: id of accessPackageCatalog' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - - name: accessPackageAssignmentPolicy-id - in: path - description: 'key: id of accessPackageAssignmentPolicy' - required: true - style: simple + - $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: - type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy + uniqueItems: true + type: array + items: + enum: + - id + - id desc + - catalogType + - catalogType desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - isExternallyVisible + - isExternallyVisible desc + - modifiedDateTime + - modifiedDateTime desc + - state + - state desc + type: string - name: $select in: query description: Select properties to be returned @@ -10023,13 +10293,14 @@ paths: items: enum: - id + - catalogType - createdDateTime - description - displayName - - isHidden + - isExternallyVisible - modifiedDateTime - - assignmentPolicies - - catalog + - state + - accessPackages type: string - name: $expand in: query @@ -10042,39 +10313,50 @@ paths: items: enum: - '*' - - assignmentPolicies - - catalog + - accessPackages type: string responses: '200': - description: Retrieved navigation property + $ref: '#/components/responses/microsoft.graph.accessPackageCatalogCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.entitlementManagement + summary: Create accessPackageCatalog + description: Create a new accessPackageCatalog object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagement-post-catalogs?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_CreateCatalogs + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + required: true + responses: + '201': + description: Created navigation property. content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.accessPackage' - links: - assignmentPolicies: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.ListAssignmentPolicies - parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id - catalog: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.GetCatalog - parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/catalog': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}': get: tags: - identityGovernance.entitlementManagement - summary: Get catalog from identityGovernance - description: Catalog of the access package containing this policy. Read-only. - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies_GetCatalog + summary: Get catalogs from identityGovernance + description: A container for access packages. + operationId: identityGovernance.entitlementManagement_GetCatalogs parameters: - name: accessPackageCatalog-id in: path @@ -10084,22 +10366,6 @@ paths: schema: type: string x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - - name: accessPackageAssignmentPolicy-id - in: path - description: 'key: id of accessPackageAssignmentPolicy' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackageAssignmentPolicy - name: $select in: query description: Select properties to be returned @@ -10142,20 +10408,17 @@ paths: $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' links: accessPackages: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.Catalog.ListAccessPackages + operationId: identityGovernance.entitlementManagement.Catalogs.ListAccessPackages parameters: accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id - accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/catalog': - get: + patch: tags: - identityGovernance.entitlementManagement - summary: Get catalog from identityGovernance - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_GetCatalog + summary: Update the navigation property catalogs in identityGovernance + operationId: identityGovernance.entitlementManagement_UpdateCatalogs parameters: - name: accessPackageCatalog-id in: path @@ -10165,73 +10428,24 @@ paths: schema: type: string x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: accessPackage - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - catalogType - - createdDateTime - - description - - displayName - - isExternallyVisible - - modifiedDateTime - - state - - accessPackages - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - accessPackages - type: string + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + required: true responses: - '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' - links: - accessPackages: - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.Catalog.ListAccessPackages - parameters: - accessPackageCatalog-id: $request.path.accessPackageCatalog-id - accessPackage-id: $request.path.accessPackage-id + '204': + description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/microsoft.graph.getApplicablePolicyRequirements': - post: + delete: tags: - - identityGovernance.Actions - summary: Invoke action getApplicablePolicyRequirements - description: 'In Azure AD entitlement management, this action retrieves a list of accessPackageAssignmentRequestRequirements objects that the currently signed-in user can use to create an accessPackageAssignmentRequest. Each requirement object corresponds to an access package assignment policy that the currently signed-in user is allowed to request an assignment for.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/accesspackage-getapplicablepolicyrequirements?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_getApplicablePolicyRequirements + - identityGovernance.entitlementManagement + summary: Delete navigation property catalogs for identityGovernance + operationId: identityGovernance.entitlementManagement_DeleteCatalogs parameters: - name: accessPackageCatalog-id in: path @@ -10241,40 +10455,25 @@ paths: schema: type: string x-ms-docs-key-type: accessPackageCatalog - - name: accessPackage-id - in: path - description: 'key: id of accessPackage' - required: true + - name: If-Match + in: header + description: ETag style: simple schema: type: string - x-ms-docs-key-type: accessPackage responses: - '200': + '204': description: Success - content: - application/json: - schema: - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestRequirements' - additionalProperties: - type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/microsoft.graph.filterByCurrentUser(on=''{on}'')': + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages': get: tags: - - identityGovernance.Functions - summary: Invoke function filterByCurrentUser - operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_filterGraphBPreCurrentUser + - identityGovernance.entitlementManagement + summary: Get accessPackages from identityGovernance + description: The access packages in this catalog. Read-only. Nullable. + operationId: identityGovernance.entitlementManagement.catalogs_ListAccessPackages parameters: - name: accessPackageCatalog-id in: path @@ -10284,37 +10483,11 @@ paths: schema: type: string x-ms-docs-key-type: accessPackageCatalog - - name: on - in: path - description: 'Usage: on=''{on}''' - required: true - style: simple - schema: - $ref: '#/components/schemas/microsoft.graph.accessPackageFilterByCurrentUserOptions' - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - createdDateTime - - description - - displayName - - isHidden - - modifiedDateTime - - assignmentPolicies - - catalog - type: string - name: $orderby in: query description: Order items by property values @@ -10338,68 +10511,6 @@ paths: - modifiedDateTime - modifiedDateTime desc type: string - responses: - '200': - description: Success - content: - application/json: - schema: - title: Collection of accessPackage - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.accessPackage' - additionalProperties: - type: object - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: function - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - /identityGovernance/entitlementManagement/connectedOrganizations: - get: - tags: - - identityGovernance.entitlementManagement - summary: List connectedOrganizations - description: Retrieve a list of connectedOrganization objects. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-connectedorganizations?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_ListConnectedOrganizations - 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 - - createdDateTime - - createdDateTime desc - - description - - description desc - - displayName - - displayName desc - - identitySources - - identitySources desc - - modifiedDateTime - - modifiedDateTime desc - - state - - state desc - type: string - name: $select in: query description: Select properties to be returned @@ -10414,11 +10525,13 @@ paths: - createdDateTime - description - displayName - - identitySources + - isHidden - modifiedDateTime - - state - - externalSponsors - - internalSponsors + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -10431,12 +10544,15 @@ paths: items: enum: - '*' - - externalSponsors - - internalSponsors + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.connectedOrganizationCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -10446,14 +10562,23 @@ paths: post: tags: - identityGovernance.entitlementManagement - summary: Create new navigation property to connectedOrganizations for identityGovernance - operationId: identityGovernance.entitlementManagement_CreateConnectedOrganizations + summary: Create new navigation property to accessPackages for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs_CreateAccessPackages + parameters: + - name: accessPackageCatalog-id + in: path + description: 'key: id of accessPackageCatalog' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageCatalog requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + $ref: '#/components/schemas/microsoft.graph.accessPackage' required: true responses: '201': @@ -10461,26 +10586,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + $ref: '#/components/schemas/microsoft.graph.accessPackage' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}': get: tags: - identityGovernance.entitlementManagement - summary: Get connectedOrganizations from identityGovernance - description: References to a directory or domain of another organization whose users can request access. - operationId: identityGovernance.entitlementManagement_GetConnectedOrganizations + summary: Get accessPackages from identityGovernance + description: The access packages in this catalog. Read-only. Nullable. + operationId: identityGovernance.entitlementManagement.catalogs_GetAccessPackages parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - name: $select in: query description: Select properties to be returned @@ -10495,11 +10628,13 @@ paths: - createdDateTime - description - displayName - - identitySources + - isHidden - modifiedDateTime - - state - - externalSponsors - - internalSponsors + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -10512,8 +10647,11 @@ paths: items: enum: - '*' - - externalSponsors - - internalSponsors + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': @@ -10521,39 +10659,66 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + $ref: '#/components/schemas/microsoft.graph.accessPackage' links: - externalSponsors: - operationId: identityGovernance.entitlementManagement.ConnectedOrganizations.ListExternalSponsors + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.ListAccessPackagesIncompatibleGraphWPre parameters: - connectedOrganization-id: $request.path.connectedOrganization-id - internalSponsors: - operationId: identityGovernance.entitlementManagement.ConnectedOrganizations.ListInternalSponsors + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + assignmentPolicies: + operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.ListAssignmentPolicies parameters: - connectedOrganization-id: $request.path.connectedOrganization-id + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + catalog: + operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.GetCatalog + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.ListIncompatibleAccessPackages + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.catalogs.AccessPackages.ListIncompatibleGroups + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + getApplicablePolicyRequirements: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackageCatalog.accessPackages.accessPackage.getApplicablePolicyRequirements default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - identityGovernance.entitlementManagement - summary: Update the navigation property connectedOrganizations in identityGovernance - operationId: identityGovernance.entitlementManagement_UpdateConnectedOrganizations + summary: Update the navigation property accessPackages in identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs_UpdateAccessPackages parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + $ref: '#/components/schemas/microsoft.graph.accessPackage' required: true responses: '204': @@ -10564,17 +10729,25 @@ paths: delete: tags: - identityGovernance.entitlementManagement - summary: Delete navigation property connectedOrganizations for identityGovernance - operationId: identityGovernance.entitlementManagement_DeleteConnectedOrganizations + summary: Delete navigation property accessPackages for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs_DeleteAccessPackages parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - name: If-Match in: header description: ETag @@ -10587,25 +10760,29 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith': get: tags: - identityGovernance.entitlementManagement - summary: List externalSponsors - description: Retrieve a list of a connectedOrganization's external sponsors. The external sponsors are a set of users who can approve requests on behalf of other users from that connected organization. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/connectedorganization-list-externalsponsors?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListExternalSponsors + summary: Get accessPackagesIncompatibleWith from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListAccessPackagesIncompatibleGraphWPre parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -10623,8 +10800,16 @@ paths: enum: - id - id desc - - deletedDateTime - - deletedDateTime desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - isHidden + - isHidden desc + - modifiedDateTime + - modifiedDateTime desc type: string - name: $select in: query @@ -10637,7 +10822,16 @@ paths: items: enum: - id - - deletedDateTime + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -10650,108 +10844,155 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.directoryObjectCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation - post: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/accessPackagesIncompatibleWith/{accessPackage-id1}': + get: tags: - identityGovernance.entitlementManagement - summary: Create new navigation property to externalSponsors for identityGovernance - operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateExternalSponsors + summary: Get accessPackagesIncompatibleWith from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_GetAccessPackagesIncompatibleGraphWPre parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - required: true - responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/{directoryObject-id}/$ref': - delete: - tags: - - identityGovernance.entitlementManagement - summary: Delete ref of navigation property externalSponsors for identityGovernance - operationId: identityGovernance.entitlementManagement.connectedOrganizations_DeleteExternalSponsorsGraphBPreRef - parameters: - - name: connectedOrganization-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - - name: directoryObject-id + x-ms-docs-key-type: accessPackage + - name: accessPackage-id1 in: path - description: 'key: id of directoryObject' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: directoryObject - - name: If-Match - in: header - description: ETag - style: simple + x-ms-docs-key-type: accessPackage + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false schema: - type: string - - name: '@id' + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + - name: $expand in: query - description: Delete Uri + description: Expand related entities style: form explode: false schema: - type: string + uniqueItems: true + type: array + items: + enum: + - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string responses: - '204': - description: Success + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AccessPackagesIncompatibleGraphWPre.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + assignmentPolicies: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AccessPackagesIncompatibleWith.ListAssignmentPolicies + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + catalog: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AccessPackagesIncompatibleWith.GetCatalog + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AccessPackagesIncompatibleWith.ListIncompatibleAccessPackages + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AccessPackagesIncompatibleWith.ListIncompatibleGroups + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackage-id1: $request.path.accessPackage-id1 default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/$ref': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies': get: tags: - identityGovernance.entitlementManagement - summary: List externalSponsors - description: Retrieve a list of a connectedOrganization's external sponsors. The external sponsors are a set of users who can approve requests on behalf of other users from that connected organization. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/connectedorganization-list-externalsponsors?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListExternalSponsorsGraphBPreRef + summary: Get assignmentPolicies from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListAssignmentPolicies parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -10769,12 +11010,71 @@ paths: enum: - id - id desc - - deletedDateTime - - deletedDateTime desc - type: string - responses: + - allowedTargetScope + - allowedTargetScope desc + - automaticRequestSettings + - automaticRequestSettings desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - expiration + - expiration desc + - modifiedDateTime + - modifiedDateTime desc + - requestApprovalSettings + - requestApprovalSettings desc + - requestorSettings + - requestorSettings desc + - reviewSettings + - reviewSettings desc + - specificAllowedTargets + - specificAllowedTargets desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - allowedTargetScope + - automaticRequestSettings + - createdDateTime + - description + - displayName + - expiration + - modifiedDateTime + - requestApprovalSettings + - requestorSettings + - reviewSettings + - specificAllowedTargets + - accessPackage + - catalog + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - accessPackage + - catalog + type: string + responses: '200': - $ref: '#/components/responses/StringCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageAssignmentPolicyCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -10784,226 +11084,73 @@ paths: post: tags: - identityGovernance.entitlementManagement - summary: Create new navigation property ref to externalSponsors for identityGovernance - operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateExternalSponsorsGraphBPreRef + summary: Create new navigation property to assignmentPolicies for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_CreateAssignmentPolicies parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - $ref: '#/components/requestBodies/refPostBody' - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/microsoft.graph.getAvailableExtensionProperties': - post: - tags: - - identityGovernance.Actions - summary: Invoke action getAvailableExtensionProperties - description: "Return all directory extension definitions that have been registered in a directory, including through multi-tenant apps. The following entities support extension properties:\n+ user\n+ group\n+ administrativeUnit\n+ application\n+ device\n+ organization" - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations.externalSponsors_getAvailableExtensionProperties - parameters: - - name: connectedOrganization-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackage requestBody: - description: Action parameters + description: New navigation property content: application/json: schema: - type: object - properties: - isSyncedFromOnPremises: - type: boolean - default: false - nullable: true - additionalProperties: - type: object + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' required: true responses: - '200': - description: Success + '201': + description: Created navigation property. content: application/json: schema: - title: Collection of extensionProperty - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.extensionProperty' - additionalProperties: - type: object + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/microsoft.graph.getByIds': - post: + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}': + get: tags: - - identityGovernance.Actions - summary: Invoke action getByIds - description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to:' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations.externalSponsors_getGraphBPreIds + - identityGovernance.entitlementManagement + summary: Get assignmentPolicies from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_GetAssignmentPolicies parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - description: Action parameters - content: - application/json: - schema: - type: object - properties: - ids: - type: array - items: - type: string - types: - type: array - items: - type: string - nullable: true - additionalProperties: - type: object - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - title: Collection of directoryObject - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - additionalProperties: - type: object - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/microsoft.graph.validateProperties': - post: - tags: - - identityGovernance.Actions - summary: Invoke action validateProperties - description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy." - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations.externalSponsors_validateProperties - parameters: - - name: connectedOrganization-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - description: Action parameters - content: - application/json: - schema: - type: object - properties: - entityType: - type: string - nullable: true - displayName: - type: string - nullable: true - mailNickname: - type: string - nullable: true - onBehalfOfUserId: - pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' - type: string - format: uuid - nullable: true - additionalProperties: - type: object - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors': - get: - tags: - - identityGovernance.entitlementManagement - summary: List internalSponsors - description: Retrieve a list of a connectedOrganization's internal sponsors. The internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/connectedorganization-list-internalsponsors?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListInternalSponsors - parameters: - - name: connectedOrganization-id + x-ms-docs-key-type: accessPackage + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - - $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 - type: string + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: $select in: query description: Select properties to be returned @@ -11015,7 +11162,19 @@ paths: items: enum: - id - - deletedDateTime + - allowedTargetScope + - automaticRequestSettings + - createdDateTime + - description + - displayName + - expiration + - modifiedDateTime + - requestApprovalSettings + - requestorSettings + - reviewSettings + - specificAllowedTargets + - accessPackage + - catalog type: string - name: $expand in: query @@ -11028,116 +11187,152 @@ paths: items: enum: - '*' + - accessPackage + - catalog type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.directoryObjectCollectionResponse' + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + links: + accessPackage: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AssignmentPolicies.GetAccessPackage + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + catalog: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.AssignmentPolicies.GetCatalog + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore x-ms-docs-operation-type: operation - post: + patch: tags: - identityGovernance.entitlementManagement - summary: Create new navigation property to internalSponsors for identityGovernance - operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateInternalSponsors + summary: Update the navigation property assignmentPolicies in identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_UpdateAssignmentPolicies parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - name: accessPackageAssignmentPolicy-id + in: path + description: 'key: id of accessPackageAssignmentPolicy' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageAssignmentPolicy requestBody: - description: New navigation property + description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.directoryObject' + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' required: true responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.directoryObject' + '204': + description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/{directoryObject-id}/$ref': delete: tags: - identityGovernance.entitlementManagement - summary: Delete ref of navigation property internalSponsors for identityGovernance - operationId: identityGovernance.entitlementManagement.connectedOrganizations_DeleteInternalSponsorsGraphBPreRef + summary: Delete navigation property assignmentPolicies for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_DeleteAssignmentPolicies parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - - name: directoryObject-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of directoryObject' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: directoryObject + x-ms-docs-key-type: accessPackage + - name: accessPackageAssignmentPolicy-id + in: path + description: 'key: id of accessPackageAssignmentPolicy' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: If-Match in: header description: ETag style: simple schema: type: string - - name: '@id' - in: query - description: Delete Uri - style: form - explode: false - schema: - type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/$ref': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/accessPackage': get: tags: - identityGovernance.entitlementManagement - summary: List internalSponsors - description: Retrieve a list of a connectedOrganization's internal sponsors. The internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/connectedorganization-list-internalsponsors?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListInternalSponsorsGraphBPreRef + summary: Get accessPackage from identityGovernance + description: Access package containing this policy. Read-only. + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies_GetAccessPackage parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - - $ref: '#/components/parameters/top' - - $ref: '#/components/parameters/skip' - - $ref: '#/components/parameters/search' - - $ref: '#/components/parameters/filter' - - $ref: '#/components/parameters/count' - - name: $orderby + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - name: accessPackageAssignmentPolicy-id + in: path + description: 'key: id of accessPackageAssignmentPolicy' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageAssignmentPolicy + - name: $select in: query - description: Order items by property values + description: Select properties to be returned style: form explode: false schema: @@ -11146,214 +11341,107 @@ paths: items: enum: - id - - id desc - - deletedDateTime - - deletedDateTime desc + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': - $ref: '#/components/responses/StringCollectionResponse' + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + links: + accessPackagesIncompatibleWith: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.ListAccessPackagesIncompatibleGraphWPre + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + assignmentPolicies: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.ListAssignmentPolicies + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + catalog: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.GetCatalog + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + incompatibleAccessPackages: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.ListIncompatibleAccessPackages + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id + incompatibleGroups: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.AccessPackage.ListIncompatibleGroups + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore x-ms-docs-operation-type: operation - post: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/assignmentPolicies/{accessPackageAssignmentPolicy-id}/catalog': + get: tags: - identityGovernance.entitlementManagement - summary: Create new navigation property ref to internalSponsors for identityGovernance - operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateInternalSponsorsGraphBPreRef + summary: Get catalog from identityGovernance + description: Catalog of the access package containing this policy. Read-only. + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies_GetCatalog parameters: - - name: connectedOrganization-id + - name: accessPackageCatalog-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - $ref: '#/components/requestBodies/refPostBody' - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/microsoft.graph.getAvailableExtensionProperties': - post: - tags: - - identityGovernance.Actions - summary: Invoke action getAvailableExtensionProperties - description: "Return all directory extension definitions that have been registered in a directory, including through multi-tenant apps. The following entities support extension properties:\n+ user\n+ group\n+ administrativeUnit\n+ application\n+ device\n+ organization" - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations.internalSponsors_getAvailableExtensionProperties - parameters: - - name: connectedOrganization-id - in: path - description: 'key: id of connectedOrganization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - description: Action parameters - content: - application/json: - schema: - type: object - properties: - isSyncedFromOnPremises: - type: boolean - default: false - nullable: true - additionalProperties: - type: object - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - title: Collection of extensionProperty - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.extensionProperty' - additionalProperties: - type: object - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/microsoft.graph.getByIds': - post: - tags: - - identityGovernance.Actions - summary: Invoke action getByIds - description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to:' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations.internalSponsors_getGraphBPreIds - parameters: - - name: connectedOrganization-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - description: Action parameters - content: - application/json: - schema: - type: object - properties: - ids: - type: array - items: - type: string - types: - type: array - items: - type: string - nullable: true - additionalProperties: - type: object - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - title: Collection of directoryObject - type: object - properties: - value: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - additionalProperties: - type: object - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore - '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/microsoft.graph.validateProperties': - post: - tags: - - identityGovernance.Actions - summary: Invoke action validateProperties - description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy." - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement.connectedOrganizations.internalSponsors_validateProperties - parameters: - - name: connectedOrganization-id + x-ms-docs-key-type: accessPackage + - name: accessPackageAssignmentPolicy-id in: path - description: 'key: id of connectedOrganization' + description: 'key: id of accessPackageAssignmentPolicy' required: true style: simple schema: type: string - x-ms-docs-key-type: connectedOrganization - requestBody: - description: Action parameters - content: - application/json: - schema: - type: object - properties: - entityType: - type: string - nullable: true - displayName: - type: string - nullable: true - mailNickname: - type: string - nullable: true - onBehalfOfUserId: - pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' - type: string - format: uuid - nullable: true - additionalProperties: - type: object - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: action - /identityGovernance/entitlementManagement/settings: - get: - tags: - - identityGovernance.entitlementManagement - summary: Get entitlementManagementSettings - description: Retrieve the properties of an entitlementManagementSettings object. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagementsettings-get?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_GetSettings - parameters: + x-ms-docs-key-type: accessPackageAssignmentPolicy - name: $select in: query description: Select properties to be returned @@ -11365,8 +11453,14 @@ paths: items: enum: - id - - durationUntilExternalUserDeletedAfterBlocked - - externalUserLifecycleAction + - catalogType + - createdDateTime + - description + - displayName + - isExternallyVisible + - modifiedDateTime + - state + - accessPackages type: string - name: $expand in: query @@ -11379,6 +11473,7 @@ paths: items: enum: - '*' + - accessPackages type: string responses: '200': @@ -11386,57 +11481,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings' - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.entitlementManagement - summary: Update entitlementManagementSettings - description: Update an existing entitlementManagementSettings object to change one or more of its properties. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/entitlementmanagementsettings-update?view=graph-rest-1.0 - operationId: identityGovernance.entitlementManagement_UpdateSettings - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings' - required: true - responses: - '204': - description: Success + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + links: + accessPackages: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.assignmentPolicies.Catalog.ListAccessPackages + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id + accessPackageAssignmentPolicy-id: $request.path.accessPackageAssignmentPolicy-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - delete: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/catalog': + get: tags: - identityGovernance.entitlementManagement - summary: Delete navigation property settings for identityGovernance - operationId: identityGovernance.entitlementManagement_DeleteSettings + summary: Get catalog from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_GetCatalog parameters: - - name: If-Match - in: header - description: ETag + - name: accessPackageCatalog-id + in: path + description: 'key: id of accessPackageCatalog' + required: true style: simple schema: type: string - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - /identityGovernance/termsOfUse: - get: - tags: - - identityGovernance.termsOfUseContainer - summary: Get termsOfUse from identityGovernance - operationId: identityGovernance_GetTermsGraphOPreUse - parameters: + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - name: $select in: query description: Select properties to be returned @@ -11448,8 +11526,14 @@ paths: items: enum: - id - - agreementAcceptances - - agreements + - catalogType + - createdDateTime + - description + - displayName + - isExternallyVisible + - modifiedDateTime + - state + - accessPackages type: string - name: $expand in: query @@ -11462,8 +11546,7 @@ paths: items: enum: - '*' - - agreementAcceptances - - agreements + - accessPackages type: string responses: '200': @@ -11471,59 +11554,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.termsOfUseContainer' + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' links: - agreementAcceptances: - operationId: identityGovernance.TermsGraphOPreUse.ListAgreementAcceptances - agreements: - operationId: identityGovernance.TermsGraphOPreUse.ListAgreements - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property termsOfUse in identityGovernance - operationId: identityGovernance_UpdateTermsGraphOPreUse - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.termsOfUseContainer' - required: true - responses: - '204': - description: Success + accessPackages: + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages.Catalog.ListAccessPackages + parameters: + accessPackageCatalog-id: $request.path.accessPackageCatalog-id + accessPackage-id: $request.path.accessPackage-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - delete: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/incompatibleAccessPackages': + get: tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property termsOfUse for identityGovernance - operationId: identityGovernance_DeleteTermsGraphOPreUse + - identityGovernance.entitlementManagement + summary: Get incompatibleAccessPackages from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListIncompatibleAccessPackages parameters: - - name: If-Match - in: header - description: ETag + - name: accessPackageCatalog-id + in: path + description: 'key: id of accessPackageCatalog' + required: true style: simple schema: type: string - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - /identityGovernance/termsOfUse/agreementAcceptances: - get: - tags: - - identityGovernance.termsOfUseContainer - summary: Get agreementAcceptances from identityGovernance - description: Represents the current status of a user's response to a company's customizable terms of use agreement. - operationId: identityGovernance.termsGraphOPreUse_ListAgreementAcceptances - parameters: + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -11541,32 +11604,16 @@ paths: enum: - id - id desc - - agreementFileId - - agreementFileId desc - - agreementId - - agreementId desc - - deviceDisplayName - - deviceDisplayName desc - - deviceId - - deviceId desc - - deviceOSType - - deviceOSType desc - - deviceOSVersion - - deviceOSVersion desc - - expirationDateTime - - expirationDateTime desc - - recordedDateTime - - recordedDateTime desc - - state - - state desc - - userDisplayName - - userDisplayName desc - - userEmail - - userEmail desc - - userId - - userId desc - - userPrincipalName - - userPrincipalName desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - isHidden + - isHidden desc + - modifiedDateTime + - modifiedDateTime desc type: string - name: $select in: query @@ -11579,19 +11626,16 @@ paths: items: enum: - id - - agreementFileId - - agreementId - - deviceDisplayName - - deviceId - - deviceOSType - - deviceOSVersion - - expirationDateTime - - recordedDateTime - - state - - userDisplayName - - userEmail - - userId - - userPrincipalName + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - name: $expand in: query @@ -11604,165 +11648,94 @@ paths: items: enum: - '*' + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementAcceptanceCollectionResponse' + $ref: '#/components/responses/microsoft.graph.accessPackageCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation - post: - tags: - - identityGovernance.termsOfUseContainer - summary: Create new navigation property to agreementAcceptances for identityGovernance - operationId: identityGovernance.termsGraphOPreUse_CreateAgreementAcceptances - requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - required: true - responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreementAcceptances/{agreementAcceptance-id}': - get: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/incompatibleAccessPackages/{accessPackage-id1}/$ref': + delete: tags: - - identityGovernance.termsOfUseContainer - summary: Get agreementAcceptances from identityGovernance - description: Represents the current status of a user's response to a company's customizable terms of use agreement. - operationId: identityGovernance.termsGraphOPreUse_GetAgreementAcceptances + - identityGovernance.entitlementManagement + summary: Delete ref of navigation property incompatibleAccessPackages for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_DeleteIncompatibleAccessPackagesGraphBPreRef parameters: - - name: agreementAcceptance-id + - name: accessPackageCatalog-id in: path - description: 'key: id of agreementAcceptance' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementAcceptance - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - agreementFileId - - agreementId - - deviceDisplayName - - deviceId - - deviceOSType - - deviceOSVersion - - expirationDateTime - - recordedDateTime - - state - - userDisplayName - - userEmail - - userId - - userPrincipalName - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - type: string - responses: - '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property agreementAcceptances in identityGovernance - operationId: identityGovernance.termsGraphOPreUse_UpdateAgreementAcceptances - parameters: - - name: agreementAcceptance-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of agreementAcceptance' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementAcceptance - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - delete: - tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property agreementAcceptances for identityGovernance - operationId: identityGovernance.termsGraphOPreUse_DeleteAgreementAcceptances - parameters: - - name: agreementAcceptance-id + x-ms-docs-key-type: accessPackage + - name: accessPackage-id1 in: path - description: 'key: id of agreementAcceptance' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementAcceptance + x-ms-docs-key-type: accessPackage - name: If-Match in: header description: ETag style: simple schema: type: string + - name: '@id' + in: query + description: Delete Uri + style: form + explode: false + schema: + type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - /identityGovernance/termsOfUse/agreements: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/incompatibleAccessPackages/$ref': get: tags: - - identityGovernance.termsOfUseContainer - summary: List agreements - description: Retrieve a list of agreement objects. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/termsofusecontainer-list-agreements?view=graph-rest-1.0 - operationId: identityGovernance.termsGraphOPreUse_ListAgreements + - identityGovernance.entitlementManagement + summary: Get ref of incompatibleAccessPackages from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListIncompatibleAccessPackagesGraphBPreRef parameters: + - name: accessPackageCatalog-id + in: path + description: 'key: id of accessPackageCatalog' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -11780,55 +11753,20 @@ paths: enum: - id - id desc + - createdDateTime + - createdDateTime desc + - description + - description desc - displayName - displayName desc - - isPerDeviceAcceptanceRequired - - isPerDeviceAcceptanceRequired desc - - isViewingBeforeAcceptanceRequired - - isViewingBeforeAcceptanceRequired desc - - termsExpiration - - termsExpiration desc - - userReacceptRequiredFrequency - - userReacceptRequiredFrequency desc - type: string - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - displayName - - isPerDeviceAcceptanceRequired - - isViewingBeforeAcceptanceRequired - - termsExpiration - - userReacceptRequiredFrequency - - acceptances - - file - - files - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - acceptances - - file - - files + - isHidden + - isHidden desc + - modifiedDateTime + - modifiedDateTime desc type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementCollectionResponse' + $ref: '#/components/responses/StringCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -11837,46 +11775,153 @@ paths: x-ms-docs-operation-type: operation post: tags: - - identityGovernance.termsOfUseContainer - summary: Create agreement - description: Create a new agreement object. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/termsofusecontainer-post-agreements?view=graph-rest-1.0 - operationId: identityGovernance.termsGraphOPreUse_CreateAgreements + - identityGovernance.entitlementManagement + summary: Create new navigation property ref to incompatibleAccessPackages for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_CreateIncompatibleAccessPackagesGraphBPreRef + parameters: + - name: accessPackageCatalog-id + in: path + description: 'key: id of accessPackageCatalog' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreement' - required: true + $ref: '#/components/requestBodies/refPostBody' responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreement' + '204': + description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/incompatibleGroups': get: tags: - - identityGovernance.termsOfUseContainer - summary: Get agreements from identityGovernance - description: Represents a tenant's customizable terms of use agreement that's created and managed with Azure Active Directory (Azure AD). - operationId: identityGovernance.termsGraphOPreUse_GetAgreements + - identityGovernance.entitlementManagement + summary: Get incompatibleGroups from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListIncompatibleGroups parameters: - - name: agreement-id + - name: accessPackageCatalog-id in: path - description: 'key: id of agreement' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + - $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 + - assignedLabels + - assignedLabels desc + - assignedLicenses + - assignedLicenses desc + - classification + - classification desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - expirationDateTime + - expirationDateTime desc + - groupTypes + - groupTypes desc + - hasMembersWithLicenseErrors + - hasMembersWithLicenseErrors desc + - isAssignableToRole + - isAssignableToRole desc + - licenseProcessingState + - licenseProcessingState desc + - mail + - mail desc + - mailEnabled + - mailEnabled desc + - mailNickname + - mailNickname desc + - membershipRule + - membershipRule desc + - membershipRuleProcessingState + - membershipRuleProcessingState desc + - onPremisesDomainName + - onPremisesDomainName desc + - onPremisesLastSyncDateTime + - onPremisesLastSyncDateTime desc + - onPremisesNetBiosName + - onPremisesNetBiosName desc + - onPremisesProvisioningErrors + - onPremisesProvisioningErrors desc + - onPremisesSamAccountName + - onPremisesSamAccountName desc + - onPremisesSecurityIdentifier + - onPremisesSecurityIdentifier desc + - onPremisesSyncEnabled + - onPremisesSyncEnabled desc + - preferredDataLocation + - preferredDataLocation desc + - preferredLanguage + - preferredLanguage desc + - proxyAddresses + - proxyAddresses desc + - renewedDateTime + - renewedDateTime desc + - securityEnabled + - securityEnabled desc + - securityIdentifier + - securityIdentifier desc + - theme + - theme desc + - visibility + - visibility desc + - allowExternalSenders + - allowExternalSenders desc + - autoSubscribeNewMembers + - autoSubscribeNewMembers desc + - hideFromAddressLists + - hideFromAddressLists desc + - hideFromOutlookClients + - hideFromOutlookClients desc + - isSubscribedByMail + - isSubscribedByMail desc + - unseenCount + - unseenCount desc + - isArchived + - isArchived desc + type: string - name: $select in: query description: Select properties to be returned @@ -11888,14 +11933,72 @@ paths: items: enum: - id + - deletedDateTime + - assignedLabels + - assignedLicenses + - classification + - createdDateTime + - description - displayName - - isPerDeviceAcceptanceRequired - - isViewingBeforeAcceptanceRequired - - termsExpiration - - userReacceptRequiredFrequency - - acceptances - - file - - files + - expirationDateTime + - groupTypes + - hasMembersWithLicenseErrors + - isAssignableToRole + - licenseProcessingState + - mail + - mailEnabled + - mailNickname + - membershipRule + - membershipRuleProcessingState + - onPremisesDomainName + - onPremisesLastSyncDateTime + - onPremisesNetBiosName + - onPremisesProvisioningErrors + - onPremisesSamAccountName + - onPremisesSecurityIdentifier + - onPremisesSyncEnabled + - preferredDataLocation + - preferredLanguage + - proxyAddresses + - renewedDateTime + - securityEnabled + - securityIdentifier + - theme + - visibility + - allowExternalSenders + - autoSubscribeNewMembers + - hideFromAddressLists + - hideFromOutlookClients + - isSubscribedByMail + - unseenCount + - isArchived + - appRoleAssignments + - createdOnBehalfOf + - memberOf + - members + - membersWithLicenseErrors + - owners + - permissionGrants + - settings + - transitiveMemberOf + - transitiveMembers + - acceptedSenders + - calendar + - calendarView + - conversations + - events + - rejectedSenders + - threads + - drive + - drives + - sites + - extensions + - groupLifecyclePolicies + - planner + - onenote + - photo + - photos + - team type: string - name: $expand in: query @@ -11908,105 +12011,116 @@ paths: items: enum: - '*' - - acceptances - - file - - files + - appRoleAssignments + - createdOnBehalfOf + - memberOf + - members + - membersWithLicenseErrors + - owners + - permissionGrants + - settings + - transitiveMemberOf + - transitiveMembers + - acceptedSenders + - calendar + - calendarView + - conversations + - events + - rejectedSenders + - threads + - drive + - drives + - sites + - extensions + - groupLifecyclePolicies + - planner + - onenote + - photo + - photos + - team type: string responses: '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreement' - links: - acceptances: - operationId: identityGovernance.termsGraphOPreUse.Agreements.ListAcceptances - parameters: - agreement-id: $request.path.agreement-id - file: - operationId: identityGovernance.termsGraphOPreUse.Agreements.GetFile - parameters: - agreement-id: $request.path.agreement-id - files: - operationId: identityGovernance.termsGraphOPreUse.Agreements.ListFiles - parameters: - agreement-id: $request.path.agreement-id + $ref: '#/components/responses/microsoft.graph.groupCollectionResponse' default: $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore x-ms-docs-operation-type: operation - patch: + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/incompatibleGroups/{group-id}/$ref': + delete: tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property agreements in identityGovernance - operationId: identityGovernance.termsGraphOPreUse_UpdateAgreements + - identityGovernance.entitlementManagement + summary: Delete ref of navigation property incompatibleGroups for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_DeleteIncompatibleGroupsGraphBPreRef parameters: - - name: agreement-id + - name: accessPackageCatalog-id in: path - description: 'key: id of agreement' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreement' - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - delete: - tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property agreements for identityGovernance - operationId: identityGovernance.termsGraphOPreUse_DeleteAgreements - parameters: - - name: agreement-id + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id in: path - description: 'key: id of agreement' + description: 'key: id of accessPackage' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: accessPackage + - name: group-id + in: path + description: 'key: id of group' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: group - name: If-Match in: header description: ETag style: simple schema: type: string + - name: '@id' + in: query + description: Delete Uri + style: form + explode: false + schema: + type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances': + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/incompatibleGroups/$ref': get: tags: - - identityGovernance.termsOfUseContainer - summary: List acceptances - description: Get the details about the acceptance records for a specific agreement. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/agreement-list-acceptances?view=graph-rest-1.0 - operationId: identityGovernance.termsGraphOPreUse.agreements_ListAcceptances + - identityGovernance.entitlementManagement + summary: Get ref of incompatibleGroups from identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_ListIncompatibleGroupsGraphBPreRef parameters: - - name: agreement-id + - name: accessPackageCatalog-id in: path - description: 'key: id of agreement' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -12024,73 +12138,88 @@ paths: enum: - id - id desc - - agreementFileId - - agreementFileId desc - - agreementId - - agreementId desc - - deviceDisplayName - - deviceDisplayName desc - - deviceId - - deviceId desc - - deviceOSType - - deviceOSType desc - - deviceOSVersion - - deviceOSVersion desc + - deletedDateTime + - deletedDateTime desc + - assignedLabels + - assignedLabels desc + - assignedLicenses + - assignedLicenses desc + - classification + - classification desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc - expirationDateTime - expirationDateTime desc - - recordedDateTime - - recordedDateTime desc - - state - - state desc - - userDisplayName - - userDisplayName desc - - userEmail - - userEmail desc - - userId - - userId desc - - userPrincipalName - - userPrincipalName desc - type: string - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - agreementFileId - - agreementId - - deviceDisplayName - - deviceId - - deviceOSType - - deviceOSVersion - - expirationDateTime - - recordedDateTime - - state - - userDisplayName - - userEmail - - userId - - userPrincipalName - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' + - groupTypes + - groupTypes desc + - hasMembersWithLicenseErrors + - hasMembersWithLicenseErrors desc + - isAssignableToRole + - isAssignableToRole desc + - licenseProcessingState + - licenseProcessingState desc + - mail + - mail desc + - mailEnabled + - mailEnabled desc + - mailNickname + - mailNickname desc + - membershipRule + - membershipRule desc + - membershipRuleProcessingState + - membershipRuleProcessingState desc + - onPremisesDomainName + - onPremisesDomainName desc + - onPremisesLastSyncDateTime + - onPremisesLastSyncDateTime desc + - onPremisesNetBiosName + - onPremisesNetBiosName desc + - onPremisesProvisioningErrors + - onPremisesProvisioningErrors desc + - onPremisesSamAccountName + - onPremisesSamAccountName desc + - onPremisesSecurityIdentifier + - onPremisesSecurityIdentifier desc + - onPremisesSyncEnabled + - onPremisesSyncEnabled desc + - preferredDataLocation + - preferredDataLocation desc + - preferredLanguage + - preferredLanguage desc + - proxyAddresses + - proxyAddresses desc + - renewedDateTime + - renewedDateTime desc + - securityEnabled + - securityEnabled desc + - securityIdentifier + - securityIdentifier desc + - theme + - theme desc + - visibility + - visibility desc + - allowExternalSenders + - allowExternalSenders desc + - autoSubscribeNewMembers + - autoSubscribeNewMembers desc + - hideFromAddressLists + - hideFromAddressLists desc + - hideFromOutlookClients + - hideFromOutlookClients desc + - isSubscribedByMail + - isSubscribedByMail desc + - unseenCount + - unseenCount desc + - isArchived + - isArchived desc type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementAcceptanceCollectionResponse' + $ref: '#/components/responses/StringCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -12099,59 +12228,108 @@ paths: x-ms-docs-operation-type: operation post: tags: - - identityGovernance.termsOfUseContainer - summary: Create new navigation property to acceptances for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_CreateAcceptances + - identityGovernance.entitlementManagement + summary: Create new navigation property ref to incompatibleGroups for identityGovernance + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_CreateIncompatibleGroupsGraphBPreRef parameters: - - name: agreement-id + - name: accessPackageCatalog-id in: path - description: 'key: id of agreement' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - required: true + $ref: '#/components/requestBodies/refPostBody' responses: - '201': - description: Created navigation property. + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/{accessPackage-id}/microsoft.graph.getApplicablePolicyRequirements': + post: + tags: + - identityGovernance.Actions + summary: Invoke action getApplicablePolicyRequirements + description: 'In Azure AD entitlement management, this action retrieves a list of accessPackageAssignmentRequestRequirements objects that the currently signed-in user can use to create an accessPackageAssignmentRequest. Each requirement object corresponds to an access package assignment policy that the currently signed-in user is allowed to request an assignment for.' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/accesspackage-getapplicablepolicyrequirements?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_getApplicablePolicyRequirements + parameters: + - name: accessPackageCatalog-id + in: path + description: 'key: id of accessPackageCatalog' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackageCatalog + - name: accessPackage-id + in: path + description: 'key: id of accessPackage' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: accessPackage + responses: + '200': + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestRequirements' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}': + x-ms-docs-operation-type: action + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/catalogs/{accessPackageCatalog-id}/accessPackages/microsoft.graph.filterByCurrentUser(on=''{on}'')': get: tags: - - identityGovernance.termsOfUseContainer - summary: Get acceptances from identityGovernance - description: Read-only. Information about acceptances of this agreement. - operationId: identityGovernance.termsGraphOPreUse.agreements_GetAcceptances + - identityGovernance.Functions + summary: Invoke function filterByCurrentUser + operationId: identityGovernance.entitlementManagement.catalogs.accessPackages_filterGraphBPreCurrentUser parameters: - - name: agreement-id + - name: accessPackageCatalog-id in: path - description: 'key: id of agreement' + description: 'key: id of accessPackageCatalog' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement - - name: agreementAcceptance-id + x-ms-docs-key-type: accessPackageCatalog + - name: on in: path - description: 'key: id of agreementAcceptance' + description: 'Usage: on=''{on}''' required: true style: simple schema: - type: string - x-ms-docs-key-type: agreementAcceptance + $ref: '#/components/schemas/microsoft.graph.accessPackageFilterByCurrentUserOptions' + - $ref: '#/components/parameters/top' + - $ref: '#/components/parameters/skip' + - $ref: '#/components/parameters/search' + - $ref: '#/components/parameters/filter' + - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned @@ -12163,23 +12341,20 @@ paths: items: enum: - id - - agreementFileId - - agreementId - - deviceDisplayName - - deviceId - - deviceOSType - - deviceOSVersion - - expirationDateTime - - recordedDateTime - - state - - userDisplayName - - userEmail - - userId - - userPrincipalName + - createdDateTime + - description + - displayName + - isHidden + - modifiedDateTime + - accessPackagesIncompatibleWith + - assignmentPolicies + - catalog + - incompatibleAccessPackages + - incompatibleGroups type: string - - name: $expand + - name: $orderby in: query - description: Expand related entities + description: Order items by property values style: form explode: false schema: @@ -12187,106 +12362,162 @@ paths: type: array items: enum: - - '*' + - id + - id desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - isHidden + - isHidden desc + - modifiedDateTime + - modifiedDateTime desc type: string responses: '200': - description: Retrieved navigation property + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + title: Collection of accessPackage + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: + x-ms-docs-operation-type: function + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + /identityGovernance/entitlementManagement/connectedOrganizations: + get: tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property acceptances in identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_UpdateAcceptances + - identityGovernance.entitlementManagement + summary: List connectedOrganizations + description: Retrieve a list of connectedOrganization objects. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagement-list-connectedorganizations?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_ListConnectedOrganizations parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple + - $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: - type: string - x-ms-docs-key-type: agreement - - name: agreementAcceptance-id - in: path - description: 'key: id of agreementAcceptance' - required: true - style: simple + uniqueItems: true + type: array + items: + enum: + - id + - id desc + - createdDateTime + - createdDateTime desc + - description + - description desc + - displayName + - displayName desc + - identitySources + - identitySources desc + - modifiedDateTime + - modifiedDateTime desc + - state + - state desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false schema: - type: string - x-ms-docs-key-type: agreementAcceptance - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - required: true + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - description + - displayName + - identitySources + - modifiedDateTime + - state + - externalSponsors + - internalSponsors + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - externalSponsors + - internalSponsors + type: string responses: - '204': - description: Success + '200': + $ref: '#/components/responses/microsoft.graph.connectedOrganizationCollectionResponse' default: $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore x-ms-docs-operation-type: operation - delete: + post: tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property acceptances for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_DeleteAcceptances - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementAcceptance-id - in: path - description: 'key: id of agreementAcceptance' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementAcceptance - - name: If-Match - in: header - description: ETag - style: simple - schema: - type: string + - identityGovernance.entitlementManagement + summary: Create new navigation property to connectedOrganizations for identityGovernance + operationId: identityGovernance.entitlementManagement_CreateConnectedOrganizations + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + required: true responses: - '204': - description: Success + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/file': + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}': get: tags: - - identityGovernance.termsOfUseContainer - summary: Get agreementFile - description: 'Retrieve the details of the default file for an agreement, including the language and version information. The file information is specified through the agreementFile object.' - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/agreementfile-get?view=graph-rest-1.0 - operationId: identityGovernance.termsGraphOPreUse.agreements_GetFile + - identityGovernance.entitlementManagement + summary: Get connectedOrganizations from identityGovernance + description: References to a directory or domain of another organization whose users can request access. + operationId: identityGovernance.entitlementManagement_GetConnectedOrganizations parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization - name: $select in: query description: Select properties to be returned @@ -12299,13 +12530,13 @@ paths: enum: - id - createdDateTime + - description - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - - localizations + - identitySources + - modifiedDateTime + - state + - externalSponsors + - internalSponsors type: string - name: $expand in: query @@ -12318,7 +12549,8 @@ paths: items: enum: - '*' - - localizations + - externalSponsors + - internalSponsors type: string responses: '200': @@ -12326,35 +12558,39 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFile' + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' links: - localizations: - operationId: identityGovernance.termsGraphOPreUse.agreements.File.ListLocalizations + externalSponsors: + operationId: identityGovernance.entitlementManagement.ConnectedOrganizations.ListExternalSponsors parameters: - agreement-id: $request.path.agreement-id + connectedOrganization-id: $request.path.connectedOrganization-id + internalSponsors: + operationId: identityGovernance.entitlementManagement.ConnectedOrganizations.ListInternalSponsors + parameters: + connectedOrganization-id: $request.path.connectedOrganization-id default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property file in identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_UpdateFile + - identityGovernance.entitlementManagement + summary: Update the navigation property connectedOrganizations in identityGovernance + operationId: identityGovernance.entitlementManagement_UpdateConnectedOrganizations parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFile' + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' required: true responses: '204': @@ -12364,18 +12600,18 @@ paths: x-ms-docs-operation-type: operation delete: tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property file for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_DeleteFile + - identityGovernance.entitlementManagement + summary: Delete navigation property connectedOrganizations for identityGovernance + operationId: identityGovernance.entitlementManagement_DeleteConnectedOrganizations parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization - name: If-Match in: header description: ETag @@ -12388,22 +12624,25 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations': + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors': get: tags: - - identityGovernance.termsOfUseContainer - summary: Get localizations from identityGovernance - description: The localized version of the terms of use agreement files attached to the agreement. - operationId: identityGovernance.termsGraphOPreUse.agreements.file_ListLocalizations + - identityGovernance.entitlementManagement + summary: List externalSponsors + description: Retrieve a list of a connectedOrganization's external sponsors. The external sponsors are a set of users who can approve requests on behalf of other users from that connected organization. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/connectedorganization-list-externalsponsors?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListExternalSponsors parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -12421,20 +12660,8 @@ paths: enum: - id - id desc - - createdDateTime - - createdDateTime desc - - displayName - - displayName desc - - fileData - - fileData desc - - fileName - - fileName desc - - isDefault - - isDefault desc - - isMajorVersion - - isMajorVersion desc - - language - - language desc + - deletedDateTime + - deletedDateTime desc type: string - name: $select in: query @@ -12447,14 +12674,7 @@ paths: items: enum: - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - - versions + - deletedDateTime type: string - name: $expand in: query @@ -12467,11 +12687,10 @@ paths: items: enum: - '*' - - versions type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementFileLocalizationCollectionResponse' + $ref: '#/components/responses/microsoft.graph.directoryObjectCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -12480,24 +12699,24 @@ paths: x-ms-docs-operation-type: operation post: tags: - - identityGovernance.termsOfUseContainer - summary: Create new navigation property to localizations for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.file_CreateLocalizations + - identityGovernance.entitlementManagement + summary: Create new navigation property to externalSponsors for identityGovernance + operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateExternalSponsors parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization requestBody: description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + $ref: '#/components/schemas/microsoft.graph.directoryObject' required: true responses: '201': @@ -12505,176 +12724,71 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}': - get: - tags: - - identityGovernance.termsOfUseContainer - summary: Get localizations from identityGovernance - description: The localized version of the terms of use agreement files attached to the agreement. - operationId: identityGovernance.termsGraphOPreUse.agreements.file_GetLocalizations - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - - versions - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - versions - type: string - responses: - '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' - links: - versions: - operationId: identityGovernance.termsGraphOPreUse.agreements.file.Localizations.ListVersions - parameters: - agreement-id: $request.path.agreement-id - agreementFileLocalization-id: $request.path.agreementFileLocalization-id - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property localizations in identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.file_UpdateLocalizations - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' - required: true - responses: - '204': - description: Success + $ref: '#/components/schemas/microsoft.graph.directoryObject' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/{directoryObject-id}/$ref': delete: tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property localizations for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.file_DeleteLocalizations + - identityGovernance.entitlementManagement + summary: Delete ref of navigation property externalSponsors for identityGovernance + operationId: identityGovernance.entitlementManagement.connectedOrganizations_DeleteExternalSponsorsGraphBPreRef parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id + x-ms-docs-key-type: connectedOrganization + - name: directoryObject-id in: path - description: 'key: id of agreementFileLocalization' + description: 'key: id of directoryObject' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileLocalization + x-ms-docs-key-type: directoryObject - name: If-Match in: header description: ETag style: simple schema: type: string + - name: '@id' + in: query + description: Delete Uri + style: form + explode: false + schema: + type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions': + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/$ref': get: tags: - - identityGovernance.termsOfUseContainer - summary: Get versions from identityGovernance - description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. - operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_ListVersions + - identityGovernance.entitlementManagement + summary: List externalSponsors + description: Retrieve a list of a connectedOrganization's external sponsors. The external sponsors are a set of users who can approve requests on behalf of other users from that connected organization. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/connectedorganization-list-externalsponsors?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListExternalSponsorsGraphBPreRef parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileLocalization' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileLocalization + x-ms-docs-key-type: connectedOrganization - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -12692,55 +12806,12 @@ paths: enum: - id - id desc - - createdDateTime - - createdDateTime desc - - displayName - - displayName desc - - fileData - - fileData desc - - fileName - - fileName desc - - isDefault - - isDefault desc - - isMajorVersion - - isMajorVersion desc - - language - - language desc - type: string - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' + - deletedDateTime + - deletedDateTime desc type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementFileVersionCollectionResponse' + $ref: '#/components/responses/StringCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -12749,75 +12820,227 @@ paths: x-ms-docs-operation-type: operation post: tags: - - identityGovernance.termsOfUseContainer - summary: Create new navigation property to versions for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_CreateVersions + - identityGovernance.entitlementManagement + summary: Create new navigation property ref to externalSponsors for identityGovernance + operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateExternalSponsorsGraphBPreRef parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileLocalization' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileLocalization + x-ms-docs-key-type: connectedOrganization requestBody: - description: New navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' - required: true + $ref: '#/components/requestBodies/refPostBody' responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + '204': + description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}': - get: + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/microsoft.graph.getAvailableExtensionProperties': + post: tags: - - identityGovernance.termsOfUseContainer - summary: Get versions from identityGovernance - description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. - operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_GetVersions + - identityGovernance.Actions + summary: Invoke action getAvailableExtensionProperties + description: "Return all directory extension definitions that have been registered in a directory, including through multi-tenant apps. The following entities support extension properties:\n+ user\n+ group\n+ administrativeUnit\n+ application\n+ device\n+ organization" + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations.externalSponsors_getAvailableExtensionProperties parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id + x-ms-docs-key-type: connectedOrganization + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + isSyncedFromOnPremises: + type: boolean + default: false + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + title: Collection of extensionProperty + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.extensionProperty' + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/microsoft.graph.getByIds': + post: + tags: + - identityGovernance.Actions + summary: Invoke action getByIds + description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to:' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations.externalSponsors_getGraphBPreIds + parameters: + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileLocalization' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileLocalization - - name: agreementFileVersion-id + x-ms-docs-key-type: connectedOrganization + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + ids: + type: array + items: + type: string + types: + type: array + items: + type: string + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + title: Collection of directoryObject + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/externalSponsors/microsoft.graph.validateProperties': + post: + tags: + - identityGovernance.Actions + summary: Invoke action validateProperties + description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy." + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations.externalSponsors_validateProperties + parameters: + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileVersion' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileVersion + x-ms-docs-key-type: connectedOrganization + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + entityType: + type: string + nullable: true + displayName: + type: string + nullable: true + mailNickname: + type: string + nullable: true + onBehalfOfUserId: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + format: uuid + nullable: true + additionalProperties: + type: object + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors': + get: + tags: + - identityGovernance.entitlementManagement + summary: List internalSponsors + description: Retrieve a list of a connectedOrganization's internal sponsors. The internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/connectedorganization-list-internalsponsors?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListInternalSponsors + parameters: + - name: connectedOrganization-id + in: path + description: 'key: id of connectedOrganization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: connectedOrganization + - $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 + type: string - name: $select in: query description: Select properties to be returned @@ -12829,13 +13052,7 @@ paths: items: enum: - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language + - deletedDateTime type: string - name: $expand in: query @@ -12851,115 +13068,105 @@ paths: type: string responses: '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + $ref: '#/components/responses/microsoft.graph.directoryObjectCollectionResponse' default: $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore x-ms-docs-operation-type: operation - patch: + post: tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property versions in identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_UpdateVersions + - identityGovernance.entitlementManagement + summary: Create new navigation property to internalSponsors for identityGovernance + operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateInternalSponsors parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - - name: agreementFileVersion-id + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileVersion' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileVersion + x-ms-docs-key-type: connectedOrganization requestBody: - description: New navigation property values + description: New navigation property content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + $ref: '#/components/schemas/microsoft.graph.directoryObject' required: true responses: - '204': - description: Success + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.directoryObject' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/{directoryObject-id}/$ref': delete: tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property versions for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_DeleteVersions + - identityGovernance.entitlementManagement + summary: Delete ref of navigation property internalSponsors for identityGovernance + operationId: identityGovernance.entitlementManagement.connectedOrganizations_DeleteInternalSponsorsGraphBPreRef parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileLocalization' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileLocalization - - name: agreementFileVersion-id + x-ms-docs-key-type: connectedOrganization + - name: directoryObject-id in: path - description: 'key: id of agreementFileVersion' + description: 'key: id of directoryObject' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileVersion + x-ms-docs-key-type: directoryObject - name: If-Match in: header description: ETag style: simple schema: type: string + - name: '@id' + in: query + description: Delete Uri + style: form + explode: false + schema: + type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/files': + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/$ref': get: tags: - - identityGovernance.termsOfUseContainer - summary: Get files from identityGovernance - description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. - operationId: identityGovernance.termsGraphOPreUse.agreements_ListFiles + - identityGovernance.entitlementManagement + summary: List internalSponsors + description: Retrieve a list of a connectedOrganization's internal sponsors. The internal sponsors are a set of users who can approve requests on behalf of other users from that connected organization. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/connectedorganization-list-internalsponsors?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations_ListInternalSponsorsGraphBPreRef parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -12977,57 +13184,12 @@ paths: enum: - id - id desc - - createdDateTime - - createdDateTime desc - - displayName - - displayName desc - - fileData - - fileData desc - - fileName - - fileName desc - - isDefault - - isDefault desc - - isMajorVersion - - isMajorVersion desc - - language - - language desc - type: string - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - - versions - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - - versions + - deletedDateTime + - deletedDateTime desc type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementFileLocalizationCollectionResponse' + $ref: '#/components/responses/StringCollectionResponse' default: $ref: '#/components/responses/error' x-ms-pageable: @@ -13036,63 +13198,199 @@ paths: x-ms-docs-operation-type: operation post: tags: - - identityGovernance.termsOfUseContainer - summary: Create agreementFileLocalization - description: Create a new localized agreement file. + - identityGovernance.entitlementManagement + summary: Create new navigation property ref to internalSponsors for identityGovernance + operationId: identityGovernance.entitlementManagement.connectedOrganizations_CreateInternalSponsorsGraphBPreRef + parameters: + - name: connectedOrganization-id + in: path + description: 'key: id of connectedOrganization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: connectedOrganization + requestBody: + $ref: '#/components/requestBodies/refPostBody' + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/microsoft.graph.getAvailableExtensionProperties': + post: + tags: + - identityGovernance.Actions + summary: Invoke action getAvailableExtensionProperties + description: "Return all directory extension definitions that have been registered in a directory, including through multi-tenant apps. The following entities support extension properties:\n+ user\n+ group\n+ administrativeUnit\n+ application\n+ device\n+ organization" externalDocs: description: Find more info here - url: https://docs.microsoft.com/graph/api/agreement-post-files?view=graph-rest-1.0 - operationId: identityGovernance.termsGraphOPreUse.agreements_CreateFiles + url: https://docs.microsoft.com/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations.internalSponsors_getAvailableExtensionProperties parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement + x-ms-docs-key-type: connectedOrganization requestBody: - description: New navigation property + description: Action parameters content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + type: object + properties: + isSyncedFromOnPremises: + type: boolean + default: false + nullable: true + additionalProperties: + type: object required: true responses: - '201': - description: Created navigation property. + '200': + description: Success content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + title: Collection of extensionProperty + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.extensionProperty' + additionalProperties: + type: object default: $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}': - get: + x-ms-docs-operation-type: action + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/microsoft.graph.getByIds': + post: tags: - - identityGovernance.termsOfUseContainer - summary: Get files from identityGovernance - description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. - operationId: identityGovernance.termsGraphOPreUse.agreements_GetFiles + - identityGovernance.Actions + summary: Invoke action getByIds + description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to:' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations.internalSponsors_getGraphBPreIds parameters: - - name: agreement-id + - name: connectedOrganization-id in: path - description: 'key: id of agreement' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id + x-ms-docs-key-type: connectedOrganization + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + ids: + type: array + items: + type: string + types: + type: array + items: + type: string + nullable: true + additionalProperties: + type: object + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + title: Collection of directoryObject + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + additionalProperties: + type: object + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + '/identityGovernance/entitlementManagement/connectedOrganizations/{connectedOrganization-id}/internalSponsors/microsoft.graph.validateProperties': + post: + tags: + - identityGovernance.Actions + summary: Invoke action validateProperties + description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. To validate the properties of an existing group, use the group: validateProperties function. The following policy validations are performed for the display name and mail nickname properties:\n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate that the mail nickname is unique This API only returns the first validation failure that is encountered. If the properties fail multiple validations, only the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. To learn more about configuring naming policies, see Configure naming policy." + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement.connectedOrganizations.internalSponsors_validateProperties + parameters: + - name: connectedOrganization-id in: path - description: 'key: id of agreementFileLocalization' + description: 'key: id of connectedOrganization' required: true style: simple schema: type: string - x-ms-docs-key-type: agreementFileLocalization + x-ms-docs-key-type: connectedOrganization + requestBody: + description: Action parameters + content: + application/json: + schema: + type: object + properties: + entityType: + type: string + nullable: true + displayName: + type: string + nullable: true + mailNickname: + type: string + nullable: true + onBehalfOfUserId: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + format: uuid + nullable: true + additionalProperties: + type: object + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: action + /identityGovernance/entitlementManagement/settings: + get: + tags: + - identityGovernance.entitlementManagement + summary: Get entitlementManagementSettings + description: Retrieve the properties of an entitlementManagementSettings object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagementsettings-get?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_GetSettings + parameters: - name: $select in: query description: Select properties to be returned @@ -13104,14 +13402,8 @@ paths: items: enum: - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - - versions + - durationUntilExternalUserDeletedAfterBlocked + - externalUserLifecycleAction type: string - name: $expand in: query @@ -13124,7 +13416,6 @@ paths: items: enum: - '*' - - versions type: string responses: '200': @@ -13132,44 +13423,25 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' - links: - versions: - operationId: identityGovernance.termsGraphOPreUse.agreements.Files.ListVersions - parameters: - agreement-id: $request.path.agreement-id - agreementFileLocalization-id: $request.path.agreementFileLocalization-id + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property files in identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_UpdateFiles - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization + - identityGovernance.entitlementManagement + summary: Update entitlementManagementSettings + description: Update an existing entitlementManagementSettings object to change one or more of its properties. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/entitlementmanagementsettings-update?view=graph-rest-1.0 + operationId: identityGovernance.entitlementManagement_UpdateSettings requestBody: description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings' required: true responses: '204': @@ -13179,26 +13451,10 @@ paths: x-ms-docs-operation-type: operation delete: tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property files for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements_DeleteFiles + - identityGovernance.entitlementManagement + summary: Delete navigation property settings for identityGovernance + operationId: identityGovernance.entitlementManagement_DeleteSettings parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - name: If-Match in: header description: ETag @@ -13211,62 +13467,13 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions': + /identityGovernance/termsOfUse: get: tags: - identityGovernance.termsOfUseContainer - summary: Get versions from identityGovernance - description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. - operationId: identityGovernance.termsGraphOPreUse.agreements.files_ListVersions + summary: Get termsOfUse from identityGovernance + operationId: identityGovernance_GetTermsGraphOPreUse parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - - $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 - - createdDateTime - - createdDateTime desc - - displayName - - displayName desc - - fileData - - fileData desc - - fileName - - fileName desc - - isDefault - - isDefault desc - - isMajorVersion - - isMajorVersion desc - - language - - language desc - type: string - name: $select in: query description: Select properties to be returned @@ -13278,13 +13485,8 @@ paths: items: enum: - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language + - agreementAcceptances + - agreements type: string - name: $expand in: query @@ -13297,204 +13499,51 @@ paths: items: enum: - '*' + - agreementAcceptances + - agreements type: string responses: '200': - $ref: '#/components/responses/microsoft.graph.agreementFileVersionCollectionResponse' + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.termsOfUseContainer' + links: + agreementAcceptances: + operationId: identityGovernance.TermsGraphOPreUse.ListAgreementAcceptances + agreements: + operationId: identityGovernance.TermsGraphOPreUse.ListAgreements default: $ref: '#/components/responses/error' - x-ms-pageable: - nextLinkName: '@odata.nextLink' - operationName: listMore x-ms-docs-operation-type: operation - post: + patch: tags: - identityGovernance.termsOfUseContainer - summary: Create new navigation property to versions for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.files_CreateVersions - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization + summary: Update the navigation property termsOfUse in identityGovernance + operationId: identityGovernance_UpdateTermsGraphOPreUse requestBody: - description: New navigation property + description: New navigation property values content: application/json: schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + $ref: '#/components/schemas/microsoft.graph.termsOfUseContainer' required: true responses: - '201': - description: Created navigation property. - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + '204': + description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}': - get: + delete: tags: - identityGovernance.termsOfUseContainer - summary: Get versions from identityGovernance - description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. - operationId: identityGovernance.termsGraphOPreUse.agreements.files_GetVersions + summary: Delete navigation property termsOfUse for identityGovernance + operationId: identityGovernance_DeleteTermsGraphOPreUse parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - - name: agreementFileVersion-id - in: path - description: 'key: id of agreementFileVersion' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileVersion - - name: $select - in: query - description: Select properties to be returned - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - id - - createdDateTime - - displayName - - fileData - - fileName - - isDefault - - isMajorVersion - - language - type: string - - name: $expand - in: query - description: Expand related entities - style: form - explode: false - schema: - uniqueItems: true - type: array - items: - enum: - - '*' - type: string - responses: - '200': - description: Retrieved navigation property - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - patch: - tags: - - identityGovernance.termsOfUseContainer - summary: Update the navigation property versions in identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.files_UpdateVersions - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - - name: agreementFileVersion-id - in: path - description: 'key: id of agreementFileVersion' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileVersion - requestBody: - description: New navigation property values - content: - application/json: - schema: - $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' - required: true - responses: - '204': - description: Success - default: - $ref: '#/components/responses/error' - x-ms-docs-operation-type: operation - delete: - tags: - - identityGovernance.termsOfUseContainer - summary: Delete navigation property versions for identityGovernance - operationId: identityGovernance.termsGraphOPreUse.agreements.files_DeleteVersions - parameters: - - name: agreement-id - in: path - description: 'key: id of agreement' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreement - - name: agreementFileLocalization-id - in: path - description: 'key: id of agreementFileLocalization' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileLocalization - - name: agreementFileVersion-id - in: path - description: 'key: id of agreementFileVersion' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: agreementFileVersion - - name: If-Match - in: header - description: ETag + - name: If-Match + in: header + description: ETag style: simple schema: type: string @@ -13504,25 +13553,14 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation - '/users/{user-id}/agreementAcceptances': + /identityGovernance/termsOfUse/agreementAcceptances: get: tags: - - users.agreementAcceptance - summary: List agreementAcceptances - description: Retrieve the signed-in user's agreementAcceptance objects. - externalDocs: - description: Find more info here - url: https://docs.microsoft.com/graph/api/user-list-agreementacceptances?view=graph-rest-1.0 - operationId: users_ListAgreementAcceptances + - identityGovernance.termsOfUseContainer + summary: Get agreementAcceptances from identityGovernance + description: Represents the current status of a user's response to a company's customizable terms of use agreement. + operationId: identityGovernance.termsGraphOPreUse_ListAgreementAcceptances parameters: - - name: user-id - in: path - description: 'key: id of user' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: user - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' @@ -13613,22 +13651,36 @@ paths: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation - '/users/{user-id}/agreementAcceptances/{agreementAcceptance-id}': + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create new navigation property to agreementAcceptances for identityGovernance + operationId: identityGovernance.termsGraphOPreUse_CreateAgreementAcceptances + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreementAcceptances/{agreementAcceptance-id}': get: tags: - - users.agreementAcceptance - summary: Get agreementAcceptances from users - description: The user's terms of use acceptance statuses. Read-only. Nullable. - operationId: users_GetAgreementAcceptances + - identityGovernance.termsOfUseContainer + summary: Get agreementAcceptances from identityGovernance + description: Represents the current status of a user's response to a company's customizable terms of use agreement. + operationId: identityGovernance.termsGraphOPreUse_GetAgreementAcceptances parameters: - - name: user-id - in: path - description: 'key: id of user' - required: true - style: simple - schema: - type: string - x-ms-docs-key-type: user - name: agreementAcceptance-id in: path description: 'key: id of agreementAcceptance' @@ -13684,2229 +13736,16037 @@ paths: default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation -components: - schemas: - microsoft.graph.agreement: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: agreement - type: object - properties: - displayName: - type: string - description: Display name of the agreement. The display name is used for internal tracking of the agreement but is not shown to end users who view the agreement. Supports $filter (eq). - nullable: true - isPerDeviceAcceptanceRequired: - type: boolean - description: 'Indicates whether end users are required to accept this agreement on every device that they access it from. The end user is required to register their device in Azure AD, if they haven''t already done so. Supports $filter (eq).' - nullable: true - isViewingBeforeAcceptanceRequired: - type: boolean - description: Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq). - nullable: true - termsExpiration: - $ref: '#/components/schemas/microsoft.graph.termsExpiration' - userReacceptRequiredFrequency: - pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' - type: string - description: The duration after which the user must re-accept the terms of use. The value is represented in ISO 8601 format for durations. Supports $filter (eq). - format: duration - nullable: true - acceptances: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' - description: Read-only. Information about acceptances of this agreement. - x-ms-navigationProperty: true - file: - $ref: '#/components/schemas/microsoft.graph.agreementFile' - files: - type: array - items: - $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' - description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. - x-ms-navigationProperty: true - additionalProperties: - type: object - microsoft.graph.agreementAcceptance: - allOf: - - $ref: '#/components/schemas/microsoft.graph.entity' - - title: agreementAcceptance - type: object - properties: - agreementFileId: - type: string - description: The identifier of the agreement file accepted by the user. - nullable: true - agreementId: - type: string - description: The identifier of the agreement. - nullable: true - deviceDisplayName: - type: string - description: The display name of the device used for accepting the agreement. - nullable: true - deviceId: - type: string - description: The unique identifier of the device used for accepting the agreement. - nullable: true - deviceOSType: - type: string - description: The operating system used to accept the agreement. - nullable: true - deviceOSVersion: - type: string + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property agreementAcceptances in identityGovernance + operationId: identityGovernance.termsGraphOPreUse_UpdateAgreementAcceptances + parameters: + - name: agreementAcceptance-id + in: path + description: 'key: id of agreementAcceptance' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementAcceptance + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property agreementAcceptances for identityGovernance + operationId: identityGovernance.termsGraphOPreUse_DeleteAgreementAcceptances + parameters: + - name: agreementAcceptance-id + in: path + description: 'key: id of agreementAcceptance' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementAcceptance + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + /identityGovernance/termsOfUse/agreements: + get: + tags: + - identityGovernance.termsOfUseContainer + summary: List agreements + description: Retrieve a list of agreement objects. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/termsofusecontainer-list-agreements?view=graph-rest-1.0 + operationId: identityGovernance.termsGraphOPreUse_ListAgreements + 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 + - displayName + - displayName desc + - isPerDeviceAcceptanceRequired + - isPerDeviceAcceptanceRequired desc + - isViewingBeforeAcceptanceRequired + - isViewingBeforeAcceptanceRequired desc + - termsExpiration + - termsExpiration desc + - userReacceptRequiredFrequency + - userReacceptRequiredFrequency desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - displayName + - isPerDeviceAcceptanceRequired + - isViewingBeforeAcceptanceRequired + - termsExpiration + - userReacceptRequiredFrequency + - acceptances + - file + - files + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - acceptances + - file + - files + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create agreement + description: Create a new agreement object. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/termsofusecontainer-post-agreements?view=graph-rest-1.0 + operationId: identityGovernance.termsGraphOPreUse_CreateAgreements + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreement' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreement' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get agreements from identityGovernance + description: Represents a tenant's customizable terms of use agreement that's created and managed with Azure Active Directory (Azure AD). + operationId: identityGovernance.termsGraphOPreUse_GetAgreements + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - displayName + - isPerDeviceAcceptanceRequired + - isViewingBeforeAcceptanceRequired + - termsExpiration + - userReacceptRequiredFrequency + - acceptances + - file + - files + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - acceptances + - file + - files + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreement' + links: + acceptances: + operationId: identityGovernance.termsGraphOPreUse.Agreements.ListAcceptances + parameters: + agreement-id: $request.path.agreement-id + file: + operationId: identityGovernance.termsGraphOPreUse.Agreements.GetFile + parameters: + agreement-id: $request.path.agreement-id + files: + operationId: identityGovernance.termsGraphOPreUse.Agreements.ListFiles + parameters: + agreement-id: $request.path.agreement-id + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property agreements in identityGovernance + operationId: identityGovernance.termsGraphOPreUse_UpdateAgreements + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreement' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property agreements for identityGovernance + operationId: identityGovernance.termsGraphOPreUse_DeleteAgreements + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: List acceptances + description: Get the details about the acceptance records for a specific agreement. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/agreement-list-acceptances?view=graph-rest-1.0 + operationId: identityGovernance.termsGraphOPreUse.agreements_ListAcceptances + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - $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 + - agreementFileId + - agreementFileId desc + - agreementId + - agreementId desc + - deviceDisplayName + - deviceDisplayName desc + - deviceId + - deviceId desc + - deviceOSType + - deviceOSType desc + - deviceOSVersion + - deviceOSVersion desc + - expirationDateTime + - expirationDateTime desc + - recordedDateTime + - recordedDateTime desc + - state + - state desc + - userDisplayName + - userDisplayName desc + - userEmail + - userEmail desc + - userId + - userId desc + - userPrincipalName + - userPrincipalName desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - agreementFileId + - agreementId + - deviceDisplayName + - deviceId + - deviceOSType + - deviceOSVersion + - expirationDateTime + - recordedDateTime + - state + - userDisplayName + - userEmail + - userId + - userPrincipalName + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementAcceptanceCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create new navigation property to acceptances for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_CreateAcceptances + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/acceptances/{agreementAcceptance-id}': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get acceptances from identityGovernance + description: Read-only. Information about acceptances of this agreement. + operationId: identityGovernance.termsGraphOPreUse.agreements_GetAcceptances + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementAcceptance-id + in: path + description: 'key: id of agreementAcceptance' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementAcceptance + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - agreementFileId + - agreementId + - deviceDisplayName + - deviceId + - deviceOSType + - deviceOSVersion + - expirationDateTime + - recordedDateTime + - state + - userDisplayName + - userEmail + - userId + - userPrincipalName + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property acceptances in identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_UpdateAcceptances + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementAcceptance-id + in: path + description: 'key: id of agreementAcceptance' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementAcceptance + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property acceptances for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_DeleteAcceptances + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementAcceptance-id + in: path + description: 'key: id of agreementAcceptance' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementAcceptance + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/file': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get agreementFile + description: 'Retrieve the details of the default file for an agreement, including the language and version information. The file information is specified through the agreementFile object.' + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/agreementfile-get?view=graph-rest-1.0 + operationId: identityGovernance.termsGraphOPreUse.agreements_GetFile + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + - localizations + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - localizations + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFile' + links: + localizations: + operationId: identityGovernance.termsGraphOPreUse.agreements.File.ListLocalizations + parameters: + agreement-id: $request.path.agreement-id + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property file in identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_UpdateFile + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFile' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property file for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_DeleteFile + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get localizations from identityGovernance + description: The localized version of the terms of use agreement files attached to the agreement. + operationId: identityGovernance.termsGraphOPreUse.agreements.file_ListLocalizations + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - $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 + - createdDateTime + - createdDateTime desc + - displayName + - displayName desc + - fileData + - fileData desc + - fileName + - fileName desc + - isDefault + - isDefault desc + - isMajorVersion + - isMajorVersion desc + - language + - language desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + - versions + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - versions + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementFileLocalizationCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create new navigation property to localizations for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.file_CreateLocalizations + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get localizations from identityGovernance + description: The localized version of the terms of use agreement files attached to the agreement. + operationId: identityGovernance.termsGraphOPreUse.agreements.file_GetLocalizations + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + - versions + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - versions + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + links: + versions: + operationId: identityGovernance.termsGraphOPreUse.agreements.file.Localizations.ListVersions + parameters: + agreement-id: $request.path.agreement-id + agreementFileLocalization-id: $request.path.agreementFileLocalization-id + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property localizations in identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.file_UpdateLocalizations + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property localizations for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.file_DeleteLocalizations + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get versions from identityGovernance + description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. + operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_ListVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - $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 + - createdDateTime + - createdDateTime desc + - displayName + - displayName desc + - fileData + - fileData desc + - fileName + - fileName desc + - isDefault + - isDefault desc + - isMajorVersion + - isMajorVersion desc + - language + - language desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementFileVersionCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create new navigation property to versions for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_CreateVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/file/localizations/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get versions from identityGovernance + description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. + operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_GetVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: agreementFileVersion-id + in: path + description: 'key: id of agreementFileVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileVersion + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property versions in identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_UpdateVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: agreementFileVersion-id + in: path + description: 'key: id of agreementFileVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileVersion + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property versions for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.file.localizations_DeleteVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: agreementFileVersion-id + in: path + description: 'key: id of agreementFileVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileVersion + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/files': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get files from identityGovernance + description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. + operationId: identityGovernance.termsGraphOPreUse.agreements_ListFiles + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - $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 + - createdDateTime + - createdDateTime desc + - displayName + - displayName desc + - fileData + - fileData desc + - fileName + - fileName desc + - isDefault + - isDefault desc + - isMajorVersion + - isMajorVersion desc + - language + - language desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + - versions + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - versions + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementFileLocalizationCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create agreementFileLocalization + description: Create a new localized agreement file. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/agreement-post-files?view=graph-rest-1.0 + operationId: identityGovernance.termsGraphOPreUse.agreements_CreateFiles + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get files from identityGovernance + description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. + operationId: identityGovernance.termsGraphOPreUse.agreements_GetFiles + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + - versions + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + - versions + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + links: + versions: + operationId: identityGovernance.termsGraphOPreUse.agreements.Files.ListVersions + parameters: + agreement-id: $request.path.agreement-id + agreementFileLocalization-id: $request.path.agreementFileLocalization-id + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property files in identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_UpdateFiles + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property files for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements_DeleteFiles + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get versions from identityGovernance + description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. + operationId: identityGovernance.termsGraphOPreUse.agreements.files_ListVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - $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 + - createdDateTime + - createdDateTime desc + - displayName + - displayName desc + - fileData + - fileData desc + - fileName + - fileName desc + - isDefault + - isDefault desc + - isMajorVersion + - isMajorVersion desc + - language + - language desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementFileVersionCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + post: + tags: + - identityGovernance.termsOfUseContainer + summary: Create new navigation property to versions for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.files_CreateVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + requestBody: + description: New navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + required: true + responses: + '201': + description: Created navigation property. + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/identityGovernance/termsOfUse/agreements/{agreement-id}/files/{agreementFileLocalization-id}/versions/{agreementFileVersion-id}': + get: + tags: + - identityGovernance.termsOfUseContainer + summary: Get versions from identityGovernance + description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. + operationId: identityGovernance.termsGraphOPreUse.agreements.files_GetVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: agreementFileVersion-id + in: path + description: 'key: id of agreementFileVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileVersion + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - createdDateTime + - displayName + - fileData + - fileName + - isDefault + - isMajorVersion + - language + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + patch: + tags: + - identityGovernance.termsOfUseContainer + summary: Update the navigation property versions in identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.files_UpdateVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: agreementFileVersion-id + in: path + description: 'key: id of agreementFileVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileVersion + requestBody: + description: New navigation property values + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + required: true + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + delete: + tags: + - identityGovernance.termsOfUseContainer + summary: Delete navigation property versions for identityGovernance + operationId: identityGovernance.termsGraphOPreUse.agreements.files_DeleteVersions + parameters: + - name: agreement-id + in: path + description: 'key: id of agreement' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreement + - name: agreementFileLocalization-id + in: path + description: 'key: id of agreementFileLocalization' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileLocalization + - name: agreementFileVersion-id + in: path + description: 'key: id of agreementFileVersion' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementFileVersion + - name: If-Match + in: header + description: ETag + style: simple + schema: + type: string + responses: + '204': + description: Success + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation + '/users/{user-id}/agreementAcceptances': + get: + tags: + - users.agreementAcceptance + summary: List agreementAcceptances + description: Retrieve the signed-in user's agreementAcceptance objects. + externalDocs: + description: Find more info here + url: https://docs.microsoft.com/graph/api/user-list-agreementacceptances?view=graph-rest-1.0 + operationId: users_ListAgreementAcceptances + parameters: + - name: user-id + in: path + description: 'key: id of user' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - $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 + - agreementFileId + - agreementFileId desc + - agreementId + - agreementId desc + - deviceDisplayName + - deviceDisplayName desc + - deviceId + - deviceId desc + - deviceOSType + - deviceOSType desc + - deviceOSVersion + - deviceOSVersion desc + - expirationDateTime + - expirationDateTime desc + - recordedDateTime + - recordedDateTime desc + - state + - state desc + - userDisplayName + - userDisplayName desc + - userEmail + - userEmail desc + - userId + - userId desc + - userPrincipalName + - userPrincipalName desc + type: string + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - agreementFileId + - agreementId + - deviceDisplayName + - deviceId + - deviceOSType + - deviceOSVersion + - expirationDateTime + - recordedDateTime + - state + - userDisplayName + - userEmail + - userId + - userPrincipalName + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + $ref: '#/components/responses/microsoft.graph.agreementAcceptanceCollectionResponse' + default: + $ref: '#/components/responses/error' + x-ms-pageable: + nextLinkName: '@odata.nextLink' + operationName: listMore + x-ms-docs-operation-type: operation + '/users/{user-id}/agreementAcceptances/{agreementAcceptance-id}': + get: + tags: + - users.agreementAcceptance + summary: Get agreementAcceptances from users + description: The user's terms of use acceptance statuses. Read-only. Nullable. + operationId: users_GetAgreementAcceptances + parameters: + - name: user-id + in: path + description: 'key: id of user' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: user + - name: agreementAcceptance-id + in: path + description: 'key: id of agreementAcceptance' + required: true + style: simple + schema: + type: string + x-ms-docs-key-type: agreementAcceptance + - name: $select + in: query + description: Select properties to be returned + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - id + - agreementFileId + - agreementId + - deviceDisplayName + - deviceId + - deviceOSType + - deviceOSVersion + - expirationDateTime + - recordedDateTime + - state + - userDisplayName + - userEmail + - userId + - userPrincipalName + type: string + - name: $expand + in: query + description: Expand related entities + style: form + explode: false + schema: + uniqueItems: true + type: array + items: + enum: + - '*' + type: string + responses: + '200': + description: Retrieved navigation property + content: + application/json: + schema: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + default: + $ref: '#/components/responses/error' + x-ms-docs-operation-type: operation +components: + schemas: + microsoft.graph.agreement: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: agreement + type: object + properties: + displayName: + type: string + description: Display name of the agreement. The display name is used for internal tracking of the agreement but is not shown to end users who view the agreement. Supports $filter (eq). + nullable: true + isPerDeviceAcceptanceRequired: + type: boolean + description: 'Indicates whether end users are required to accept this agreement on every device that they access it from. The end user is required to register their device in Azure AD, if they haven''t already done so. Supports $filter (eq).' + nullable: true + isViewingBeforeAcceptanceRequired: + type: boolean + description: Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq). + nullable: true + termsExpiration: + $ref: '#/components/schemas/microsoft.graph.termsExpiration' + userReacceptRequiredFrequency: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + description: The duration after which the user must re-accept the terms of use. The value is represented in ISO 8601 format for durations. Supports $filter (eq). + format: duration + nullable: true + acceptances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + description: Read-only. Information about acceptances of this agreement. + x-ms-navigationProperty: true + file: + $ref: '#/components/schemas/microsoft.graph.agreementFile' + files: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + description: PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.agreementAcceptance: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: agreementAcceptance + type: object + properties: + agreementFileId: + type: string + description: The identifier of the agreement file accepted by the user. + nullable: true + agreementId: + type: string + description: The identifier of the agreement. + nullable: true + deviceDisplayName: + type: string + description: The display name of the device used for accepting the agreement. + nullable: true + deviceId: + type: string + description: The unique identifier of the device used for accepting the agreement. + nullable: true + deviceOSType: + type: string + description: The operating system used to accept the agreement. + nullable: true + deviceOSVersion: + type: string description: The operating system version of the device used to accept the agreement. nullable: true expirationDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string - description: 'The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + description: 'The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + recordedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + state: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState' + userDisplayName: + type: string + description: Display name of the user when the acceptance was recorded. + nullable: true + userEmail: + type: string + description: Email of the user when the acceptance was recorded. + nullable: true + userId: + type: string + description: The identifier of the user who accepted the agreement. + nullable: true + userPrincipalName: + type: string + description: UPN of the user when the acceptance was recorded. + nullable: true + additionalProperties: + type: object + microsoft.graph.agreementFile: + allOf: + - $ref: '#/components/schemas/microsoft.graph.agreementFileProperties' + - title: agreementFile + type: object + properties: + localizations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + description: The localized version of the terms of use agreement files attached to the agreement. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.agreementFileLocalization: + allOf: + - $ref: '#/components/schemas/microsoft.graph.agreementFileProperties' + - title: agreementFileLocalization + type: object + properties: + versions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + description: Read-only. Customized versions of the terms of use agreement in the Azure AD tenant. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.agreementFileVersion: + allOf: + - $ref: '#/components/schemas/microsoft.graph.agreementFileProperties' + - title: agreementFileVersion + type: object + additionalProperties: + type: object + microsoft.graph.identityGovernance: + title: identityGovernance + type: object + properties: + accessReviews: + $ref: '#/components/schemas/microsoft.graph.accessReviewSet' + appConsent: + $ref: '#/components/schemas/microsoft.graph.appConsentApprovalRoute' + termsOfUse: + $ref: '#/components/schemas/microsoft.graph.termsOfUseContainer' + entitlementManagement: + $ref: '#/components/schemas/microsoft.graph.entitlementManagement' + additionalProperties: + type: object + microsoft.graph.accessReviewSet: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewSet + type: object + properties: + definitions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition' + description: Represents the template and scheduling for an access review. + x-ms-navigationProperty: true + historyDefinitions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition' + description: Represents a collection of access review history data and the scopes used to collect that data. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessReviewScheduleDefinition: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewScheduleDefinition + type: object + properties: + additionalNotificationRecipients: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientItem' + description: Defines the list of additional users or group members to be notified of the access review progress. + createdBy: + $ref: '#/components/schemas/microsoft.graph.userIdentity' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp when the access review series was created. Supports $select. Read-only. + format: date-time + nullable: true + descriptionForAdmins: + type: string + description: Description provided by review creators to provide more context of the review to admins. Supports $select. + nullable: true + descriptionForReviewers: + type: string + description: Description provided by review creators to provide more context of the review to reviewers. Reviewers will see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select. + nullable: true + displayName: + type: string + description: Name of the access review series. Supports $select and $orderBy. Required on create. + nullable: true + fallbackReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.' + instanceEnumerationScope: + $ref: '#/components/schemas/microsoft.graph.accessReviewScope' + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp when the access review series was last modified. Supports $select. Read-only. + format: date-time + nullable: true + reviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.' + scope: + $ref: '#/components/schemas/microsoft.graph.accessReviewScope' + settings: + $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleSettings' + stageSettings: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewStageSettings' + description: 'Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages will be created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.' + status: + type: string + description: 'This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.' + nullable: true + instances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstance' + description: 'If the accessReviewScheduleDefinition is a recurring access review, instances represent each recurrence. A review that does not recur will have exactly one instance. Instances also represent each unique resource under review in the accessReviewScheduleDefinition. If a review has multiple resources and multiple instances, each resource will have a unique instance for each recurrence.' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessReviewInstance: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewInstance + type: object + properties: + endDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'DateTime when review instance is scheduled to end.The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.' + format: date-time + nullable: true + fallbackReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist. Supports $select.' + reviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.' + scope: + $ref: '#/components/schemas/microsoft.graph.accessReviewScope' + startDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'DateTime when review instance is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.' + format: date-time + nullable: true + status: + type: string + description: 'Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.' + nullable: true + contactedReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewer' + description: 'Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.' + x-ms-navigationProperty: true + decisions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem' + description: 'Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.' + x-ms-navigationProperty: true + stages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewStage' + description: 'If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessReviewReviewer: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewReviewer + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The date when the reviewer was added for the access review. + format: date-time + nullable: true + displayName: + type: string + description: Name of reviewer. + nullable: true + userPrincipalName: + type: string + description: User principal name of the reviewer. + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewInstanceDecisionItem: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewInstanceDecisionItem + type: object + properties: + accessReviewId: + type: string + description: The identifier of the accessReviewInstance parent. Supports $select. Read-only. + appliedBy: + $ref: '#/components/schemas/microsoft.graph.userIdentity' + appliedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The timestamp when the approval decision was applied.00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn''t applied the decision or it was automatically applied. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.' + format: date-time + nullable: true + applyResult: + type: string + description: 'The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.' + nullable: true + decision: + type: string + description: 'Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).' + nullable: true + justification: + type: string + description: Justification left by the reviewer when they made the decision. + nullable: true + principal: + $ref: '#/components/schemas/microsoft.graph.identity' + principalLink: + type: string + description: 'A link to the principal object. For example, https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.' + nullable: true + recommendation: + type: string + description: 'A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within thirty days of start of review. Recommend deny if sign-in is greater than thirty days of start of review. Recommendation not available otherwise. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.' + nullable: true + resource: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemResource' + resourceLink: + type: string + description: 'A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.' + nullable: true + reviewedBy: + $ref: '#/components/schemas/microsoft.graph.userIdentity' + reviewedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The timestamp when the review decision occurred. Supports $select. Read-only. + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewInstanceDecisionItemFilterByCurrentUserOptions: + title: accessReviewInstanceDecisionItemFilterByCurrentUserOptions + enum: + - reviewer + - unknownFutureValue + type: string + microsoft.graph.accessReviewStage: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewStage + type: object + properties: + endDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The date and time in ISO 8601 format and UTC time when the review stage is scheduled to end. This property is the cumulative total of the durationInDays for all stages. Read-only. + format: date-time + nullable: true + fallbackReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist.' + reviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'This collection of access review scopes is used to define who the reviewers are. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.' + startDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The date and time in ISO 8601 format and UTC time when the review stage is scheduled to start. Read-only. + format: date-time + nullable: true + status: + type: string + description: 'Specifies the status of an accessReviewStage. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $orderby, and $filter (eq only). Read-only.' + nullable: true + decisions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem' + description: 'Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessReviewStageFilterByCurrentUserOptions: + title: accessReviewStageFilterByCurrentUserOptions + enum: + - reviewer + - unknownFutureValue + type: string + microsoft.graph.accessReviewInstanceFilterByCurrentUserOptions: + title: accessReviewInstanceFilterByCurrentUserOptions + enum: + - reviewer + - unknownFutureValue + type: string + microsoft.graph.accessReviewScheduleDefinitionFilterByCurrentUserOptions: + title: accessReviewScheduleDefinitionFilterByCurrentUserOptions + enum: + - reviewer + - unknownFutureValue + type: string + microsoft.graph.accessReviewHistoryDefinition: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewHistoryDefinition + type: object + properties: + createdBy: + $ref: '#/components/schemas/microsoft.graph.userIdentity' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp when the access review definition was created. + format: date-time + decisions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDecisionFilter' + description: 'Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions will be included by default if no decisions are provided on create. Possible values are: approve, deny, dontKnow, notReviewed, and notNotified.' + displayName: + type: string + description: Name for the access review history data collection. Required. + reviewHistoryPeriodEndDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined. + format: date-time + reviewHistoryPeriodStartDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined. + format: date-time + scheduleSettings: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryScheduleSettings' + scopes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewScope' + description: Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required. + status: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryStatus' + instances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance' + description: 'If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that does not recur will have exactly one instance.' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessReviewHistoryInstance: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessReviewHistoryInstance + type: object + properties: + downloadUri: + type: string + description: Uri which can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required. + nullable: true + expirationDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp when this instance and associated data expires and the history is deleted. Required. + format: date-time + fulfilledDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp when all of the available data for this instance was collected. This will be set after this instance's status is set to done. Required. + format: date-time + nullable: true + reviewHistoryPeriodEndDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Timestamp, reviews ending on or before this date will be included in the fetched history data.' + format: date-time + nullable: true + reviewHistoryPeriodStartDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Timestamp, reviews starting on or after this date will be included in the fetched history data.' + format: date-time + nullable: true + runDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp when the instance's history data is scheduled to be generated. + format: date-time + status: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryStatus' + additionalProperties: + type: object + microsoft.graph.appConsentApprovalRoute: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: appConsentApprovalRoute + type: object + properties: + appConsentRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.appConsentRequest' + description: A collection of userConsentRequest objects for a specific application. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.appConsentRequest: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: appConsentRequest + type: object + properties: + appDisplayName: + type: string + description: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby. + nullable: true + appId: + type: string + description: The identifier of the application. Required. Supports $filter (eq only) and $orderby. + pendingScopes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.appConsentRequestScope' + description: A list of pending scopes waiting for approval. Required. + userConsentRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userConsentRequest' + description: A list of pending user consent requests. Supports $filter (eq). + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.userConsentRequest: + allOf: + - $ref: '#/components/schemas/microsoft.graph.request' + - title: userConsentRequest + type: object + properties: + reason: + type: string + description: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby. + nullable: true + approval: + $ref: '#/components/schemas/microsoft.graph.approval' + additionalProperties: + type: object + microsoft.graph.approval: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: approval + type: object + properties: + stages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.approvalStage' + description: A collection of stages in the approval decision. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.approvalStage: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: approvalStage + type: object + properties: + assignedToMe: + type: boolean + description: Indicates whether the stage is assigned to the calling user to review. Read-only. + nullable: true + displayName: + type: string + description: The label provided by the policy creator to identify an approval stage. Read-only. + nullable: true + justification: + type: string + description: The justification associated with the approval stage decision. + nullable: true + reviewedBy: + $ref: '#/components/schemas/microsoft.graph.identity' + reviewedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The date and time when a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + reviewResult: + type: string + description: 'The result of this approval record. Possible values include: NotReviewed, Approved, Denied.' + nullable: true + status: + type: string + description: 'The stage status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.' + nullable: true + additionalProperties: + type: object + microsoft.graph.consentRequestFilterByCurrentUserOptions: + title: consentRequestFilterByCurrentUserOptions + enum: + - reviewer + - unknownFutureValue + type: string + microsoft.graph.entitlementManagement: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: entitlementManagement + type: object + properties: + accessPackageAssignmentApprovals: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.approval' + description: Approval stages for decisions associated with access package assignment requests. + x-ms-navigationProperty: true + accessPackages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + description: Access packages define the collection of resource roles and the policies for which subjects can request or be assigned access to those resources. + x-ms-navigationProperty: true + assignmentPolicies: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + description: Access package assignment policies govern which subjects can request or be assigned an access package via an access package assignment. + x-ms-navigationProperty: true + assignmentRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' + description: Access package assignment requests created by or on behalf of a subject. + x-ms-navigationProperty: true + assignments: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + description: The assignment of an access package to a subject for a period of time. + x-ms-navigationProperty: true + catalogs: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + description: A container for access packages. + x-ms-navigationProperty: true + connectedOrganizations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + description: References to a directory or domain of another organization whose users can request access. + x-ms-navigationProperty: true + settings: + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSettings' + additionalProperties: + type: object + microsoft.graph.approvalFilterByCurrentUserOptions: + title: approvalFilterByCurrentUserOptions + enum: + - target + - createdBy + - approver + - unknownFutureValue + type: string + microsoft.graph.accessPackage: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessPackage + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + description: + type: string + description: The description of the access package. + nullable: true + displayName: + type: string + description: 'The display name of the access package. Supports $filter (eq, contains).' + nullable: true + isHidden: + type: boolean + description: Whether the access package is hidden from the requestor. + nullable: true + modifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + accessPackagesIncompatibleWith: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + x-ms-navigationProperty: true + assignmentPolicies: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + x-ms-navigationProperty: true + catalog: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + incompatibleAccessPackages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + x-ms-navigationProperty: true + incompatibleGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.group' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentPolicy: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessPackageAssignmentPolicy + type: object + properties: + allowedTargetScope: + $ref: '#/components/schemas/microsoft.graph.allowedTargetScope' + automaticRequestSettings: + $ref: '#/components/schemas/microsoft.graph.accessPackageAutomaticRequestSettings' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + description: + type: string + description: The description of the policy. + nullable: true + displayName: + type: string + description: The display name of the policy. + nullable: true + expiration: + $ref: '#/components/schemas/microsoft.graph.expirationPattern' + modifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + requestApprovalSettings: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentApprovalSettings' + requestorSettings: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequestorSettings' + reviewSettings: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentReviewSettings' + specificAllowedTargets: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: The principals that can be assigned access from an access package through this policy. + accessPackage: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + catalog: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + additionalProperties: + type: object + microsoft.graph.accessPackageCatalog: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessPackageCatalog + type: object + properties: + catalogType: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalogType' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + description: + type: string + description: The description of the access package catalog. + nullable: true + displayName: + type: string + description: The display name of the access package catalog. + nullable: true + isExternallyVisible: + type: boolean + description: Whether the access packages in this catalog can be requested by users outside of the tenant. + nullable: true + modifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + state: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalogState' + accessPackages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + description: The access packages in this catalog. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentRequestRequirements: + title: accessPackageAssignmentRequestRequirements + type: object + properties: + allowCustomAssignmentSchedule: + type: boolean + description: Indicates whether the requestor is allowed to set a custom schedule. + nullable: true + isApprovalRequiredForAdd: + type: boolean + description: Indicates whether a request to add must be approved by an approver. + nullable: true + isApprovalRequiredForUpdate: + type: boolean + description: Indicates whether a request to update must be approved by an approver. + nullable: true + policyDescription: + type: string + description: The description of the policy that the user is trying to request access using. + nullable: true + policyDisplayName: + type: string + description: The display name of the policy that the user is trying to request access using. + nullable: true + policyId: + type: string + description: The identifier of the policy that these requirements are associated with. This identifier can be used when creating a new assignment request. + nullable: true + schedule: + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule' + additionalProperties: + type: object + microsoft.graph.accessPackageFilterByCurrentUserOptions: + title: accessPackageFilterByCurrentUserOptions + enum: + - allowedRequestor + - unknownFutureValue + type: string + microsoft.graph.accessPackageAssignmentRequest: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessPackageAssignmentRequest + type: object + properties: + completedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The date of the end of processing, either successful or failure, of a request. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter.' + format: date-time + nullable: true + requestType: + $ref: '#/components/schemas/microsoft.graph.accessPackageRequestType' + schedule: + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule' + state: + $ref: '#/components/schemas/microsoft.graph.accessPackageRequestState' + status: + type: string + description: More information on the request processing status. Read-only. + nullable: true + accessPackage: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + assignment: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + requestor: + $ref: '#/components/schemas/microsoft.graph.accessPackageSubject' + additionalProperties: + type: object + microsoft.graph.accessPackageAssignment: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessPackageAssignment + type: object + properties: + expiredDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + schedule: + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule' + state: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentState' + status: + type: string + description: 'More information about the assignment lifecycle. Possible values include Delivering, Delivered, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.' + nullable: true + accessPackage: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + assignmentPolicy: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + target: + $ref: '#/components/schemas/microsoft.graph.accessPackageSubject' + additionalProperties: + type: object + microsoft.graph.accessPackageSubject: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: accessPackageSubject + type: object + properties: + displayName: + type: string + description: The display name of the subject. + nullable: true + email: + type: string + description: The email address of the subject. + nullable: true + objectId: + type: string + description: The object identifier of the subject. null if the subject is not yet a user in the tenant. + nullable: true + onPremisesSecurityIdentifier: + type: string + description: 'A string representation of the principal''s security identifier, if known, or null if the subject does not have a security identifier.' + nullable: true + principalName: + type: string + description: 'The principal name, if known, of the subject.' + nullable: true + subjectType: + $ref: '#/components/schemas/microsoft.graph.accessPackageSubjectType' + connectedOrganization: + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentRequestFilterByCurrentUserOptions: + title: accessPackageAssignmentRequestFilterByCurrentUserOptions + enum: + - target + - createdBy + - approver + - unknownFutureValue + type: string + microsoft.graph.accessPackageAssignmentFilterByCurrentUserOptions: + title: accessPackageAssignmentFilterByCurrentUserOptions + enum: + - target + - createdBy + - unknownFutureValue + type: string + microsoft.graph.connectedOrganization: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: connectedOrganization + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + description: + type: string + description: The description of the connected organization. + nullable: true + displayName: + type: string + description: The display name of the connected organization. Supports $filter (eq). + nullable: true + identitySources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.identitySource' + description: 'The identity sources in this connected organization, one of azureActiveDirectoryTenant, domainIdentitySource or externalDomainFederation. Nullable.' + modifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + state: + $ref: '#/components/schemas/microsoft.graph.connectedOrganizationState' + externalSponsors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + x-ms-navigationProperty: true + internalSponsors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.directoryObject: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: directoryObject + type: object + properties: + deletedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Date and time when this object was deleted. Always null when the object hasn't been deleted. + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.extensionProperty: + allOf: + - $ref: '#/components/schemas/microsoft.graph.directoryObject' + - title: extensionProperty + type: object + properties: + appDisplayName: + type: string + description: Display name of the application object on which this extension property is defined. Read-only. + nullable: true + dataType: + type: string + description: Specifies the data type of the value the extension property can hold. Following values are supported. Not nullable. Binary - 256 bytes maximumBooleanDateTime - Must be specified in ISO 8601 format. Will be stored in UTC.Integer - 32-bit value.LargeInteger - 64-bit value.String - 256 characters maximum + isSyncedFromOnPremises: + type: boolean + description: Indicates if this extension property was synced from on-premises active directory using Azure AD Connect. Read-only. + nullable: true + name: + type: string + description: Name of the extension property. Not nullable. Supports $filter (eq). + targetObjects: + type: array + items: + type: string + description: Following values are supported. Not nullable. UserGroupAdministrativeUnitApplicationDeviceOrganization + additionalProperties: + type: object + microsoft.graph.entitlementManagementSettings: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: entitlementManagementSettings + type: object + properties: + durationUntilExternalUserDeletedAfterBlocked: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + description: 'If externalUserLifecycleAction is blockSignInAndDelete, the duration, typically a number of days, after an external user is blocked from sign in before their account is deleted.' + format: duration + nullable: true + externalUserLifecycleAction: + $ref: '#/components/schemas/microsoft.graph.accessPackageExternalUserLifecycleAction' + additionalProperties: + type: object + microsoft.graph.termsOfUseContainer: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: termsOfUseContainer + type: object + properties: + agreementAcceptances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + description: Represents the current status of a user's response to a company's customizable terms of use agreement. + x-ms-navigationProperty: true + agreements: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreement' + description: Represents a tenant's customizable terms of use agreement that's created and managed with Azure Active Directory (Azure AD). + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.entity: + title: entity + type: object + properties: + id: + type: string + description: The unique idenfier for an entity. Read-only. + additionalProperties: + type: object + microsoft.graph.termsExpiration: + title: termsExpiration + type: object + properties: + frequency: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + description: 'Represents the frequency at which the terms will expire, after its first expiration as set in startDateTime. The value is represented in ISO 8601 format for durations. For example, PT1M represents a time period of 1 month.' + format: duration + nullable: true + startDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The DateTime when the agreement is set to expire for all users. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.agreementAcceptanceState: + title: agreementAcceptanceState + enum: + - accepted + - declined + - unknownFutureValue + type: string + microsoft.graph.agreementFileProperties: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: agreementFileProperties + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The date time representing when the file was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + displayName: + type: string + description: Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement. + nullable: true + fileData: + $ref: '#/components/schemas/microsoft.graph.agreementFileData' + fileName: + type: string + description: 'Name of the agreement file (for example, TOU.pdf). Read-only.' + nullable: true + isDefault: + type: boolean + description: 'If none of the languages matches the client preference, indicates whether this is the default agreement file . If none of the files are marked as default, the first one is treated as the default. Read-only.' + nullable: true + isMajorVersion: + type: boolean + description: Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language. + nullable: true + language: + type: string + description: 'The language of the agreement file in the format ''languagecode2-country/regioncode2''. ''languagecode2'' is a lowercase two-letter code derived from ISO 639-1, while ''country/regioncode2'' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.' + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewNotificationRecipientItem: + title: accessReviewNotificationRecipientItem + type: object + properties: + notificationRecipientScope: + $ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientScope' + notificationTemplateType: + type: string + description: 'Indicates the type of access review email to be sent. Supported template type is CompletedAdditionalRecipients, which sends review completion notifications to the recipients.' + nullable: true + additionalProperties: + type: object + microsoft.graph.userIdentity: + allOf: + - $ref: '#/components/schemas/microsoft.graph.identity' + - title: userIdentity + type: object + properties: + ipAddress: + type: string + description: Indicates the client IP address used by user performing the activity (audit log only). + nullable: true + userPrincipalName: + type: string + description: The userPrincipalName attribute of the user. + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewReviewerScope: + title: accessReviewReviewerScope + type: object + properties: + query: + type: string + description: The query specifying who will be the reviewer. + nullable: true + queryRoot: + type: string + description: 'In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.' + nullable: true + queryType: + type: string + description: The type of query. Examples include MicrosoftGraph and ARM. + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewScope: + title: accessReviewScope + type: object + additionalProperties: + type: object + microsoft.graph.accessReviewScheduleSettings: + title: accessReviewScheduleSettings + type: object + properties: + applyActions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewApplyAction' + description: 'Optional field. Describes the actions to take once a review is complete. There are two types that are currently supported: removeAccessApplyAction (default) and disableAndDeleteUserApplyAction. Field only needs to be specified in the case of disableAndDeleteUserApplyAction.' + autoApplyDecisionsEnabled: + type: boolean + description: 'Indicates whether decisions are automatically applied. When set to false, an admin must apply the decisions manually once the reviewer completes the access review. When set to true, decisions are applied automatically after the access review instance duration ends, whether or not the reviewers have responded. Default value is false.' + decisionHistoriesForReviewersEnabled: + type: boolean + description: 'Indicates whether decisions on previous access review stages are available for reviewers on an accessReviewInstance with multiple subsequent stages. If not provided, the default is disabled (false).' + nullable: true + defaultDecision: + type: string + description: 'Decision chosen if defaultDecisionEnabled is enabled. Can be one of Approve, Deny, or Recommendation.' + nullable: true + defaultDecisionEnabled: + type: boolean + description: Indicates whether the default decision is enabled or disabled when reviewers do not respond. Default value is false. + instanceDurationInDays: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Duration of an access review instance in days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its durationInDays setting will be used instead of the value of this property.' + format: int32 + justificationRequiredOnApproval: + type: boolean + description: Indicates whether reviewers are required to provide justification with their decision. Default value is false. + mailNotificationsEnabled: + type: boolean + description: Indicates whether emails are enabled or disabled. Default value is false. + recommendationsEnabled: + type: boolean + description: 'Indicates whether decision recommendations are enabled or disabled. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationsEnabled setting will be used instead of the value of this property.' + recurrence: + $ref: '#/components/schemas/microsoft.graph.patternedRecurrence' + reminderNotificationsEnabled: + type: boolean + description: Indicates whether reminders are enabled or disabled. Default value is false. + additionalProperties: + type: object + microsoft.graph.accessReviewStageSettings: + title: accessReviewStageSettings + type: object + properties: + decisionsThatWillMoveToNextStage: + type: array + items: + type: string + nullable: true + description: 'Indicate which decisions will go to the next stage. Can be a sub-set of Approve, Deny, Recommendation, or NotReviewed. If not provided, all decisions will go to the next stage. Optional.' + dependsOn: + type: array + items: + type: string + description: 'Defines the sequential or parallel order of the stages and depends on the stageId. Only sequential stages are currently supported. For example, if stageId is 2, then dependsOn must be 1. If stageId is 1, do not specify dependsOn. Required if stageId is not 1.' + durationInDays: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'The duration of the stage. Required. NOTE: The cumulative value of this property across all stages 1. Will override the instanceDurationInDays setting on the accessReviewScheduleDefinition object. 2. Cannot exceed the length of one recurrence. That is, if the review recurs weekly, the cumulative durationInDays cannot exceed 7.' + format: int32 + fallbackReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'If provided, the fallback reviewers are asked to complete a review if the primary reviewers do not exist. For example, if managers are selected as reviewers and a principal under review does not have a manager in Azure AD, the fallback reviewers are asked to review that principal. NOTE: The value of this property will override the corresponding setting on the accessReviewScheduleDefinition object.' + recommendationsEnabled: + type: boolean + description: 'Indicates whether showing recommendations to reviewers is enabled. Required. NOTE: The value of this property will override override the corresponding setting on the accessReviewScheduleDefinition object.' + reviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope' + description: 'Defines who the reviewers are. If none are specified, the review is a self-review (users review their own access). For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will override the corresponding setting on the accessReviewScheduleDefinition.' + stageId: + type: string + description: Unique identifier of the accessReviewStageSettings object. The stageId will be used by the dependsOn property to indicate the order of the stages. Required. + additionalProperties: + type: object + microsoft.graph.identity: + title: identity + type: object + properties: + displayName: + type: string + description: 'The display name of the identity. Note that this might not always be available or up to date. For example, if a user changes their display name, the API might show the new value in a future response, but the items associated with the user won''t show up as having changed when using delta.' + nullable: true + id: + type: string + description: Unique identifier for the identity. + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewInstanceDecisionItemResource: + title: accessReviewInstanceDecisionItemResource + type: object + properties: + displayName: + type: string + description: Display name of the resource + nullable: true + id: + type: string + description: Identifier of the resource + nullable: true + type: + type: string + description: 'Type of resource. Types include: Group, ServicePrincipal, DirectoryRole, AzureRole, AccessPackageAssignmentPolicy.' + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewHistoryDecisionFilter: + title: accessReviewHistoryDecisionFilter + enum: + - approve + - deny + - notReviewed + - dontKnow + - notNotified + - unknownFutureValue + type: string + microsoft.graph.accessReviewHistoryScheduleSettings: + title: accessReviewHistoryScheduleSettings + type: object + properties: + recurrence: + $ref: '#/components/schemas/microsoft.graph.patternedRecurrence' + reportRange: + type: string + description: 'A duration string in ISO 8601 duration format specifying the lookback period of the generated review history data. For example, if a history definition is scheduled to run on the 1st of every month, the reportRange is P1M. In this case, on the first of every month, access review history data will be collected containing only the previous month''s review data. Note: Only years, months, and days ISO 8601 properties are supported. Required.' + additionalProperties: + type: object + microsoft.graph.accessReviewHistoryStatus: + title: accessReviewHistoryStatus + enum: + - done + - inprogress + - error + - requested + - unknownFutureValue + type: string + microsoft.graph.appConsentRequestScope: + title: appConsentRequestScope + type: object + properties: + displayName: + type: string + description: The name of the scope. + nullable: true + additionalProperties: + type: object + microsoft.graph.request: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: request + type: object + properties: + approvalId: + type: string + description: The identifier of the approval of the request. + nullable: true + completedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The request completion date time. + format: date-time + nullable: true + createdBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The request creation date time. + format: date-time + nullable: true + customData: + type: string + description: Free text field to define any custom data for the request. Not used. + nullable: true + status: + type: string + description: 'The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.' + additionalProperties: + type: object + microsoft.graph.group: + allOf: + - $ref: '#/components/schemas/microsoft.graph.directoryObject' + - title: group + type: object + properties: + assignedLabels: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.assignedLabel' + description: 'The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. Read-only.' + assignedLicenses: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.assignedLicense' + description: The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only. + classification: + type: string + description: 'Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).' + nullable: true + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.' + format: date-time + nullable: true + description: + type: string + description: 'An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.' + nullable: true + displayName: + type: string + description: 'The display name for the group. This property is required when a group is created and cannot be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.' + nullable: true + expirationDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Timestamp of when the group is set to expire. 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. Supports $filter (eq, ne, not, ge, le, in). Read-only.' + format: date-time + nullable: true + groupTypes: + type: array + items: + type: string + description: 'Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it''s either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).' + hasMembersWithLicenseErrors: + type: boolean + description: 'Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).' + nullable: true + isAssignableToRole: + type: boolean + description: 'Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true 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 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 assignmentsReturned by default. Supports $filter (eq, ne, not).' + nullable: true + licenseProcessingState: + $ref: '#/components/schemas/microsoft.graph.licenseProcessingState' + mail: + type: string + description: 'The SMTP address for the group, for example, ''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).' + nullable: true + mailNickname: + type: string + description: 'The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / [] '' ; : . <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + membershipRule: + type: string + description: 'The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).' + nullable: true + membershipRuleProcessingState: + type: string + description: 'Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).' + nullable: true + onPremisesDomainName: + type: string + nullable: true + onPremisesLastSyncDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).' + format: date-time + nullable: true + onPremisesNetBiosName: + type: string + nullable: true + onPremisesProvisioningErrors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError' + description: 'Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).' + onPremisesSamAccountName: + type: string + description: 'Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.' + nullable: true + onPremisesSecurityIdentifier: + type: string + description: Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only. + nullable: true + onPremisesSyncEnabled: + type: boolean + description: 'true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).' + nullable: true + preferredDataLocation: + type: string + description: 'The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator''s preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.' + nullable: true + preferredLanguage: + type: string + description: 'The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + proxyAddresses: + type: array + items: + type: string + description: 'Email addresses for the group that direct to the same group mailbox. For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, and counting empty collections).' + renewedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.' + format: date-time + nullable: true + securityEnabled: + type: boolean + description: 'Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).' + nullable: true + securityIdentifier: + type: string + description: 'Security identifier of the group, used in Windows scenarios. Returned by default.' + nullable: true + theme: + type: string + description: 'Specifies a Microsoft 365 group''s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.' + nullable: true + visibility: + type: string + description: 'Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can''t be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more. Returned by default. Nullable.' + nullable: true + allowExternalSenders: + type: boolean + description: 'Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + nullable: true + autoSubscribeNewMembers: + type: boolean + description: 'Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + nullable: true + hideFromAddressLists: + type: boolean + description: 'True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + nullable: true + hideFromOutlookClients: + type: boolean + description: 'True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + nullable: true + isSubscribedByMail: + type: boolean + description: 'Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + nullable: true + unseenCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).' + format: int32 + nullable: true + isArchived: + type: boolean + description: 'When a group is associated with a team this property determines whether the team is in read-only mode.To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.' + nullable: true + appRoleAssignments: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.appRoleAssignment' + description: Represents the app roles a group has been granted for an application. Supports $expand. + x-ms-navigationProperty: true + createdOnBehalfOf: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + memberOf: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.' + x-ms-navigationProperty: true + members: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).' + x-ms-navigationProperty: true + membersWithLicenseErrors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: A list of group members with license errors from this group-based license assignment. Read-only. + x-ms-navigationProperty: true + owners: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'The owners of the group. Limited to 100 owners. Nullable. If this property is not specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).' + x-ms-navigationProperty: true + permissionGrants: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant' + description: The permission that has been granted for a group to a specific application. Supports $expand. + x-ms-navigationProperty: true + settings: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.groupSetting' + description: 'Settings that can govern this group''s behavior, like whether members can invite guest users to the group. Nullable.' + x-ms-navigationProperty: true + transitiveMemberOf: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'The groups that a group is a member of, either directly and through nested membership. Nullable.' + x-ms-navigationProperty: true + transitiveMembers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: The direct and transitive members of a group. Nullable. + x-ms-navigationProperty: true + acceptedSenders: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post. + x-ms-navigationProperty: true + calendar: + $ref: '#/components/schemas/microsoft.graph.calendar' + calendarView: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: The calendar view for the calendar. Read-only. + x-ms-navigationProperty: true + conversations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conversation' + description: The group's conversations. + x-ms-navigationProperty: true + events: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: The group's calendar events. + x-ms-navigationProperty: true + rejectedSenders: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable + x-ms-navigationProperty: true + threads: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conversationThread' + description: The group's conversation threads. Nullable. + x-ms-navigationProperty: true + drive: + $ref: '#/components/schemas/microsoft.graph.drive' + drives: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.drive' + description: The group's drives. Read-only. + x-ms-navigationProperty: true + sites: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.site' + description: The list of SharePoint sites in this group. Access the default site with /sites/root. + x-ms-navigationProperty: true + extensions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.extension' + description: The collection of open extensions defined for the group. Read-only. Nullable. + x-ms-navigationProperty: true + groupLifecyclePolicies: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy' + description: The collection of lifecycle policies for this group. Read-only. Nullable. + x-ms-navigationProperty: true + planner: + $ref: '#/components/schemas/microsoft.graph.plannerGroup' + onenote: + $ref: '#/components/schemas/microsoft.graph.onenote' + photo: + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + photos: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + description: The profile photos owned by the group. Read-only. Nullable. + x-ms-navigationProperty: true + team: + $ref: '#/components/schemas/microsoft.graph.team' + additionalProperties: + type: object + microsoft.graph.allowedTargetScope: + title: allowedTargetScope + enum: + - notSpecified + - specificDirectoryUsers + - specificConnectedOrganizationUsers + - specificDirectoryServicePrincipals + - allMemberUsers + - allDirectoryUsers + - allDirectoryServicePrincipals + - allConfiguredConnectedOrganizationUsers + - allExternalUsers + - unknownFutureValue + type: string + microsoft.graph.accessPackageAutomaticRequestSettings: + title: accessPackageAutomaticRequestSettings + type: object + properties: + gracePeriodBeforeAccessRemoval: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + format: duration + nullable: true + removeAccessWhenTargetLeavesAllowedTargets: + type: boolean + nullable: true + requestAccessForAllowedTargets: + type: boolean + description: 'If set to true, automatic assignments will be created for targets in the allowed target scope.' + nullable: true + additionalProperties: + type: object + microsoft.graph.expirationPattern: + title: expirationPattern + type: object + properties: + duration: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + description: 'The requestor''s desired duration of access represented in ISO 8601 format for durations. For example, PT3H refers to three hours. If specified in a request, endDateTime should not be present and the type property should be set to afterDuration.' + format: duration + nullable: true + endDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Timestamp of date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + type: + $ref: '#/components/schemas/microsoft.graph.expirationPatternType' + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentApprovalSettings: + title: accessPackageAssignmentApprovalSettings + type: object + properties: + isApprovalRequiredForAdd: + type: boolean + description: 'If false, then approval is not required for new requests in this policy.' + nullable: true + isApprovalRequiredForUpdate: + type: boolean + description: 'If false, then approval is not required for updates to requests in this policy.' + nullable: true + stages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageApprovalStage' + description: 'If approval is required, the one, two or three elements of this collection define each of the stages of approval. An empty array is present if no approval is required.' + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentRequestorSettings: + title: accessPackageAssignmentRequestorSettings + type: object + properties: + allowCustomAssignmentSchedule: + type: boolean + description: 'If false, the requestor is not permitted to include a schedule in their request.' + nullable: true + enableOnBehalfRequestorsToAddAccess: + type: boolean + description: 'If true, allows on-behalf-of requestors to create a request to add access for another principal.' + nullable: true + enableOnBehalfRequestorsToRemoveAccess: + type: boolean + description: 'If true, allows on-behalf-of requestors to create a request to remove access for another principal.' + nullable: true + enableOnBehalfRequestorsToUpdateAccess: + type: boolean + description: 'If true, allows on-behalf-of requestors to create a request to update access for another principal.' + nullable: true + enableTargetsToSelfAddAccess: + type: boolean + description: 'If true, allows requestors to create a request to add access for themselves.' + nullable: true + enableTargetsToSelfRemoveAccess: + type: boolean + description: 'If true, allows requestors to create a request to remove their access.' + nullable: true + enableTargetsToSelfUpdateAccess: + type: boolean + description: 'If true, allows requestors to create a request to update their access.' + nullable: true + onBehalfRequestors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: The principals who can request on-behalf-of others. + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentReviewSettings: + title: accessPackageAssignmentReviewSettings + type: object + properties: + expirationBehavior: + $ref: '#/components/schemas/microsoft.graph.accessReviewExpirationBehavior' + fallbackReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: This collection specifies the users who will be the fallback reviewers when the primary reviewers don't respond. + isEnabled: + type: boolean + description: 'If true, access reviews are required for assignments through this policy.' + nullable: true + isRecommendationEnabled: + type: boolean + description: Specifies whether to display recommendations to the reviewer. The default value is true. + nullable: true + isReviewerJustificationRequired: + type: boolean + description: Specifies whether the reviewer must provide justification for the approval. The default value is true. + nullable: true + isSelfReview: + type: boolean + description: Specifies whether the principals can review their own assignments. + nullable: true + primaryReviewers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: This collection specifies the users or group of users who will review the access package assignments. + schedule: + $ref: '#/components/schemas/microsoft.graph.entitlementManagementSchedule' + additionalProperties: + type: object + microsoft.graph.subjectSet: + title: subjectSet + type: object + additionalProperties: + type: object + microsoft.graph.accessPackageCatalogType: + title: accessPackageCatalogType + enum: + - userManaged + - serviceDefault + - serviceManaged + - unknownFutureValue + type: string + microsoft.graph.accessPackageCatalogState: + title: accessPackageCatalogState + enum: + - unpublished + - published + - unknownFutureValue + type: string + microsoft.graph.entitlementManagementSchedule: + title: entitlementManagementSchedule + type: object + properties: + expiration: + $ref: '#/components/schemas/microsoft.graph.expirationPattern' + recurrence: + $ref: '#/components/schemas/microsoft.graph.patternedRecurrence' + startDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.' + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.accessPackageRequestType: + title: accessPackageRequestType + enum: + - notSpecified + - userAdd + - userUpdate + - userRemove + - adminAdd + - adminUpdate + - adminRemove + - systemAdd + - systemUpdate + - systemRemove + - onBehalfAdd + - unknownFutureValue + type: string + microsoft.graph.accessPackageRequestState: + title: accessPackageRequestState + enum: + - submitted + - pendingApproval + - delivering + - delivered + - deliveryFailed + - denied + - scheduled + - canceled + - partiallyDelivered + - unknownFutureValue + type: string + microsoft.graph.accessPackageAssignmentState: + title: accessPackageAssignmentState + enum: + - delivering + - partiallyDelivered + - delivered + - expired + - deliveryFailed + - unknownFutureValue + type: string + microsoft.graph.accessPackageSubjectType: + title: accessPackageSubjectType + enum: + - notSpecified + - user + - servicePrincipal + - unknownFutureValue + type: string + microsoft.graph.identitySource: + title: identitySource + type: object + additionalProperties: + type: object + microsoft.graph.connectedOrganizationState: + title: connectedOrganizationState + enum: + - configured + - proposed + - unknownFutureValue + type: string + microsoft.graph.accessPackageExternalUserLifecycleAction: + title: accessPackageExternalUserLifecycleAction + enum: + - none + - blockSignIn + - blockSignInAndDelete + - unknownFutureValue + type: string + ReferenceCreate: + type: object + properties: + '@odata.id': + type: string + additionalProperties: + type: object + microsoft.graph.agreementCollectionResponse: + title: Collection of agreement + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreement' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.ODataErrors.ODataError: + required: + - error + type: object + properties: + error: + $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError' + additionalProperties: + type: object + microsoft.graph.agreementAcceptanceCollectionResponse: + title: Collection of agreementAcceptance + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.agreementFileLocalizationCollectionResponse: + title: Collection of agreementFileLocalization + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementFileLocalization' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.agreementFileVersionCollectionResponse: + title: Collection of agreementFileVersion + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementFileVersion' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewScheduleDefinitionCollectionResponse: + title: Collection of accessReviewScheduleDefinition + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewInstanceCollectionResponse: + title: Collection of accessReviewInstance + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstance' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewReviewerCollectionResponse: + title: Collection of accessReviewReviewer + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewReviewer' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewInstanceDecisionItemCollectionResponse: + title: Collection of accessReviewInstanceDecisionItem + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewStageCollectionResponse: + title: Collection of accessReviewStage + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewStage' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewHistoryDefinitionCollectionResponse: + title: Collection of accessReviewHistoryDefinition + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryDefinition' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewHistoryInstanceCollectionResponse: + title: Collection of accessReviewHistoryInstance + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessReviewHistoryInstance' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.appConsentRequestCollectionResponse: + title: Collection of appConsentRequest + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.appConsentRequest' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.userConsentRequestCollectionResponse: + title: Collection of userConsentRequest + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userConsentRequest' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.approvalStageCollectionResponse: + title: Collection of approvalStage + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.approvalStage' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.approvalCollectionResponse: + title: Collection of approval + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.approval' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessPackageCollectionResponse: + title: Collection of accessPackage + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackage' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentPolicyCollectionResponse: + title: Collection of accessPackageAssignmentPolicy + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentPolicy' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + StringCollectionResponse: + title: Collection of string + type: object + properties: + value: + type: array + items: + type: string + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.groupCollectionResponse: + title: Collection of group + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.group' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentRequestCollectionResponse: + title: Collection of accessPackageAssignmentRequest + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignmentRequest' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessPackageAssignmentCollectionResponse: + title: Collection of accessPackageAssignment + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageAssignment' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.accessPackageCatalogCollectionResponse: + title: Collection of accessPackageCatalog + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.accessPackageCatalog' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.connectedOrganizationCollectionResponse: + title: Collection of connectedOrganization + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.connectedOrganization' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.directoryObjectCollectionResponse: + title: Collection of directoryObject + type: object + properties: + value: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + '@odata.nextLink': + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.agreementFileData: + title: agreementFileData + type: object + properties: + data: + type: string + description: Data that represents the terms of use PDF document. Read-only. + format: base64url + nullable: true + additionalProperties: + type: object + microsoft.graph.accessReviewNotificationRecipientScope: + title: accessReviewNotificationRecipientScope + type: object + additionalProperties: + type: object + microsoft.graph.accessReviewApplyAction: + title: accessReviewApplyAction + type: object + additionalProperties: + type: object + microsoft.graph.patternedRecurrence: + title: patternedRecurrence + type: object + properties: + pattern: + $ref: '#/components/schemas/microsoft.graph.recurrencePattern' + range: + $ref: '#/components/schemas/microsoft.graph.recurrenceRange' + additionalProperties: + type: object + microsoft.graph.identitySet: + title: identitySet + type: object + properties: + application: + $ref: '#/components/schemas/microsoft.graph.identity' + device: + $ref: '#/components/schemas/microsoft.graph.identity' + user: + $ref: '#/components/schemas/microsoft.graph.identity' + additionalProperties: + type: object + microsoft.graph.assignedLabel: + title: assignedLabel + type: object + properties: + displayName: + type: string + description: The display name of the label. Read-only. + nullable: true + labelId: + type: string + description: The unique identifier of the label. + nullable: true + additionalProperties: + type: object + microsoft.graph.assignedLicense: + title: assignedLicense + type: object + properties: + disabledPlans: + type: array + items: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + format: uuid + description: A collection of the unique identifiers for plans that have been disabled. + skuId: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + description: The unique identifier for the SKU. + format: uuid + nullable: true + additionalProperties: + type: object + microsoft.graph.licenseProcessingState: + title: licenseProcessingState + type: object + properties: + state: + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.onPremisesProvisioningError: + title: onPremisesProvisioningError + type: object + properties: + category: + type: string + description: 'Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.' + nullable: true + occurredDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The date and time at which the error occurred. + format: date-time + nullable: true + propertyCausingError: + type: string + description: 'Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress' + nullable: true + value: + type: string + description: Value of the property causing the error. + nullable: true + additionalProperties: + type: object + microsoft.graph.appRoleAssignment: + allOf: + - $ref: '#/components/schemas/microsoft.graph.directoryObject' + - title: appRoleAssignment + type: object + properties: + appRoleId: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + description: 'The identifier (id) for the app role which is assigned to the principal. This app role must be exposed in the appRoles property on the resource application''s service principal (resourceId). If the resource application has not declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.' + format: uuid + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + principalDisplayName: + type: string + description: 'The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).' + nullable: true + principalId: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + description: 'The unique identifier (id) for the user, group, or service principal being granted the app role. Required on create.' + format: uuid + nullable: true + principalType: + type: string + description: 'The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.' + nullable: true + resourceDisplayName: + type: string + description: The display name of the resource app's service principal to which the assignment is made. + nullable: true + resourceId: + pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' + type: string + description: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only). + format: uuid + nullable: true + additionalProperties: + type: object + microsoft.graph.resourceSpecificPermissionGrant: + allOf: + - $ref: '#/components/schemas/microsoft.graph.directoryObject' + - title: resourceSpecificPermissionGrant + type: object + properties: + clientAppId: + type: string + description: ID of the service principal of the Azure AD app that has been granted access. Read-only. + nullable: true + clientId: + type: string + description: ID of the Azure AD app that has been granted access. Read-only. + nullable: true + permission: + type: string + description: The name of the resource-specific permission. Read-only. + nullable: true + permissionType: + type: string + description: 'The type of permission. Possible values are: Application, Delegated. Read-only.' + nullable: true + resourceAppId: + type: string + description: ID of the Azure AD app that is hosting the resource. Read-only. + nullable: true + additionalProperties: + type: object + microsoft.graph.groupSetting: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: groupSetting + type: object + properties: + displayName: + type: string + description: 'Display name of this group of settings, which comes from the associated template.' + nullable: true + templateId: + type: string + description: Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only. + nullable: true + values: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.settingValue' + description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object. + additionalProperties: + type: object + microsoft.graph.calendar: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: calendar + type: object + properties: + allowedOnlineMeetingProviders: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType' + description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.' + canEdit: + type: boolean + description: 'true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who has been shared a calendar and granted write access.' + nullable: true + canShare: + type: boolean + description: 'true if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it.' + nullable: true + canViewPrivateItems: + type: boolean + description: 'true if the user can read calendar items that have been marked private, false otherwise.' + nullable: true + changeKey: + type: string + description: 'Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.' + nullable: true + color: + $ref: '#/components/schemas/microsoft.graph.calendarColor' + defaultOnlineMeetingProvider: + $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType' + hexColor: + type: string + description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.' + nullable: true + isDefaultCalendar: + type: boolean + description: 'true if this is the default calendar where new events are created by default, false otherwise.' + nullable: true + isRemovable: + type: boolean + description: Indicates whether this user calendar can be deleted from the user mailbox. + nullable: true + isTallyingResponses: + type: boolean + description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses. + nullable: true + name: + type: string + description: The calendar name. + nullable: true + owner: + $ref: '#/components/schemas/microsoft.graph.emailAddress' + calendarPermissions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.calendarPermission' + description: The permissions of the users with whom the calendar is shared. + x-ms-navigationProperty: true + calendarView: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: The calendar view for the calendar. Navigation property. Read-only. + x-ms-navigationProperty: true + events: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: The events in the calendar. Navigation property. Read-only. + x-ms-navigationProperty: true + multiValueExtendedProperties: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty' + description: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable. + x-ms-navigationProperty: true + singleValueExtendedProperties: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty' + description: The collection of single-value extended properties defined for the calendar. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.event: + allOf: + - $ref: '#/components/schemas/microsoft.graph.outlookItem' + - title: event + type: object + properties: + allowNewTimeProposals: + type: boolean + description: 'true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. Default is true.' + nullable: true + attendees: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.attendee' + description: The collection of attendees for the event. + body: + $ref: '#/components/schemas/microsoft.graph.itemBody' + bodyPreview: + type: string + description: The preview of the message associated with the event. It is in text format. + nullable: true + end: + $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone' + hasAttachments: + type: boolean + description: Set to true if the event has attachments. + nullable: true + hideAttendees: + type: boolean + description: 'When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.' + nullable: true + iCalUId: + type: string + description: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only. + nullable: true + importance: + $ref: '#/components/schemas/microsoft.graph.importance' + isAllDay: + type: boolean + nullable: true + isCancelled: + type: boolean + nullable: true + isDraft: + type: boolean + nullable: true + isOnlineMeeting: + type: boolean + nullable: true + isOrganizer: + type: boolean + nullable: true + isReminderOn: + type: boolean + nullable: true + location: + $ref: '#/components/schemas/microsoft.graph.location' + locations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.location' + onlineMeeting: + $ref: '#/components/schemas/microsoft.graph.onlineMeetingInfo' + onlineMeetingProvider: + $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType' + onlineMeetingUrl: + type: string + nullable: true + organizer: + $ref: '#/components/schemas/microsoft.graph.recipient' + originalEndTimeZone: + type: string + nullable: true + originalStart: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + format: date-time + nullable: true + originalStartTimeZone: + type: string + nullable: true + recurrence: + $ref: '#/components/schemas/microsoft.graph.patternedRecurrence' + reminderMinutesBeforeStart: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + responseRequested: + type: boolean + nullable: true + responseStatus: + $ref: '#/components/schemas/microsoft.graph.responseStatus' + sensitivity: + $ref: '#/components/schemas/microsoft.graph.sensitivity' + seriesMasterId: + type: string + nullable: true + showAs: + $ref: '#/components/schemas/microsoft.graph.freeBusyStatus' + start: + $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone' + subject: + type: string + nullable: true + transactionId: + type: string + nullable: true + type: + $ref: '#/components/schemas/microsoft.graph.eventType' + webLink: + type: string + nullable: true + attachments: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.attachment' + description: 'The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.' + x-ms-navigationProperty: true + calendar: + $ref: '#/components/schemas/microsoft.graph.calendar' + extensions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.extension' + description: The collection of open extensions defined for the event. Nullable. + x-ms-navigationProperty: true + instances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: 'The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions that have been modified, but does not include occurrences that have been cancelled from the series. Navigation property. Read-only. Nullable.' + x-ms-navigationProperty: true + multiValueExtendedProperties: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty' + description: The collection of multi-value extended properties defined for the event. Read-only. Nullable. + x-ms-navigationProperty: true + singleValueExtendedProperties: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty' + description: The collection of single-value extended properties defined for the event. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.conversation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: conversation + type: object + properties: + hasAttachments: + type: boolean + description: 'Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.' + lastDeliveredDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + preview: + type: string + description: 'A short summary from the body of the latest post in this conversation. Supports $filter (eq, ne, le, ge).' + topic: + type: string + description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.' + uniqueSenders: + type: array + items: + type: string + description: All the users that sent a message to this Conversation. + threads: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conversationThread' + description: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.conversationThread: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: conversationThread + type: object + properties: + ccRecipients: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.recipient' + description: 'The Cc: recipients for the thread. Returned only on $select.' + hasAttachments: + type: boolean + description: Indicates whether any of the posts within this thread has at least one attachment. Returned by default. + isLocked: + type: boolean + description: Indicates if the thread is locked. Returned by default. + lastDeliveredDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.Returned by default.' + format: date-time + preview: + type: string + description: A short summary from the body of the latest post in this conversation. Returned by default. + topic: + type: string + description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.' + toRecipients: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.recipient' + description: 'The To: recipients for the thread. Returned only on $select.' + uniqueSenders: + type: array + items: + type: string + description: All the users that sent a message to this thread. Returned by default. + posts: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.post' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.drive: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItem' + - title: drive + type: object + properties: + driveType: + type: string + description: Describes the type of drive represented by this resource. OneDrive personal drives will return personal. OneDrive for Business will return business. SharePoint document libraries will return documentLibrary. Read-only. + nullable: true + owner: + $ref: '#/components/schemas/microsoft.graph.identitySet' + quota: + $ref: '#/components/schemas/microsoft.graph.quota' + sharePointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + system: + $ref: '#/components/schemas/microsoft.graph.systemFacet' + bundles: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.driveItem' + description: 'Collection of [bundles][bundle] (albums and multi-select-shared sets of items). Only in personal OneDrive.' + x-ms-navigationProperty: true + following: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.driveItem' + description: The list of items the user is following. Only in OneDrive for Business. + x-ms-navigationProperty: true + items: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.driveItem' + description: All items contained in the drive. Read-only. Nullable. + x-ms-navigationProperty: true + list: + $ref: '#/components/schemas/microsoft.graph.list' + root: + $ref: '#/components/schemas/microsoft.graph.driveItem' + special: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.driveItem' + description: Collection of common folders available in OneDrive. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.site: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItem' + - title: site + type: object + properties: + displayName: + type: string + description: The full title for the site. Read-only. + nullable: true + error: + $ref: '#/components/schemas/microsoft.graph.publicError' + root: + $ref: '#/components/schemas/microsoft.graph.root' + sharepointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + siteCollection: + $ref: '#/components/schemas/microsoft.graph.siteCollection' + analytics: + $ref: '#/components/schemas/microsoft.graph.itemAnalytics' + columns: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + description: The collection of column definitions reusable across lists under this site. + x-ms-navigationProperty: true + contentTypes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.contentType' + description: The collection of content types defined for this site. + x-ms-navigationProperty: true + drive: + $ref: '#/components/schemas/microsoft.graph.drive' + drives: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.drive' + description: The collection of drives (document libraries) under this site. + x-ms-navigationProperty: true + externalColumns: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + x-ms-navigationProperty: true + items: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.baseItem' + description: Used to address any item contained in this site. This collection can't be enumerated. + x-ms-navigationProperty: true + lists: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.list' + description: The collection of lists under this site. + x-ms-navigationProperty: true + operations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.richLongRunningOperation' + description: The collection of long-running operations on the site. + x-ms-navigationProperty: true + permissions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.permission' + description: The permissions associated with the site. Nullable. + x-ms-navigationProperty: true + sites: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.site' + description: The collection of the sub-sites under this site. + x-ms-navigationProperty: true + termStore: + $ref: '#/components/schemas/microsoft.graph.termStore.store' + termStores: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.termStore.store' + description: The collection of termStores under this site. + x-ms-navigationProperty: true + onenote: + $ref: '#/components/schemas/microsoft.graph.onenote' + additionalProperties: + type: object + microsoft.graph.extension: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: extension + type: object + additionalProperties: + type: object + microsoft.graph.groupLifecyclePolicy: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: groupLifecyclePolicy + type: object + properties: + alternateNotificationEmails: + type: string + description: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon. + nullable: true + groupLifetimeInDays: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.' + format: int32 + nullable: true + managedGroupTypes: + type: string + description: 'The group type for which the expiration policy applies. Possible values are All, Selected or None.' + nullable: true + additionalProperties: + type: object + microsoft.graph.plannerGroup: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: plannerGroup + type: object + properties: + plans: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.plannerPlan' + description: Read-only. Nullable. Returns the plannerPlans owned by the group. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.onenote: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: onenote + type: object + properties: + notebooks: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.notebook' + description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable. + x-ms-navigationProperty: true + operations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenoteOperation' + description: 'The status of OneNote operations. Getting an operations collection is not supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.' + x-ms-navigationProperty: true + pages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenotePage' + description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable. + x-ms-navigationProperty: true + resources: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenoteResource' + description: 'The image and other file resources in OneNote pages. Getting a resources collection is not supported, but you can get the binary content of a specific resource. Read-only. Nullable.' + x-ms-navigationProperty: true + sectionGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.sectionGroup' + description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable. + x-ms-navigationProperty: true + sections: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenoteSection' + description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.profilePhoto: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: profilePhoto + type: object + properties: + height: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The height of the photo. Read-only. + format: int32 + nullable: true + width: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The width of the photo. Read-only. + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.team: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: team + type: object + properties: + classification: + type: string + description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory. + nullable: true + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Timestamp at which the team was created. + format: date-time + nullable: true + description: + type: string + description: 'An optional description for the team. Maximum length: 1024 characters.' + nullable: true + displayName: + type: string + description: The name of the team. + nullable: true + funSettings: + $ref: '#/components/schemas/microsoft.graph.teamFunSettings' + guestSettings: + $ref: '#/components/schemas/microsoft.graph.teamGuestSettings' + internalId: + type: string + description: A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API. + nullable: true + isArchived: + type: boolean + description: Whether this team is in read-only mode. + nullable: true + memberSettings: + $ref: '#/components/schemas/microsoft.graph.teamMemberSettings' + messagingSettings: + $ref: '#/components/schemas/microsoft.graph.teamMessagingSettings' + specialization: + $ref: '#/components/schemas/microsoft.graph.teamSpecialization' + summary: + $ref: '#/components/schemas/microsoft.graph.teamSummary' + tenantId: + type: string + description: The ID of the Azure Active Directory tenant. + nullable: true + visibility: + $ref: '#/components/schemas/microsoft.graph.teamVisibilityType' + webUrl: + type: string + description: 'A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.' + nullable: true + allChannels: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.channel' + description: List of channels either hosted in or shared with the team (incoming channels). + x-ms-navigationProperty: true + channels: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.channel' + description: The collection of channels and messages associated with the team. + x-ms-navigationProperty: true + group: + $ref: '#/components/schemas/microsoft.graph.group' + incomingChannels: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.channel' + description: List of channels shared with the team. + x-ms-navigationProperty: true + installedApps: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation' + description: The apps installed in this team. + x-ms-navigationProperty: true + members: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conversationMember' + description: Members and owners of the team. + x-ms-navigationProperty: true + operations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation' + description: The async operations that ran or are running on this team. + x-ms-navigationProperty: true + photo: + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + primaryChannel: + $ref: '#/components/schemas/microsoft.graph.channel' + tags: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.teamworkTag' + x-ms-navigationProperty: true + template: + $ref: '#/components/schemas/microsoft.graph.teamsTemplate' + schedule: + $ref: '#/components/schemas/microsoft.graph.schedule' + additionalProperties: + type: object + microsoft.graph.expirationPatternType: + title: expirationPatternType + enum: + - notSpecified + - noExpiration + - afterDateTime + - afterDuration + type: string + microsoft.graph.accessPackageApprovalStage: + title: accessPackageApprovalStage + type: object + properties: + durationBeforeAutomaticDenial: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + description: The number of days that a request can be pending a response before it is automatically denied. + format: duration + nullable: true + durationBeforeEscalation: + pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' + type: string + description: 'If escalation is required, the time a request can be pending a response from a primary approver.' + format: duration + nullable: true + escalationApprovers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: 'If escalation is enabled and the primary approvers do not respond before the escalation time, the escalationApprovers are the users who will be asked to approve requests.' + fallbackEscalationApprovers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: 'The subjects, typically users, who are the fallback escalation approvers.' + fallbackPrimaryApprovers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: 'The subjects, typically users, who are the fallback primary approvers.' + isApproverJustificationRequired: + type: boolean + description: Indicates whether the approver is required to provide a justification for approving a request. + nullable: true + isEscalationEnabled: + type: boolean + description: 'If true, then one or more escalationApprovers are configured in this approval stage.' + nullable: true + primaryApprovers: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subjectSet' + description: 'The subjects, typically users, who will be asked to approve requests. A collection of singleUser, groupMembers, requestorManager, internalSponsors or externalSponsors.' + additionalProperties: + type: object + microsoft.graph.accessReviewExpirationBehavior: + title: accessReviewExpirationBehavior + enum: + - keepAccess + - removeAccess + - acceptAccessRecommendation + - unknownFutureValue + type: string + microsoft.graph.ODataErrors.MainError: + required: + - code + - message + type: object + properties: + code: + type: string + message: + type: string + target: + type: string + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' + innererror: + $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' + additionalProperties: + type: object + microsoft.graph.recurrencePattern: + title: recurrencePattern + type: object + properties: + dayOfMonth: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly. + format: int32 + daysOfWeek: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.dayOfWeek' + description: 'A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.' + firstDayOfWeek: + $ref: '#/components/schemas/microsoft.graph.dayOfWeek' + index: + $ref: '#/components/schemas/microsoft.graph.weekIndex' + interval: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.' + format: int32 + month: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The month in which the event occurs. This is a number from 1 to 12. + format: int32 + type: + $ref: '#/components/schemas/microsoft.graph.recurrencePatternType' + additionalProperties: + type: object + microsoft.graph.recurrenceRange: + title: recurrenceRange + type: object + properties: + endDate: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$' + type: string + description: 'The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.' + format: date + nullable: true + numberOfOccurrences: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of times to repeat the event. Required and must be positive if type is numbered. + format: int32 + recurrenceTimeZone: + type: string + description: 'Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.' + nullable: true + startDate: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$' + type: string + description: 'The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.' + format: date + nullable: true + type: + $ref: '#/components/schemas/microsoft.graph.recurrenceRangeType' + additionalProperties: + type: object + microsoft.graph.settingValue: + title: settingValue + type: object + properties: + name: + type: string + description: Name of the setting (as defined by the groupSettingTemplate). + nullable: true + value: + type: string + description: Value of the setting. + nullable: true + additionalProperties: + type: object + microsoft.graph.onlineMeetingProviderType: + title: onlineMeetingProviderType + enum: + - unknown + - skypeForBusiness + - skypeForConsumer + - teamsForBusiness + type: string + microsoft.graph.calendarColor: + title: calendarColor + enum: + - auto + - lightBlue + - lightGreen + - lightOrange + - lightGray + - lightYellow + - lightTeal + - lightPink + - lightBrown + - lightRed + - maxColor + type: string + microsoft.graph.emailAddress: + title: emailAddress + type: object + properties: + address: + type: string + description: The email address of the person or entity. + nullable: true + name: + type: string + description: The display name of the person or entity. + nullable: true + additionalProperties: + type: object + microsoft.graph.calendarPermission: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: calendarPermission + type: object + properties: + allowedRoles: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.calendarRoleType' + description: 'List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.' + emailAddress: + $ref: '#/components/schemas/microsoft.graph.emailAddress' + isInsideOrganization: + type: boolean + description: True if the user in context (sharee or delegate) is inside the same organization as the calendar owner. + nullable: true + isRemovable: + type: boolean + description: 'True if the user can be removed from the list of sharees or delegates for the specified calendar, false otherwise. The ''My organization'' user determines the permissions other people within your organization have to the given calendar. You cannot remove ''My organization'' as a sharee to a calendar.' + nullable: true + role: + $ref: '#/components/schemas/microsoft.graph.calendarRoleType' + additionalProperties: + type: object + microsoft.graph.multiValueLegacyExtendedProperty: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: multiValueLegacyExtendedProperty + type: object + properties: + value: + type: array + items: + type: string + nullable: true + description: A collection of property values. + additionalProperties: + type: object + microsoft.graph.singleValueLegacyExtendedProperty: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: singleValueLegacyExtendedProperty + type: object + properties: + value: + type: string + description: A property value. + nullable: true + additionalProperties: + type: object + microsoft.graph.outlookItem: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: outlookItem + type: object + properties: + categories: + type: array + items: + type: string + nullable: true + description: The categories associated with the item + changeKey: + type: string + description: 'Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.' + nullable: true + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + nullable: true + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.attendee: + allOf: + - $ref: '#/components/schemas/microsoft.graph.attendeeBase' + - title: attendee + type: object + properties: + proposedNewTime: + $ref: '#/components/schemas/microsoft.graph.timeSlot' + status: + $ref: '#/components/schemas/microsoft.graph.responseStatus' + additionalProperties: + type: object + microsoft.graph.itemBody: + title: itemBody + type: object + properties: + content: + type: string + description: The content of the item. + nullable: true + contentType: + $ref: '#/components/schemas/microsoft.graph.bodyType' + additionalProperties: + type: object + microsoft.graph.dateTimeTimeZone: + title: dateTimeTimeZone + type: object + properties: + dateTime: + type: string + description: 'A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).' + timeZone: + type: string + description: 'Represents a time zone, for example, ''Pacific Standard Time''. See below for more possible values.' + nullable: true + additionalProperties: + type: object + microsoft.graph.importance: + title: importance + enum: + - low + - normal + - high + type: string + microsoft.graph.location: + title: location + type: object + properties: + address: + $ref: '#/components/schemas/microsoft.graph.physicalAddress' + coordinates: + $ref: '#/components/schemas/microsoft.graph.outlookGeoCoordinates' + displayName: + type: string + description: The name associated with the location. + nullable: true + locationEmailAddress: + type: string + description: Optional email address of the location. + nullable: true + locationType: + $ref: '#/components/schemas/microsoft.graph.locationType' + locationUri: + type: string + description: Optional URI representing the location. + nullable: true + uniqueId: + type: string + description: For internal use only. + nullable: true + uniqueIdType: + $ref: '#/components/schemas/microsoft.graph.locationUniqueIdType' + additionalProperties: + type: object + microsoft.graph.onlineMeetingInfo: + title: onlineMeetingInfo + type: object + properties: + conferenceId: + type: string + description: The ID of the conference. + nullable: true + joinUrl: + type: string + description: The external link that launches the online meeting. This is a URL that clients will launch into a browser and will redirect the user to join the meeting. + nullable: true + phones: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.phone' + description: All of the phone numbers associated with this conference. + quickDial: + type: string + description: The pre-formatted quickdial for this call. + nullable: true + tollFreeNumbers: + type: array + items: + type: string + nullable: true + description: The toll free numbers that can be used to join the conference. + tollNumber: + type: string + description: The toll number that can be used to join the conference. + nullable: true + additionalProperties: + type: object + microsoft.graph.recipient: + title: recipient + type: object + properties: + emailAddress: + $ref: '#/components/schemas/microsoft.graph.emailAddress' + additionalProperties: + type: object + microsoft.graph.responseStatus: + title: responseStatus + type: object + properties: + response: + $ref: '#/components/schemas/microsoft.graph.responseType' + time: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.sensitivity: + title: sensitivity + enum: + - normal + - personal + - private + - confidential + type: string + microsoft.graph.freeBusyStatus: + title: freeBusyStatus + enum: + - unknown + - free + - tentative + - busy + - oof + - workingElsewhere + type: string + microsoft.graph.eventType: + title: eventType + enum: + - singleInstance + - occurrence + - exception + - seriesMaster + type: string + microsoft.graph.attachment: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: attachment + type: object + properties: + contentType: + type: string + description: The MIME type. + nullable: true + isInline: + type: boolean + description: 'true if the attachment is an inline attachment; otherwise, false.' + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + nullable: true + name: + type: string + description: The attachment's file name. + nullable: true + size: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The length of the attachment in bytes. + format: int32 + additionalProperties: + type: object + microsoft.graph.post: + allOf: + - $ref: '#/components/schemas/microsoft.graph.outlookItem' + - title: post + type: object + properties: + body: + $ref: '#/components/schemas/microsoft.graph.itemBody' + conversationId: + type: string + description: Unique ID of the conversation. Read-only. + nullable: true + conversationThreadId: + type: string + description: Unique ID of the conversation thread. Read-only. + nullable: true + from: + $ref: '#/components/schemas/microsoft.graph.recipient' + hasAttachments: + type: boolean + description: Indicates whether the post has at least one attachment. This is a default property. + newParticipants: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.recipient' + description: Conversation participants that were added to the thread as part of this post. + receivedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Specifies when the post was received. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + sender: + $ref: '#/components/schemas/microsoft.graph.recipient' + attachments: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.attachment' + description: Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + extensions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.extension' + description: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + inReplyTo: + $ref: '#/components/schemas/microsoft.graph.post' + multiValueExtendedProperties: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty' + description: The collection of multi-value extended properties defined for the post. Read-only. Nullable. + x-ms-navigationProperty: true + singleValueExtendedProperties: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty' + description: The collection of single-value extended properties defined for the post. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.baseItem: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: baseItem + type: object + properties: + createdBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Date and time of item creation. Read-only. + format: date-time + description: + type: string + description: Provides a user-visible description of the item. Optional. + nullable: true + eTag: + type: string + description: ETag for the item. Read-only. + nullable: true + lastModifiedBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Date and time the item was last modified. Read-only. + format: date-time + name: + type: string + description: The name of the item. Read-write. + nullable: true + parentReference: + $ref: '#/components/schemas/microsoft.graph.itemReference' + webUrl: + type: string + description: URL that displays the resource in the browser. Read-only. + nullable: true + createdByUser: + $ref: '#/components/schemas/microsoft.graph.user' + lastModifiedByUser: + $ref: '#/components/schemas/microsoft.graph.user' + additionalProperties: + type: object + microsoft.graph.quota: + title: quota + type: object + properties: + deleted: + type: integer + description: 'Total space consumed by files in the recycle bin, in bytes. Read-only.' + format: int64 + nullable: true + remaining: + type: integer + description: 'Total space remaining before reaching the quota limit, in bytes. Read-only.' + format: int64 + nullable: true + state: + type: string + description: Enumeration value that indicates the state of the storage space. Read-only. + nullable: true + storagePlanInformation: + $ref: '#/components/schemas/microsoft.graph.storagePlanInformation' + total: + type: integer + description: 'Total allowed storage space, in bytes. Read-only.' + format: int64 + nullable: true + used: + type: integer + description: 'Total space used, in bytes. Read-only.' + format: int64 + nullable: true + additionalProperties: + type: object + microsoft.graph.sharepointIds: + title: sharepointIds + type: object + properties: + listId: + type: string + description: The unique identifier (guid) for the item's list in SharePoint. + nullable: true + listItemId: + type: string + description: An integer identifier for the item within the containing list. + nullable: true + listItemUniqueId: + type: string + description: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site. + nullable: true + siteId: + type: string + description: The unique identifier (guid) for the item's site collection (SPSite). + nullable: true + siteUrl: + type: string + description: The SharePoint URL for the site that contains the item. + nullable: true + tenantId: + type: string + description: The unique identifier (guid) for the tenancy. + nullable: true + webId: + type: string + description: The unique identifier (guid) for the item's site (SPWeb). + nullable: true + additionalProperties: + type: object + microsoft.graph.systemFacet: + title: systemFacet + type: object + additionalProperties: + type: object + microsoft.graph.driveItem: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItem' + - title: driveItem + type: object + properties: + audio: + $ref: '#/components/schemas/microsoft.graph.audio' + bundle: + $ref: '#/components/schemas/microsoft.graph.bundle' + content: + type: string + description: 'The content stream, if the item represents a file.' + format: base64url + nullable: true + cTag: + type: string + description: An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only. + nullable: true + deleted: + $ref: '#/components/schemas/microsoft.graph.deleted' + file: + $ref: '#/components/schemas/microsoft.graph.file' + fileSystemInfo: + $ref: '#/components/schemas/microsoft.graph.fileSystemInfo' + folder: + $ref: '#/components/schemas/microsoft.graph.folder' + image: + $ref: '#/components/schemas/microsoft.graph.image' + location: + $ref: '#/components/schemas/microsoft.graph.geoCoordinates' + malware: + $ref: '#/components/schemas/microsoft.graph.malware' + package: + $ref: '#/components/schemas/microsoft.graph.package' + pendingOperations: + $ref: '#/components/schemas/microsoft.graph.pendingOperations' + photo: + $ref: '#/components/schemas/microsoft.graph.photo' + publication: + $ref: '#/components/schemas/microsoft.graph.publicationFacet' + remoteItem: + $ref: '#/components/schemas/microsoft.graph.remoteItem' + root: + $ref: '#/components/schemas/microsoft.graph.root' + searchResult: + $ref: '#/components/schemas/microsoft.graph.searchResult' + shared: + $ref: '#/components/schemas/microsoft.graph.shared' + sharepointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + size: + type: integer + description: Size of the item in bytes. Read-only. + format: int64 + nullable: true + specialFolder: + $ref: '#/components/schemas/microsoft.graph.specialFolder' + video: + $ref: '#/components/schemas/microsoft.graph.video' + webDavUrl: + type: string + description: WebDAV compatible URL for the item. + nullable: true + workbook: + $ref: '#/components/schemas/microsoft.graph.workbook' + analytics: + $ref: '#/components/schemas/microsoft.graph.itemAnalytics' + children: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.driveItem' + description: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable. + x-ms-navigationProperty: true + listItem: + $ref: '#/components/schemas/microsoft.graph.listItem' + permissions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.permission' + description: The set of permissions for the item. Read-only. Nullable. + x-ms-navigationProperty: true + subscriptions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subscription' + description: The set of subscriptions on the item. Only supported on the root of a drive. + x-ms-navigationProperty: true + thumbnails: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.thumbnailSet' + description: 'Collection containing [ThumbnailSet][] objects associated with the item. For more info, see [getting thumbnails][]. Read-only. Nullable.' + x-ms-navigationProperty: true + versions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.driveItemVersion' + description: 'The list of previous versions of the item. For more info, see [getting previous versions][]. Read-only. Nullable.' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.list: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItem' + - title: list + type: object + properties: + displayName: + type: string + description: The displayable title of the list. + nullable: true + list: + $ref: '#/components/schemas/microsoft.graph.listInfo' + sharepointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + system: + $ref: '#/components/schemas/microsoft.graph.systemFacet' + columns: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + description: The collection of field definitions for this list. + x-ms-navigationProperty: true + contentTypes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.contentType' + description: The collection of content types present in this list. + x-ms-navigationProperty: true + drive: + $ref: '#/components/schemas/microsoft.graph.drive' + items: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.listItem' + description: All items contained in the list. + x-ms-navigationProperty: true + operations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.richLongRunningOperation' + description: The collection of long-running operations on the list. + x-ms-navigationProperty: true + subscriptions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.subscription' + description: The set of subscriptions on the list. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.publicError: + title: publicError + type: object + properties: + code: + type: string + description: Represents the error code. + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.publicErrorDetail' + description: Details of the error. + innerError: + $ref: '#/components/schemas/microsoft.graph.publicInnerError' + message: + type: string + description: A non-localized message for the developer. + nullable: true + target: + type: string + description: The target of the error. + nullable: true + additionalProperties: + type: object + microsoft.graph.root: + title: root + type: object + additionalProperties: + type: object + microsoft.graph.siteCollection: + title: siteCollection + type: object + properties: + dataLocationCode: + type: string + description: The geographic region code for where this site collection resides. Read-only. + nullable: true + hostname: + type: string + description: The hostname for the site collection. Read-only. + nullable: true + root: + $ref: '#/components/schemas/microsoft.graph.root' + additionalProperties: + type: object + microsoft.graph.itemAnalytics: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: itemAnalytics + type: object + properties: + allTime: + $ref: '#/components/schemas/microsoft.graph.itemActivityStat' + itemActivityStats: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.itemActivityStat' + x-ms-navigationProperty: true + lastSevenDays: + $ref: '#/components/schemas/microsoft.graph.itemActivityStat' + additionalProperties: + type: object + microsoft.graph.columnDefinition: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: columnDefinition + type: object + properties: + boolean: + $ref: '#/components/schemas/microsoft.graph.booleanColumn' + calculated: + $ref: '#/components/schemas/microsoft.graph.calculatedColumn' + choice: + $ref: '#/components/schemas/microsoft.graph.choiceColumn' + columnGroup: + type: string + description: 'For site columns, the name of the group this column belongs to. Helps organize related columns.' + nullable: true + contentApprovalStatus: + $ref: '#/components/schemas/microsoft.graph.contentApprovalStatusColumn' + currency: + $ref: '#/components/schemas/microsoft.graph.currencyColumn' + dateTime: + $ref: '#/components/schemas/microsoft.graph.dateTimeColumn' + defaultValue: + $ref: '#/components/schemas/microsoft.graph.defaultColumnValue' + description: + type: string + description: The user-facing description of the column. + nullable: true + displayName: + type: string + description: The user-facing name of the column. + nullable: true + enforceUniqueValues: + type: boolean + description: 'If true, no two list items may have the same value for this column.' + nullable: true + geolocation: + $ref: '#/components/schemas/microsoft.graph.geolocationColumn' + hidden: + type: boolean + description: Specifies whether the column is displayed in the user interface. + nullable: true + hyperlinkOrPicture: + $ref: '#/components/schemas/microsoft.graph.hyperlinkOrPictureColumn' + indexed: + type: boolean + description: Specifies whether the column values can be used for sorting and searching. + nullable: true + isDeletable: + type: boolean + description: Indicates whether this column can be deleted. + nullable: true + isReorderable: + type: boolean + description: Indicates whether values in the column can be reordered. Read-only. + nullable: true + isSealed: + type: boolean + description: Specifies whether the column can be changed. + nullable: true + lookup: + $ref: '#/components/schemas/microsoft.graph.lookupColumn' + name: + type: string + description: 'The API-facing name of the column as it appears in the [fields][] on a [listItem][]. For the user-facing name, see displayName.' + nullable: true + number: + $ref: '#/components/schemas/microsoft.graph.numberColumn' + personOrGroup: + $ref: '#/components/schemas/microsoft.graph.personOrGroupColumn' + propagateChanges: + type: boolean + description: 'If ''true'', changes to this column will be propagated to lists that implement the column.' + nullable: true + readOnly: + type: boolean + description: Specifies whether the column values can be modified. + nullable: true + required: + type: boolean + description: Specifies whether the column value isn't optional. + nullable: true + sourceContentType: + $ref: '#/components/schemas/microsoft.graph.contentTypeInfo' + term: + $ref: '#/components/schemas/microsoft.graph.termColumn' + text: + $ref: '#/components/schemas/microsoft.graph.textColumn' + thumbnail: + $ref: '#/components/schemas/microsoft.graph.thumbnailColumn' + type: + $ref: '#/components/schemas/microsoft.graph.columnTypes' + validation: + $ref: '#/components/schemas/microsoft.graph.columnValidation' + sourceColumn: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + additionalProperties: + type: object + microsoft.graph.contentType: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: contentType + type: object + properties: + associatedHubsUrls: + type: array + items: + type: string + nullable: true + description: List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type will be applied to the lists in the enforced sites. + description: + type: string + description: The descriptive text for the item. + nullable: true + documentSet: + $ref: '#/components/schemas/microsoft.graph.documentSet' + documentTemplate: + $ref: '#/components/schemas/microsoft.graph.documentSetContent' + group: + type: string + description: The name of the group this content type belongs to. Helps organize related content types. + nullable: true + hidden: + type: boolean + description: Indicates whether the content type is hidden in the list's 'New' menu. + nullable: true + inheritedFrom: + $ref: '#/components/schemas/microsoft.graph.itemReference' + isBuiltIn: + type: boolean + description: Specifies if a content type is a built-in content type. + nullable: true + name: + type: string + description: The name of the content type. + nullable: true + order: + $ref: '#/components/schemas/microsoft.graph.contentTypeOrder' + parentId: + type: string + description: The unique identifier of the content type. + nullable: true + propagateChanges: + type: boolean + description: 'If true, any changes made to the content type will be pushed to inherited content types and lists that implement the content type.' + nullable: true + readOnly: + type: boolean + description: 'If true, the content type can''t be modified unless this value is first set to false.' + nullable: true + sealed: + type: boolean + description: 'If true, the content type can''t be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.' + nullable: true + base: + $ref: '#/components/schemas/microsoft.graph.contentType' + baseTypes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.contentType' + description: The collection of content types that are ancestors of this content type. + x-ms-navigationProperty: true + columnLinks: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnLink' + description: The collection of columns that are required by this content type. + x-ms-navigationProperty: true + columnPositions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + description: Column order information in a content type. + x-ms-navigationProperty: true + columns: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + description: The collection of column definitions for this contentType. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.richLongRunningOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.longRunningOperation' + - title: richLongRunningOperation + type: object + properties: + error: + $ref: '#/components/schemas/microsoft.graph.publicError' + percentageComplete: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: A value between 0 and 100 that indicates the progress of the operation. + format: int32 + nullable: true + resourceId: + type: string + description: The unique identifier for the result. + nullable: true + type: + type: string + description: The type of the operation. + nullable: true + additionalProperties: + type: object + microsoft.graph.permission: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: permission + type: object + properties: + expirationDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there is no expiration set for this permission. Optional. + format: date-time + nullable: true + grantedTo: + $ref: '#/components/schemas/microsoft.graph.identitySet' + grantedToIdentities: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.identitySet' + grantedToIdentitiesV2: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet' + description: 'For link type permissions, the details of the users to whom permission was granted. Read-only.' + grantedToV2: + $ref: '#/components/schemas/microsoft.graph.sharePointIdentitySet' + hasPassword: + type: boolean + description: Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only.. + nullable: true + inheritedFrom: + $ref: '#/components/schemas/microsoft.graph.itemReference' + invitation: + $ref: '#/components/schemas/microsoft.graph.sharingInvitation' + link: + $ref: '#/components/schemas/microsoft.graph.sharingLink' + roles: + type: array + items: + type: string + nullable: true + description: 'The type of permission, for example, read. See below for the full list of roles. Read-only.' + shareId: + type: string + description: A unique token that can be used to access this shared item via the **shares** API. Read-only. + nullable: true + additionalProperties: + type: object + microsoft.graph.termStore.store: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: store + type: object + properties: + defaultLanguageTag: + type: string + description: Default language of the term store. + languageTags: + type: array + items: + type: string + description: List of languages for the term store. + groups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.termStore.group' + description: Collection of all groups available in the term store. + x-ms-navigationProperty: true + sets: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.termStore.set' + description: Collection of all sets available in the term store. This relationship can only be used to load a specific term set. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.plannerPlan: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: plannerPlan + type: object + properties: + container: + $ref: '#/components/schemas/microsoft.graph.plannerPlanContainer' + createdBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z' + format: date-time + nullable: true + owner: + type: string + nullable: true + title: + type: string + description: Required. Title of the plan. + buckets: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.plannerBucket' + description: Read-only. Nullable. Collection of buckets in the plan. + x-ms-navigationProperty: true + details: + $ref: '#/components/schemas/microsoft.graph.plannerPlanDetails' + tasks: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.plannerTask' + description: Read-only. Nullable. Collection of tasks in the plan. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.notebook: + allOf: + - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel' + - title: notebook + type: object + properties: + isDefault: + type: boolean + description: Indicates whether this is the user's default notebook. Read-only. + nullable: true + isShared: + type: boolean + description: 'Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.' + nullable: true + links: + $ref: '#/components/schemas/microsoft.graph.notebookLinks' + sectionGroupsUrl: + type: string + description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.' + nullable: true + sectionsUrl: + type: string + description: 'The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.' + nullable: true + userRole: + $ref: '#/components/schemas/microsoft.graph.onenoteUserRole' + sectionGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.sectionGroup' + description: The section groups in the notebook. Read-only. Nullable. + x-ms-navigationProperty: true + sections: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenoteSection' + description: The sections in the notebook. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.onenoteOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.operation' + - title: onenoteOperation + type: object + properties: + error: + $ref: '#/components/schemas/microsoft.graph.onenoteOperationError' + percentComplete: + type: string + description: The operation percent complete if the operation is still in running status. + nullable: true + resourceId: + type: string + description: The resource id. + nullable: true + resourceLocation: + type: string + description: 'The resource URI for the object. For example, the resource URI for a copied page or section.' + nullable: true + additionalProperties: + type: object + microsoft.graph.onenotePage: + allOf: + - $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel' + - title: onenotePage + type: object + properties: + content: + type: string + description: The page's HTML content. + format: base64url + nullable: true + contentUrl: + type: string + description: The URL for the page's HTML content. Read-only. + nullable: true + createdByAppId: + type: string + description: The unique identifier of the application that created the page. Read-only. + nullable: true + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.' + format: date-time + nullable: true + level: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The indentation level of the page. Read-only. + format: int32 + nullable: true + links: + $ref: '#/components/schemas/microsoft.graph.pageLinks' + order: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The order of the page within its parent section. Read-only. + format: int32 + nullable: true + title: + type: string + description: The title of the page. + nullable: true + userTags: + type: array + items: + type: string + nullable: true + parentNotebook: + $ref: '#/components/schemas/microsoft.graph.notebook' + parentSection: + $ref: '#/components/schemas/microsoft.graph.onenoteSection' + additionalProperties: + type: object + microsoft.graph.onenoteResource: + allOf: + - $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel' + - title: onenoteResource + type: object + properties: + content: + type: string + description: The content stream + format: base64url + nullable: true + contentUrl: + type: string + description: The URL for downloading the content + nullable: true + additionalProperties: + type: object + microsoft.graph.sectionGroup: + allOf: + - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel' + - title: sectionGroup + type: object + properties: + sectionGroupsUrl: + type: string + description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.' + nullable: true + sectionsUrl: + type: string + description: 'The URL for the sections navigation property, which returns all the sections in the section group. Read-only.' + nullable: true + parentNotebook: + $ref: '#/components/schemas/microsoft.graph.notebook' + parentSectionGroup: + $ref: '#/components/schemas/microsoft.graph.sectionGroup' + sectionGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.sectionGroup' + description: The section groups in the section. Read-only. Nullable. + x-ms-navigationProperty: true + sections: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenoteSection' + description: The sections in the section group. Read-only. Nullable. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.onenoteSection: + allOf: + - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel' + - title: onenoteSection + type: object + properties: + isDefault: + type: boolean + description: Indicates whether this is the user's default section. Read-only. + nullable: true + links: + $ref: '#/components/schemas/microsoft.graph.sectionLinks' + pagesUrl: + type: string + description: The pages endpoint where you can get details for all the pages in the section. Read-only. + nullable: true + pages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onenotePage' + description: The collection of pages in the section. Read-only. Nullable. + x-ms-navigationProperty: true + parentNotebook: + $ref: '#/components/schemas/microsoft.graph.notebook' + parentSectionGroup: + $ref: '#/components/schemas/microsoft.graph.sectionGroup' + additionalProperties: + type: object + microsoft.graph.teamFunSettings: + title: teamFunSettings + type: object + properties: + allowCustomMemes: + type: boolean + description: 'If set to true, enables users to include custom memes.' + nullable: true + allowGiphy: + type: boolean + description: 'If set to true, enables Giphy use.' + nullable: true + allowStickersAndMemes: + type: boolean + description: 'If set to true, enables users to include stickers and memes.' + nullable: true + giphyContentRating: + $ref: '#/components/schemas/microsoft.graph.giphyRatingType' + additionalProperties: + type: object + microsoft.graph.teamGuestSettings: + title: teamGuestSettings + type: object + properties: + allowCreateUpdateChannels: + type: boolean + description: 'If set to true, guests can add and update channels.' + nullable: true + allowDeleteChannels: + type: boolean + description: 'If set to true, guests can delete channels.' + nullable: true + additionalProperties: + type: object + microsoft.graph.teamMemberSettings: + title: teamMemberSettings + type: object + properties: + allowAddRemoveApps: + type: boolean + description: 'If set to true, members can add and remove apps.' + nullable: true + allowCreatePrivateChannels: + type: boolean + description: 'If set to true, members can add and update private channels.' + nullable: true + allowCreateUpdateChannels: + type: boolean + description: 'If set to true, members can add and update channels.' + nullable: true + allowCreateUpdateRemoveConnectors: + type: boolean + description: 'If set to true, members can add, update, and remove connectors.' + nullable: true + allowCreateUpdateRemoveTabs: + type: boolean + description: 'If set to true, members can add, update, and remove tabs.' + nullable: true + allowDeleteChannels: + type: boolean + description: 'If set to true, members can delete channels.' + nullable: true + additionalProperties: + type: object + microsoft.graph.teamMessagingSettings: + title: teamMessagingSettings + type: object + properties: + allowChannelMentions: + type: boolean + description: 'If set to true, @channel mentions are allowed.' + nullable: true + allowOwnerDeleteMessages: + type: boolean + description: 'If set to true, owners can delete any message.' + nullable: true + allowTeamMentions: + type: boolean + description: 'If set to true, @team mentions are allowed.' + nullable: true + allowUserDeleteMessages: + type: boolean + description: 'If set to true, users can delete their messages.' + nullable: true + allowUserEditMessages: + type: boolean + description: 'If set to true, users can edit their messages.' + nullable: true + additionalProperties: + type: object + microsoft.graph.teamSpecialization: + title: teamSpecialization + enum: + - none + - educationStandard + - educationClass + - educationProfessionalLearningCommunity + - educationStaff + - healthcareStandard + - healthcareCareCoordination + - unknownFutureValue + type: string + microsoft.graph.teamSummary: + title: teamSummary + type: object + properties: + guestsCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + membersCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + ownersCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.teamVisibilityType: + title: teamVisibilityType + enum: + - private + - public + - hiddenMembership + - unknownFutureValue + type: string + microsoft.graph.channel: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: channel + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Read only. Timestamp at which the channel was created. + format: date-time + nullable: true + description: + type: string + description: Optional textual description for the channel. + nullable: true + displayName: + type: string + description: Channel name as it will appear to the user in Microsoft Teams. + email: + type: string + description: The email address for sending messages to the channel. Read-only. + nullable: true + isFavoriteByDefault: + type: boolean + description: 'Indicates whether the channel should automatically be marked ''favorite'' for all members of the team. Can only be set programmatically with Create team. Default: false.' + nullable: true + membershipType: + $ref: '#/components/schemas/microsoft.graph.channelMembershipType' + tenantId: + type: string + description: The ID of the Azure Active Directory tenant. + nullable: true + webUrl: + type: string + description: 'A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.' + nullable: true + filesFolder: + $ref: '#/components/schemas/microsoft.graph.driveItem' + members: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.conversationMember' + description: A collection of membership records associated with the channel. + x-ms-navigationProperty: true + messages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.chatMessage' + description: A collection of all the messages in the channel. A navigation property. Nullable. + x-ms-navigationProperty: true + sharedWithTeams: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo' + description: A collection of teams with which a channel is shared. + x-ms-navigationProperty: true + tabs: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.teamsTab' + description: A collection of all the tabs in the channel. A navigation property. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.teamsAppInstallation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: teamsAppInstallation + type: object + properties: + teamsApp: + $ref: '#/components/schemas/microsoft.graph.teamsApp' + teamsAppDefinition: + $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition' + additionalProperties: + type: object + microsoft.graph.conversationMember: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: conversationMember + type: object + properties: + displayName: + type: string + description: The display name of the user. + nullable: true + roles: + type: array + items: + type: string + nullable: true + description: 'The roles for that user. This property only contains additional qualifiers when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is a guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property.' + visibleHistoryStartDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat. + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.teamsAsyncOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: teamsAsyncOperation + type: object + properties: + attemptsCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Number of times the operation was attempted before being marked successful or failed. + format: int32 + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Time when the operation was created. + format: date-time + error: + $ref: '#/components/schemas/microsoft.graph.operationError' + lastActionDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Time when the async operation was last updated. + format: date-time + operationType: + $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType' + status: + $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus' + targetResourceId: + type: string + description: 'The ID of the object that''s created or modified as result of this async operation, typically a team.' + nullable: true + targetResourceLocation: + type: string + description: The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths. + nullable: true + additionalProperties: + type: object + microsoft.graph.teamworkTag: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: teamworkTag + type: object + properties: + description: + type: string + nullable: true + displayName: + type: string + nullable: true + memberCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + format: int32 + nullable: true + tagType: + $ref: '#/components/schemas/microsoft.graph.teamworkTagType' + teamId: + type: string + nullable: true + members: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.teamworkTagMember' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.teamsTemplate: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: teamsTemplate + type: object + additionalProperties: + type: object + microsoft.graph.schedule: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: schedule + type: object + properties: + enabled: + type: boolean + description: Indicates whether the schedule is enabled for the team. Required. + nullable: true + offerShiftRequestsEnabled: + type: boolean + description: Indicates whether offer shift requests are enabled for the schedule. + nullable: true + openShiftsEnabled: + type: boolean + description: Indicates whether open shifts are enabled for the schedule. + nullable: true + provisionStatus: + $ref: '#/components/schemas/microsoft.graph.operationStatus' + provisionStatusCode: + type: string + description: Additional information about why schedule provisioning failed. + nullable: true + readOnly: true + swapShiftsRequestsEnabled: + type: boolean + description: Indicates whether swap shifts requests are enabled for the schedule. + nullable: true + timeClockEnabled: + type: boolean + description: Indicates whether time clock is enabled for the schedule. + nullable: true + timeOffRequestsEnabled: + type: boolean + description: Indicates whether time off requests are enabled for the schedule. + nullable: true + timeZone: + type: string + description: Indicates the time zone of the schedule team using tz database format. Required. + nullable: true + workforceIntegrationIds: + type: array + items: + type: string + nullable: true + offerShiftRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.offerShiftRequest' + x-ms-navigationProperty: true + openShiftChangeRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest' + x-ms-navigationProperty: true + openShifts: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.openShift' + x-ms-navigationProperty: true + schedulingGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.schedulingGroup' + description: The logical grouping of users in the schedule (usually by role). + x-ms-navigationProperty: true + shifts: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.shift' + description: The shifts in the schedule. + x-ms-navigationProperty: true + swapShiftsChangeRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest' + x-ms-navigationProperty: true + timeOffReasons: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.timeOffReason' + description: The set of reasons for a time off in the schedule. + x-ms-navigationProperty: true + timeOffRequests: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.timeOffRequest' + x-ms-navigationProperty: true + timesOff: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.timeOff' + description: The instances of times off in the schedule. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.ODataErrors.ErrorDetails: + required: + - code + - message + type: object + properties: + code: + type: string + message: + type: string + target: + type: string + nullable: true + additionalProperties: + type: object + microsoft.graph.ODataErrors.InnerError: + type: object + additionalProperties: + type: object + description: The structure of this object is service-specific + microsoft.graph.dayOfWeek: + title: dayOfWeek + enum: + - sunday + - monday + - tuesday + - wednesday + - thursday + - friday + - saturday + type: string + microsoft.graph.weekIndex: + title: weekIndex + enum: + - first + - second + - third + - fourth + - last + type: string + microsoft.graph.recurrencePatternType: + title: recurrencePatternType + enum: + - daily + - weekly + - absoluteMonthly + - relativeMonthly + - absoluteYearly + - relativeYearly + type: string + microsoft.graph.recurrenceRangeType: + title: recurrenceRangeType + enum: + - endDate + - noEnd + - numbered + type: string + microsoft.graph.calendarRoleType: + title: calendarRoleType + enum: + - none + - freeBusyRead + - limitedRead + - read + - write + - delegateWithoutPrivateEventAccess + - delegateWithPrivateEventAccess + - custom + type: string + microsoft.graph.attendeeBase: + allOf: + - $ref: '#/components/schemas/microsoft.graph.recipient' + - title: attendeeBase + type: object + properties: + type: + $ref: '#/components/schemas/microsoft.graph.attendeeType' + additionalProperties: + type: object + microsoft.graph.timeSlot: + title: timeSlot + type: object + properties: + end: + $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone' + start: + $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone' + additionalProperties: + type: object + microsoft.graph.bodyType: + title: bodyType + enum: + - text + - html + type: string + microsoft.graph.physicalAddress: + title: physicalAddress + type: object + properties: + city: + type: string + description: The city. + nullable: true + countryOrRegion: + type: string + description: 'The country or region. It''s a free-format string value, for example, ''United States''.' + nullable: true + postalCode: + type: string + description: The postal code. + nullable: true + state: + type: string + description: The state. + nullable: true + street: + type: string + description: The street. + nullable: true + additionalProperties: + type: object + microsoft.graph.outlookGeoCoordinates: + title: outlookGeoCoordinates + type: object + properties: + accuracy: + type: number + description: 'The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.' + format: double + nullable: true + altitude: + type: number + description: The altitude of the location. + format: double + nullable: true + altitudeAccuracy: + type: number + description: The accuracy of the altitude. + format: double + nullable: true + latitude: + type: number + description: The latitude of the location. + format: double + nullable: true + longitude: + type: number + description: The longitude of the location. + format: double + nullable: true + additionalProperties: + type: object + microsoft.graph.locationType: + title: locationType + enum: + - default + - conferenceRoom + - homeAddress + - businessAddress + - geoCoordinates + - streetAddress + - hotel + - restaurant + - localBusiness + - postalAddress + type: string + microsoft.graph.locationUniqueIdType: + title: locationUniqueIdType + enum: + - unknown + - locationStore + - directory + - private + - bing + type: string + microsoft.graph.phone: + title: phone + type: object + properties: + language: + type: string + nullable: true + number: + type: string + description: The phone number. + nullable: true + region: + type: string + nullable: true + type: + $ref: '#/components/schemas/microsoft.graph.phoneType' + additionalProperties: + type: object + microsoft.graph.responseType: + title: responseType + enum: + - none + - organizer + - tentativelyAccepted + - accepted + - declined + - notResponded + type: string + microsoft.graph.itemReference: + title: itemReference + type: object + properties: + driveId: + type: string + description: Unique identifier of the drive instance that contains the item. Read-only. + nullable: true + driveType: + type: string + description: 'Identifies the type of drive. See [drive][] resource for values.' + nullable: true + id: + type: string + description: Unique identifier of the item in the drive. 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. The value is the same as the id property of that [site][] resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.' + nullable: true + additionalProperties: + type: object + microsoft.graph.user: + allOf: + - $ref: '#/components/schemas/microsoft.graph.directoryObject' + - title: user + type: object + properties: + accountEnabled: + type: boolean + description: 'true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on $select. Supports $filter (eq, ne, not, and in).' + nullable: true + ageGroup: + type: string + description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).' + nullable: true + assignedLicenses: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.assignedLicense' + description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, and counting empty collections).' + assignedPlans: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.assignedPlan' + description: The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and not). + authorizationInfo: + $ref: '#/components/schemas/microsoft.graph.authorizationInfo' + businessPhones: + type: array + items: + type: string + description: 'The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith).' + city: + type: string + description: 'The city in which the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + companyName: + type: string + description: 'The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + consentProvidedForMinor: + type: string + description: 'Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in).' + nullable: true + country: + type: string + description: 'The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).' + format: date-time + nullable: true + creationType: + type: string + description: 'Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, not, in).' + nullable: true + department: + type: string + description: 'The name for the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).' + nullable: true + displayName: + type: string + description: 'The name displayed in the address book for the user. This is usually the combination of the user''s first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.' + nullable: true + employeeHireDate: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The date and time when the user was hired or will start work in case of a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).' + format: date-time + nullable: true + employeeId: + type: string + description: 'The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).' + nullable: true + employeeOrgData: + $ref: '#/components/schemas/microsoft.graph.employeeOrgData' + employeeType: + type: string + description: 'Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).' + nullable: true + externalUserState: + type: string + description: 'For an external user invited to the tenant using the invitation API, this property represents the invited user''s invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in).' + nullable: true + externalUserStateChangeDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in).' + format: date-time + nullable: true + faxNumber: + type: string + description: 'The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).' + nullable: true + givenName: + type: string + description: 'The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).' + nullable: true + identities: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.objectIdentity' + description: 'Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.' + imAddresses: + type: array + items: + type: string + nullable: true + description: 'The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).' + isResourceAccount: + type: boolean + description: Do not use – reserved for future use. + nullable: true + jobTitle: + type: string + description: 'The user''s job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).' + nullable: true + lastPasswordChangeDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.' + format: date-time + nullable: true + legalAgeGroupClassification: + type: string + description: 'Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information. Returned only on $select.' + nullable: true + licenseAssignmentStates: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.licenseAssignmentState' + description: State of license assignments for this user. Read-only. Returned only on $select. + mail: + type: string + description: 'The SMTP address for the user, for example, jeff@contoso.onmicrosoft.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. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).' + nullable: true + mailNickname: + type: string + description: 'The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + mobilePhone: + type: string + description: 'The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + officeLocation: + type: string + description: 'The office location in the user''s place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + onPremisesDistinguishedName: + type: string + description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. + nullable: true + onPremisesDomainName: + type: string + description: 'Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select.' + nullable: true + onPremisesExtensionAttributes: + $ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes' + onPremisesImmutableId: + type: string + description: 'This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user''s userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..' + nullable: true + onPremisesLastSyncDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).' + format: date-time + nullable: true + onPremisesProvisioningErrors: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onPremisesProvisioningError' + description: 'Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le).' + onPremisesSamAccountName: + type: string + description: 'Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).' + nullable: true + onPremisesSecurityIdentifier: + type: string + description: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq including on null values). + nullable: true + onPremisesSyncEnabled: + type: boolean + description: 'true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn''t being synced and can be managed in Azure Active Directory (Azure AD). Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).' + nullable: true + onPremisesUserPrincipalName: + type: string + description: 'Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).' + nullable: true + otherMails: + type: array + items: + type: string + description: 'A list of additional email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, and counting empty collections).' + passwordPolicies: + type: string + description: 'Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).' + nullable: true + passwordProfile: + $ref: '#/components/schemas/microsoft.graph.passwordProfile' + postalCode: + type: string + description: 'The postal code for the user''s postal address. The postal code is specific to the user''s country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + preferredDataLocation: + type: string + description: 'The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.' + nullable: true + preferredLanguage: + type: string + description: 'The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)' + nullable: true + provisionedPlans: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.provisionedPlan' + description: 'The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le).' + proxyAddresses: + type: array + items: + type: string + description: 'For example: [''SMTP: 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. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, and counting empty collections).' + securityIdentifier: + type: string + description: 'Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).' + nullable: true + showInAddressList: + type: boolean + description: Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue. + nullable: true + signInSessionsValidFromDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select.' + format: date-time + nullable: true + state: + type: string + description: 'The state or province in the user''s address. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + streetAddress: + type: string + description: 'The street address of the user''s place of business. Maximum length is 1024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + surname: + type: string + description: 'The user''s surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + usageLocation: + type: string + description: 'A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).' + nullable: true + userPrincipalName: + type: string + description: 'The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user''s email name. The general format is alias@domain, where domain must be present in the tenant''s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, '' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.' + nullable: true + userType: + type: string + description: 'A string value that can be used to classify user types in your directory, such as Member and Guest. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for member and guest users, see What are the default user permissions in Azure Active Directory?' + nullable: true + mailboxSettings: + $ref: '#/components/schemas/microsoft.graph.mailboxSettings' + deviceEnrollmentLimit: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000. + format: int32 + aboutMe: + type: string + description: A freeform text entry field for the user to describe themselves. Returned only on $select. + nullable: true + birthday: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select.' + format: date-time + hireDate: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.' + format: date-time + interests: + type: array + items: + type: string + nullable: true + description: A list for the user to describe their interests. Returned only on $select. + mySite: + type: string + description: The URL for the user's personal site. Returned only on $select. + nullable: true + pastProjects: + type: array + items: + type: string + nullable: true + description: A list for the user to enumerate their past projects. Returned only on $select. + preferredName: + type: string + description: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select. + nullable: true + responsibilities: + type: array + items: + type: string + nullable: true + description: A list for the user to enumerate their responsibilities. Returned only on $select. + schools: + type: array + items: + type: string + nullable: true + description: A list for the user to enumerate the schools they have attended. Returned only on $select. + skills: + type: array + items: + type: string + nullable: true + description: A list for the user to enumerate their skills. Returned only on $select. + appRoleAssignments: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.appRoleAssignment' + description: Represents the app roles a user has been granted for an application. Supports $expand. + x-ms-navigationProperty: true + createdObjects: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: Directory objects that were created by the user. Read-only. Nullable. + x-ms-navigationProperty: true + directReports: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + licenseDetails: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.licenseDetails' + description: A collection of this user's license details. Read-only. + x-ms-navigationProperty: true + manager: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + memberOf: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + oauth2PermissionGrants: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant' + x-ms-navigationProperty: true + ownedDevices: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: Devices that are owned by the user. Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + ownedObjects: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: Directory objects that are owned by the user. Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + registeredDevices: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: Devices that are registered for the user. Read-only. Nullable. Supports $expand. + x-ms-navigationProperty: true + scopedRoleMemberOf: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership' + x-ms-navigationProperty: true + transitiveMemberOf: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.directoryObject' + description: 'The groups, including nested groups, and directory roles that a user is a member of. Nullable.' + x-ms-navigationProperty: true + calendar: + $ref: '#/components/schemas/microsoft.graph.calendar' + calendarGroups: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.calendarGroup' + description: The user's calendar groups. Read-only. Nullable. + x-ms-navigationProperty: true + calendars: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.calendar' + description: The user's calendars. Read-only. Nullable. + x-ms-navigationProperty: true + calendarView: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: The calendar view for the calendar. Read-only. Nullable. + x-ms-navigationProperty: true + contactFolders: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.contactFolder' + description: The user's contacts folders. Read-only. Nullable. + x-ms-navigationProperty: true + contacts: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.contact' + description: The user's contacts. Read-only. Nullable. + x-ms-navigationProperty: true + events: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.event' + description: The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable. + x-ms-navigationProperty: true + inferenceClassification: + $ref: '#/components/schemas/microsoft.graph.inferenceClassification' + mailFolders: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.mailFolder' + description: The user's mail folders. Read-only. Nullable. + x-ms-navigationProperty: true + messages: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.message' + description: The messages in a mailbox or folder. Read-only. Nullable. + x-ms-navigationProperty: true + outlook: + $ref: '#/components/schemas/microsoft.graph.outlookUser' + people: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.person' + description: People that are relevant to the user. Read-only. Nullable. + x-ms-navigationProperty: true + drive: + $ref: '#/components/schemas/microsoft.graph.drive' + drives: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.drive' + description: A collection of drives available for this user. Read-only. + x-ms-navigationProperty: true + followedSites: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.site' + x-ms-navigationProperty: true + extensions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.extension' + description: The collection of open extensions defined for the user. Read-only. Supports $expand. Nullable. + x-ms-navigationProperty: true + agreementAcceptances: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.agreementAcceptance' + description: The user's terms of use acceptance statuses. Read-only. Nullable. + x-ms-navigationProperty: true + managedDevices: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.managedDevice' + description: The managed devices associated with the user. + x-ms-navigationProperty: true + managedAppRegistrations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.managedAppRegistration' + description: Zero or more managed app registrations that belong to the user. + x-ms-navigationProperty: true + deviceManagementTroubleshootingEvents: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent' + description: The list of troubleshooting events for this user. + x-ms-navigationProperty: true + planner: + $ref: '#/components/schemas/microsoft.graph.plannerUser' + insights: + $ref: '#/components/schemas/microsoft.graph.officeGraphInsights' + settings: + $ref: '#/components/schemas/microsoft.graph.userSettings' + onenote: + $ref: '#/components/schemas/microsoft.graph.onenote' + photo: + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + photos: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.profilePhoto' + x-ms-navigationProperty: true + activities: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.userActivity' + description: The user's activities across devices. Read-only. Nullable. + x-ms-navigationProperty: true + onlineMeetings: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.onlineMeeting' + x-ms-navigationProperty: true + presence: + $ref: '#/components/schemas/microsoft.graph.presence' + authentication: + $ref: '#/components/schemas/microsoft.graph.authentication' + chats: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.chat' + x-ms-navigationProperty: true + joinedTeams: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.team' + x-ms-navigationProperty: true + teamwork: + $ref: '#/components/schemas/microsoft.graph.userTeamwork' + todo: + $ref: '#/components/schemas/microsoft.graph.todo' + additionalProperties: + type: object + microsoft.graph.storagePlanInformation: + title: storagePlanInformation + type: object + properties: + upgradeAvailable: + type: boolean + description: Indicates whether there are higher storage quota plans available. Read-only. + nullable: true + additionalProperties: + type: object + microsoft.graph.audio: + title: audio + type: object + properties: + album: + type: string + description: The title of the album for this audio file. + nullable: true + albumArtist: + type: string + description: The artist named on the album for the audio file. + nullable: true + artist: + type: string + description: The performing artist for the audio file. + nullable: true + bitrate: + type: integer + description: Bitrate expressed in kbps. + format: int64 + nullable: true + composers: + type: string + description: The name of the composer of the audio file. + nullable: true + copyright: + type: string + description: Copyright information for the audio file. + nullable: true + disc: + maximum: 32767 + minimum: -32768 + type: integer + description: The number of the disc this audio file came from. + format: int16 + nullable: true + discCount: + maximum: 32767 + minimum: -32768 + type: integer + description: The total number of discs in this album. + format: int16 + nullable: true + duration: + type: integer + description: 'Duration of the audio file, expressed in milliseconds' + format: int64 + nullable: true + genre: + type: string + description: The genre of this audio file. + nullable: true + hasDrm: + type: boolean + description: Indicates if the file is protected with digital rights management. + nullable: true + isVariableBitrate: + type: boolean + description: Indicates if the file is encoded with a variable bitrate. + nullable: true + title: + type: string + description: The title of the audio file. + nullable: true + track: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The number of the track on the original disc for this audio file. + format: int32 + nullable: true + trackCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The total number of tracks on the original disc for this audio file. + format: int32 + nullable: true + year: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The year the audio file was recorded. + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.bundle: + title: bundle + type: object + properties: + album: + $ref: '#/components/schemas/microsoft.graph.album' + childCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Number of children contained immediately within this container. + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.deleted: + title: deleted + type: object + properties: + state: + type: string + description: Represents the state of the deleted item. + nullable: true + additionalProperties: + type: object + microsoft.graph.file: + title: file + type: object + properties: + hashes: + $ref: '#/components/schemas/microsoft.graph.hashes' + mimeType: + type: string + description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only. + nullable: true + processingMetadata: + type: boolean + nullable: true + additionalProperties: + type: object + microsoft.graph.fileSystemInfo: + title: fileSystemInfo + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The UTC date and time the file was created on a client. + format: date-time + nullable: true + lastAccessedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The UTC date and time the file was last accessed. Available for the recent file list only. + format: date-time + nullable: true + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The UTC date and time the file was last modified on a client. + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.folder: + title: folder + type: object + properties: + childCount: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Number of children contained immediately within this container. + format: int32 + nullable: true + view: + $ref: '#/components/schemas/microsoft.graph.folderView' + additionalProperties: + type: object + microsoft.graph.image: + title: image + type: object + properties: + height: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Optional. Height of the image, in pixels. Read-only.' + format: int32 + nullable: true + width: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Optional. Width of the image, in pixels. Read-only.' + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.geoCoordinates: + title: geoCoordinates + type: object + properties: + altitude: + type: number + description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.' + format: double + nullable: true + latitude: + type: number + description: 'Optional. The latitude, in decimal, for the item. Read-only.' + format: double + nullable: true + longitude: + type: number + description: 'Optional. The longitude, in decimal, for the item. Read-only.' + format: double + nullable: true + additionalProperties: + type: object + microsoft.graph.malware: + title: malware + type: object + properties: + description: + type: string + description: Contains the virus details for the malware facet. + nullable: true + additionalProperties: + type: object + microsoft.graph.package: + title: package + type: object + properties: + type: + type: string + description: 'A string indicating the type of package. While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.' + nullable: true + additionalProperties: + type: object + microsoft.graph.pendingOperations: + title: pendingOperations + type: object + properties: + pendingContentUpdate: + $ref: '#/components/schemas/microsoft.graph.pendingContentUpdate' + additionalProperties: + type: object + microsoft.graph.photo: + title: photo + type: object + properties: + cameraMake: + type: string + description: Camera manufacturer. Read-only. + nullable: true + cameraModel: + type: string + description: Camera model. Read-only. + nullable: true + exposureDenominator: + type: number + description: The denominator for the exposure time fraction from the camera. Read-only. + format: double + nullable: true + exposureNumerator: + type: number + description: The numerator for the exposure time fraction from the camera. Read-only. + format: double + nullable: true + fNumber: + type: number + description: The F-stop value from the camera. Read-only. + format: double + nullable: true + focalLength: + type: number + description: The focal length from the camera. Read-only. + format: double + nullable: true + iso: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The ISO value from the camera. Read-only. + format: int32 + nullable: true + orientation: + maximum: 32767 + minimum: -32768 + type: integer + description: The orientation value from the camera. Writable on OneDrive Personal. + format: int16 + nullable: true + takenDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Represents the date and time the photo was taken. Read-only. + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.publicationFacet: + title: publicationFacet + type: object + properties: + level: + type: string + description: The state of publication for this document. Either published or checkout. Read-only. + nullable: true + versionId: + type: string + description: The unique identifier for the version that is visible to the current caller. Read-only. + nullable: true + additionalProperties: + type: object + microsoft.graph.remoteItem: + title: remoteItem + type: object + properties: + createdBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Date and time of item creation. Read-only. + format: date-time + nullable: true + file: + $ref: '#/components/schemas/microsoft.graph.file' + fileSystemInfo: + $ref: '#/components/schemas/microsoft.graph.fileSystemInfo' + folder: + $ref: '#/components/schemas/microsoft.graph.folder' + id: + type: string + description: Unique identifier for the remote item in its drive. Read-only. + nullable: true + image: + $ref: '#/components/schemas/microsoft.graph.image' + lastModifiedBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + lastModifiedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: Date and time the item was last modified. Read-only. + format: date-time + nullable: true + name: + type: string + description: Optional. Filename of the remote item. Read-only. + nullable: true + package: + $ref: '#/components/schemas/microsoft.graph.package' + parentReference: + $ref: '#/components/schemas/microsoft.graph.itemReference' + shared: + $ref: '#/components/schemas/microsoft.graph.shared' + sharepointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + size: + type: integer + description: Size of the remote item. Read-only. + format: int64 + nullable: true + specialFolder: + $ref: '#/components/schemas/microsoft.graph.specialFolder' + video: + $ref: '#/components/schemas/microsoft.graph.video' + webDavUrl: + type: string + description: DAV compatible URL for the item. + nullable: true + webUrl: + type: string + description: URL that displays the resource in the browser. Read-only. + nullable: true + additionalProperties: + type: object + microsoft.graph.searchResult: + title: searchResult + type: object + properties: + onClickTelemetryUrl: + type: string + description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results. + nullable: true + additionalProperties: + type: object + microsoft.graph.shared: + title: shared + type: object + properties: + owner: + $ref: '#/components/schemas/microsoft.graph.identitySet' + scope: + type: string + description: 'Indicates the scope of how the item is shared: anonymous, organization, or users. Read-only.' + nullable: true + sharedBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + sharedDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The UTC date and time when the item was shared. Read-only. + format: date-time + nullable: true + additionalProperties: + type: object + microsoft.graph.specialFolder: + title: specialFolder + type: object + properties: + name: + type: string + description: The unique identifier for this item in the /drive/special collection + nullable: true + additionalProperties: + type: object + microsoft.graph.video: + title: video + type: object + properties: + audioBitsPerSample: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Number of audio bits per sample. + format: int32 + nullable: true + audioChannels: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Number of audio channels. + format: int32 + nullable: true + audioFormat: + type: string + description: 'Name of the audio format (AAC, MP3, etc.).' + nullable: true + audioSamplesPerSecond: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Number of audio samples per second. + format: int32 + nullable: true + bitrate: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Bit rate of the video in bits per second. + format: int32 + nullable: true + duration: + type: integer + description: Duration of the file in milliseconds. + format: int64 + nullable: true + fourCC: + type: string + description: '''Four character code'' name of the video format.' + nullable: true + frameRate: + type: number + description: Frame rate of the video. + format: double + nullable: true + height: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Height of the video, in pixels.' + format: int32 + nullable: true + width: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: 'Width of the video, in pixels.' + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.workbook: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: workbook + type: object + properties: + application: + $ref: '#/components/schemas/microsoft.graph.workbookApplication' + comments: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.workbookComment' + x-ms-navigationProperty: true + functions: + $ref: '#/components/schemas/microsoft.graph.workbookFunctions' + names: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.workbookNamedItem' + description: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only. + x-ms-navigationProperty: true + operations: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.workbookOperation' + description: 'The status of workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the Location header is returned in the response. Read-only.' + x-ms-navigationProperty: true + tables: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.workbookTable' + description: Represents a collection of tables associated with the workbook. Read-only. + x-ms-navigationProperty: true + worksheets: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.workbookWorksheet' + description: Represents a collection of worksheets associated with the workbook. Read-only. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.listItem: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItem' + - title: listItem + type: object + properties: + contentType: + $ref: '#/components/schemas/microsoft.graph.contentTypeInfo' + sharepointIds: + $ref: '#/components/schemas/microsoft.graph.sharepointIds' + analytics: + $ref: '#/components/schemas/microsoft.graph.itemAnalytics' + documentSetVersions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.documentSetVersion' + description: Version information for a document set version created by a user. + x-ms-navigationProperty: true + driveItem: + $ref: '#/components/schemas/microsoft.graph.driveItem' + fields: + $ref: '#/components/schemas/microsoft.graph.fieldValueSet' + versions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.listItemVersion' + description: The list of previous versions of the list item. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.subscription: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: subscription + type: object + properties: + applicationId: + type: string + description: Optional. Identifier of the application used to create the subscription. Read-only. + nullable: true + changeType: + type: string + description: 'Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType.' + clientState: + type: string + description: Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification. + nullable: true + creatorId: + type: string + description: 'Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the id of the service principal corresponding to the app. Read-only.' + nullable: true + encryptionCertificate: + type: string + description: Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true. + nullable: true + encryptionCertificateId: + type: string + description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. + nullable: true + expirationDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: 'Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see the table below.' + format: date-time + includeResourceData: + type: boolean + description: 'Optional. When set to true, change notifications include resource data (such as content of a chat message).' + nullable: true + latestSupportedTlsVersion: + type: string + description: 'Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.' + nullable: true + lifecycleNotificationUrl: + type: string + description: 'Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications. This URL must make use of the HTTPS protocol.' + nullable: true + notificationQueryOptions: + type: string + description: 'Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.' + nullable: true + notificationUrl: + type: string + description: Required. The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol. + notificationUrlAppId: + type: string + description: Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received. + nullable: true + resource: + type: string + description: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource. + additionalProperties: + type: object + microsoft.graph.thumbnailSet: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: thumbnailSet + type: object + properties: + large: + $ref: '#/components/schemas/microsoft.graph.thumbnail' + medium: + $ref: '#/components/schemas/microsoft.graph.thumbnail' + small: + $ref: '#/components/schemas/microsoft.graph.thumbnail' + source: + $ref: '#/components/schemas/microsoft.graph.thumbnail' + additionalProperties: + type: object + microsoft.graph.driveItemVersion: + allOf: + - $ref: '#/components/schemas/microsoft.graph.baseItemVersion' + - title: driveItemVersion + type: object + properties: + content: + type: string + description: The content stream for this version of the item. + format: base64url + nullable: true + size: + type: integer + description: Indicates the size of the content stream for this version of the item. + format: int64 + nullable: true + additionalProperties: + type: object + microsoft.graph.listInfo: + title: listInfo + type: object + properties: + contentTypesEnabled: + type: boolean + description: 'If true, indicates that content types are enabled for this list.' + nullable: true + hidden: + type: boolean + description: 'If true, indicates that the list is not normally visible in the SharePoint user experience.' + nullable: true + template: + type: string + description: 'An enumerated value that represents the base list template used in creating the list. Possible values include documentLibrary, genericList, task, survey, announcements, contacts, and more.' + nullable: true + additionalProperties: + type: object + microsoft.graph.publicErrorDetail: + title: publicErrorDetail + type: object + properties: + code: + type: string + description: The error code. + nullable: true + message: + type: string + description: The error message. + nullable: true + target: + type: string + description: The target of the error. + nullable: true + additionalProperties: + type: object + microsoft.graph.publicInnerError: + title: publicInnerError + type: object + properties: + code: + type: string + description: The error code. + nullable: true + details: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.publicErrorDetail' + description: A collection of error details. + message: + type: string + description: The error message. + nullable: true + target: + type: string + description: The target of the error. + nullable: true + additionalProperties: + type: object + microsoft.graph.itemActivityStat: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: itemActivityStat + type: object + properties: + access: + $ref: '#/components/schemas/microsoft.graph.itemActionStat' + create: + $ref: '#/components/schemas/microsoft.graph.itemActionStat' + delete: + $ref: '#/components/schemas/microsoft.graph.itemActionStat' + edit: + $ref: '#/components/schemas/microsoft.graph.itemActionStat' + endDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: When the interval ends. Read-only. + format: date-time + nullable: true + incompleteData: + $ref: '#/components/schemas/microsoft.graph.incompleteData' + isTrending: + type: boolean + description: Indicates whether the item is 'trending.' Read-only. + nullable: true + move: + $ref: '#/components/schemas/microsoft.graph.itemActionStat' + startDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: When the interval starts. Read-only. + format: date-time + nullable: true + activities: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.itemActivity' + description: Exposes the itemActivities represented in this itemActivityStat resource. + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.booleanColumn: + title: booleanColumn + type: object + additionalProperties: + type: object + microsoft.graph.calculatedColumn: + title: calculatedColumn + type: object + properties: + format: + type: string + description: 'For dateTime output types, the format of the value. Must be one of dateOnly or dateTime.' + nullable: true + formula: + type: string + description: The formula used to compute the value for this column. + nullable: true + outputType: + type: string + description: 'The output type used to format values in this column. Must be one of boolean, currency, dateTime, number, or text.' + nullable: true + additionalProperties: + type: object + microsoft.graph.choiceColumn: + title: choiceColumn + type: object + properties: + allowTextEntry: + type: boolean + description: 'If true, allows custom values that aren''t in the configured choices.' + nullable: true + choices: + type: array + items: + type: string + nullable: true + description: The list of values available for this column. + displayAs: + type: string + description: 'How the choices are to be presented in the UX. Must be one of checkBoxes, dropDownMenu, or radioButtons' + nullable: true + additionalProperties: + type: object + microsoft.graph.contentApprovalStatusColumn: + title: contentApprovalStatusColumn + type: object + additionalProperties: + type: object + microsoft.graph.currencyColumn: + title: currencyColumn + type: object + properties: + locale: + type: string + description: Specifies the locale from which to infer the currency symbol. + nullable: true + additionalProperties: + type: object + microsoft.graph.dateTimeColumn: + title: dateTimeColumn + type: object + properties: + displayAs: + type: string + description: 'How the value should be presented in the UX. Must be one of default, friendly, or standard. See below for more details. If unspecified, treated as default.' + nullable: true + format: + type: string + description: Indicates whether the value should be presented as a date only or a date and time. Must be one of dateOnly or dateTime + nullable: true + additionalProperties: + type: object + microsoft.graph.defaultColumnValue: + title: defaultColumnValue + type: object + properties: + formula: + type: string + description: The formula used to compute the default value for this column. + nullable: true + value: + type: string + description: The direct value to use as the default value for this column. + nullable: true + additionalProperties: + type: object + microsoft.graph.geolocationColumn: + title: geolocationColumn + type: object + additionalProperties: + type: object + microsoft.graph.hyperlinkOrPictureColumn: + title: hyperlinkOrPictureColumn + type: object + properties: + isPicture: + type: boolean + description: Specifies whether the display format used for URL columns is an image or a hyperlink. + nullable: true + additionalProperties: + type: object + microsoft.graph.lookupColumn: + title: lookupColumn + type: object + properties: + allowMultipleValues: + type: boolean + description: Indicates whether multiple values can be selected from the source. + nullable: true + allowUnlimitedLength: + type: boolean + description: Indicates whether values in the column should be able to exceed the standard limit of 255 characters. + nullable: true + columnName: + type: string + description: The name of the lookup source column. + nullable: true + listId: + type: string + description: The unique identifier of the lookup source list. + nullable: true + primaryLookupColumnId: + type: string + description: 'If specified, this column is a secondary lookup, pulling an additional field from the list item looked up by the primary lookup. Use the list item looked up by the primary as the source for the column named here.' + nullable: true + additionalProperties: + type: object + microsoft.graph.numberColumn: + title: numberColumn + type: object + properties: + decimalPlaces: + type: string + description: How many decimal places to display. See below for information about the possible values. + nullable: true + displayAs: + type: string + description: 'How the value should be presented in the UX. Must be one of number or percentage. If unspecified, treated as number.' + nullable: true + maximum: + type: number + description: The maximum permitted value. + format: double + nullable: true + minimum: + type: number + description: The minimum permitted value. + format: double + nullable: true + additionalProperties: + type: object + microsoft.graph.personOrGroupColumn: + title: personOrGroupColumn + type: object + properties: + allowMultipleSelection: + type: boolean + description: Indicates whether multiple values can be selected from the source. + nullable: true + chooseFromType: + type: string + description: 'Whether to allow selection of people only, or people and groups. Must be one of peopleAndGroups or peopleOnly.' + nullable: true + displayAs: + type: string + description: How to display the information about the person or group chosen. See below. + nullable: true + additionalProperties: + type: object + microsoft.graph.contentTypeInfo: + title: contentTypeInfo + type: object + properties: + id: + type: string + description: The id of the content type. + nullable: true + name: + type: string + description: The name of the content type. + nullable: true + additionalProperties: + type: object + microsoft.graph.termColumn: + title: termColumn + type: object + properties: + allowMultipleValues: + type: boolean + description: Specifies whether the column will allow more than one value. + nullable: true + showFullyQualifiedName: + type: boolean + description: Specifies whether to display the entire term path or only the term label. + nullable: true + parentTerm: + $ref: '#/components/schemas/microsoft.graph.termStore.term' + termSet: + $ref: '#/components/schemas/microsoft.graph.termStore.set' + additionalProperties: + type: object + microsoft.graph.textColumn: + title: textColumn + type: object + properties: + allowMultipleLines: + type: boolean + description: Whether to allow multiple lines of text. + nullable: true + appendChangesToExistingText: + type: boolean + description: 'Whether updates to this column should replace existing text, or append to it.' + nullable: true + linesForEditing: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The size of the text box. + format: int32 + nullable: true + maxLength: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: The maximum number of characters for the value. + format: int32 + nullable: true + textType: + type: string + description: The type of text being stored. Must be one of plain or richText + nullable: true + additionalProperties: + type: object + microsoft.graph.thumbnailColumn: + title: thumbnailColumn + type: object + additionalProperties: + type: object + microsoft.graph.columnTypes: + title: columnTypes + enum: + - note + - text + - choice + - multichoice + - number + - currency + - dateTime + - lookup + - boolean + - user + - url + - calculated + - location + - geolocation + - term + - multiterm + - thumbnail + - approvalStatus + - unknownFutureValue + type: string + microsoft.graph.columnValidation: + title: columnValidation + type: object + properties: + defaultLanguage: + type: string + description: Default BCP 47 language tag for the description. + nullable: true + descriptions: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.displayNameLocalization' + description: Localized messages that explain what is needed for this column's value to be considered valid. User will be prompted with this message if validation fails. + formula: + type: string + description: 'The formula to validate column value. For examples, see Examples of common formulas in lists.' + nullable: true + additionalProperties: + type: object + microsoft.graph.documentSet: + title: documentSet + type: object + properties: + allowedContentTypes: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.contentTypeInfo' + description: Content types allowed in document set. + defaultContents: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.documentSetContent' + description: Default contents of document set. + propagateWelcomePageChanges: + type: boolean + description: Specifies whether to push welcome page changes to inherited content types. + nullable: true + shouldPrefixNameToFile: + type: boolean + description: Indicates whether to add the name of the document set to each file name. + nullable: true + welcomePageUrl: + type: string + description: Welcome page absolute URL. + nullable: true + sharedColumns: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + x-ms-navigationProperty: true + welcomePageColumns: + type: array + items: + $ref: '#/components/schemas/microsoft.graph.columnDefinition' + x-ms-navigationProperty: true + additionalProperties: + type: object + microsoft.graph.documentSetContent: + title: documentSetContent + type: object + properties: + contentType: + $ref: '#/components/schemas/microsoft.graph.contentTypeInfo' + fileName: + type: string + description: Name of the file in resource folder that should be added as a default content or a template in the document set. + nullable: true + folderName: + type: string + description: Folder name in which the file will be placed when a new document set is created in the library. + nullable: true + additionalProperties: + type: object + microsoft.graph.contentTypeOrder: + title: contentTypeOrder + type: object + properties: + default: + type: boolean + description: Whether this is the default Content Type + nullable: true + position: + maximum: 2147483647 + minimum: -2147483648 + type: integer + description: Specifies the position in which the Content Type appears in the selection UI. + format: int32 + nullable: true + additionalProperties: + type: object + microsoft.graph.columnLink: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: columnLink + type: object + properties: + name: + type: string + description: The name of the column in this content type. + nullable: true + additionalProperties: + type: object + microsoft.graph.longRunningOperation: + allOf: + - $ref: '#/components/schemas/microsoft.graph.entity' + - title: longRunningOperation + type: object + properties: + createdDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The start time of the operation. + format: date-time + nullable: true + lastActionDateTime: + pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' + type: string + description: The time of the last action in the operation. + format: date-time + nullable: true + resourceLocation: + type: string + description: URI of the resource that the operation is performed on. + nullable: true + status: + $ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus' + statusDetail: + type: string + description: Details about the status of the operation. + nullable: true + additionalProperties: + type: object + microsoft.graph.sharePointIdentitySet: + allOf: + - $ref: '#/components/schemas/microsoft.graph.identitySet' + - title: sharePointIdentitySet + type: object + properties: + group: + $ref: '#/components/schemas/microsoft.graph.identity' + siteGroup: + $ref: '#/components/schemas/microsoft.graph.sharePointIdentity' + siteUser: + $ref: '#/components/schemas/microsoft.graph.sharePointIdentity' + additionalProperties: + type: object + microsoft.graph.sharingInvitation: + title: sharingInvitation + type: object + properties: + email: + type: string + description: The email address provided for the recipient of the sharing invitation. Read-only. + nullable: true + invitedBy: + $ref: '#/components/schemas/microsoft.graph.identitySet' + redeemedBy: + type: string + nullable: true + signInRequired: + type: boolean + description: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only. + nullable: true + additionalProperties: + type: object + microsoft.graph.sharingLink: + title: sharingLink + type: object + properties: + application: + $ref: '#/components/schemas/microsoft.graph.identity' + preventsDownload: + type: boolean + description: 'If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.' + nullable: true + scope: + type: string + description: 'The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.' + nullable: true + type: + type: string + description: The type of the link created. + nullable: true + webHtml: + type: string + description: 'For embed links, this property contains the HTML code for an