openapi: 3.1.0 info: title: Microsoft Graph Privacy description: Needs a description. paths: /privacy: description: Provides operations to manage the privacy singleton. get: tags: - Privacy.privacy summary: Microsoft Graph Get privacy operationId: privacy.privacy.GetPrivacy parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.privacy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Privacy.privacy summary: Microsoft Graph Update privacy operationId: privacy.privacy.UpdatePrivacy requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.privacy' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.privacy' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /privacy/subjectRightsRequests: description: >- Provides operations to manage the subjectRightsRequests property of the microsoft.graph.privacy entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph List subjectRightsRequests description: Get a list of subjectRightsRequest objects and their properties. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-list?view=graph-rest-1.0 operationId: privacy.ListSubjectRightsRequests 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: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.subjectRightsRequestCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Create subjectRightsRequest description: Create a new subjectRightsRequest object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-post?view=graph-rest-1.0 operationId: privacy.CreateSubjectRightsRequests requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation /privacy/subjectRightsRequests/{subjectRightsRequest-id}: description: >- Provides operations to manage the subjectRightsRequests property of the microsoft.graph.privacy entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get subjectRightsRequest description: Read the properties and relationships of a subjectRightsRequest object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-get?view=graph-rest-1.0 operationId: privacy.GetSubjectRightsRequests parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation patch: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Update subjectRightsRequest description: Update the properties of a subjectRightsRequest object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-update?view=graph-rest-1.0 operationId: privacy.UpdateSubjectRightsRequests requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation delete: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Delete navigation property subjectRightsRequests for privacy operationId: privacy.DeleteSubjectRightsRequests parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers: description: >- Provides operations to manage the approvers property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get approvers from privacy description: >- Collection of users who can approve the request. Currently only supported for requests of type delete. operationId: privacy.subjectRightsRequests.ListApprovers 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: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/microsoft.graph.userCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id}: description: >- Provides operations to manage the approvers property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get approvers from privacy description: >- Collection of users who can approve the request. Currently only supported for requests of type delete. operationId: privacy.subjectRightsRequests.GetApprovers parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.user' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user x-ms-docs-grouped-path: - >- /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers(userPrincipalName='{userPrincipalName}') /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id}/mailboxSettings: get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get mailboxSettings property value description: >- Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select. operationId: privacy.subjectRightsRequests.approvers.GetMailboxSettings parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Entity result. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.mailboxSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. patch: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Update property mailboxSettings value. operationId: privacy.subjectRightsRequests.approvers.UpdateMailboxSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.mailboxSettings' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.mailboxSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id}/serviceProvisioningErrors: get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get serviceProvisioningErrors property value description: >- Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance). operationId: privacy.subjectRightsRequests.approvers.ListServiceProvisioningErrors 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: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id}/serviceProvisioningErrors/$count: description: Provides operations to count the resources in the collection. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get the number of the resource operationId: >- privacy.subjectRightsRequests.approvers.ServiceProvisioningErrors.GetCount-6b48 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers(userPrincipalName='{userPrincipalName}'): description: >- Provides operations to manage the approvers property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get approvers from privacy description: >- Collection of users who can approve the request. Currently only supported for requests of type delete. operationId: privacy.subjectRightsRequests.approvers.GetByUserPrincipalName parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.user' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: userPrincipalName in: path description: Alternate key of user required: true schema: type: string nullable: true x-ms-docs-grouped-path: - >- /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/{user-id} /privacy/subjectRightsRequests/{subjectRightsRequest-id}/approvers/$count: description: Provides operations to count the resources in the collection. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get the number of the resource operationId: privacy.subjectRightsRequests.approvers.GetCount-f1ed parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators: description: >- Provides operations to manage the collaborators property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get collaborators from privacy description: Collection of users who can collaborate on the request. operationId: privacy.subjectRightsRequests.ListCollaborators 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: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/microsoft.graph.userCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id}: description: >- Provides operations to manage the collaborators property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get collaborators from privacy description: Collection of users who can collaborate on the request. operationId: privacy.subjectRightsRequests.GetCollaborators parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.user' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user x-ms-docs-grouped-path: - >- /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators(userPrincipalName='{userPrincipalName}') /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id}/mailboxSettings: get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get mailboxSettings property value description: >- Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select. operationId: privacy.subjectRightsRequests.collaborators.GetMailboxSettings parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Entity result. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.mailboxSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. patch: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Update property mailboxSettings value. operationId: privacy.subjectRightsRequests.collaborators.UpdateMailboxSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.mailboxSettings' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.mailboxSettings' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id}/serviceProvisioningErrors: get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get serviceProvisioningErrors property value description: >- Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance). operationId: >- privacy.subjectRightsRequests.collaborators.ListServiceProvisioningErrors 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: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.serviceProvisioningErrorCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id}/serviceProvisioningErrors/$count: description: Provides operations to count the resources in the collection. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get the number of the resource operationId: >- privacy.subjectRightsRequests.collaborators.ServiceProvisioningErrors.GetCount-bb73 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: user-id in: path description: The unique identifier of user required: true schema: type: string x-ms-docs-key-type: user /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators(userPrincipalName='{userPrincipalName}'): description: >- Provides operations to manage the collaborators property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get collaborators from privacy description: Collection of users who can collaborate on the request. operationId: privacy.subjectRightsRequests.collaborators.GetByUserPrincipalName parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.user' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: userPrincipalName in: path description: Alternate key of user required: true schema: type: string nullable: true x-ms-docs-grouped-path: - >- /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/{user-id} /privacy/subjectRightsRequests/{subjectRightsRequest-id}/collaborators/$count: description: Provides operations to count the resources in the collection. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get the number of the resource operationId: privacy.subjectRightsRequests.collaborators.GetCount-5c55 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/getFinalAttachment(): description: Provides operations to call the getFinalAttachment method. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Invoke function getFinalAttachment description: >- Get the final attachment for a subject rights request. The attachment is a zip file that contains all the files that were included by the privacy administrator. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-getfinalattachment?view=graph-rest-1.0 operationId: privacy.subjectRightsRequests.subjectRightsRequest.getFinalAttachment responses: 2XX: description: Success content: application/octet-stream: schema: type: object properties: value: type: string format: base64url nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: function parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/getFinalReport(): description: Provides operations to call the getFinalReport method. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Invoke function getFinalReport description: >- Get the final report for a subject rights request. The report is a text file that contains information about the files that were included by the privacy administrator. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-getfinalreport?view=graph-rest-1.0 operationId: privacy.subjectRightsRequests.subjectRightsRequest.getFinalReport responses: 2XX: description: Success content: application/octet-stream: schema: type: object properties: value: type: string format: base64url nullable: true 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: function parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/notes: description: >- Provides operations to manage the notes property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph List authoredNotes description: >- Get the list of authored notes assoicated with a subject rights request. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-list-notes?view=graph-rest-1.0 operationId: privacy.subjectRightsRequests.ListNotes 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: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: >- #/components/responses/microsoft.graph.authoredNoteCollectionResponse 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Create authoredNote description: Create a new authoredNote object. externalDocs: description: Find more info here url: >- https://learn.microsoft.com/graph/api/subjectrightsrequest-post-notes?view=graph-rest-1.0 operationId: privacy.subjectRightsRequests.CreateNotes requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authoredNote' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authoredNote' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/notes/{authoredNote-id}: description: >- Provides operations to manage the notes property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get notes from privacy description: List of notes associated with the request. operationId: privacy.subjectRightsRequests.GetNotes parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authoredNote' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation patch: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Update the navigation property notes in privacy operationId: privacy.subjectRightsRequests.UpdateNotes requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authoredNote' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.authoredNote' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation delete: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Delete navigation property notes for privacy operationId: privacy.subjectRightsRequests.DeleteNotes parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest - name: authoredNote-id in: path description: The unique identifier of authoredNote required: true schema: type: string x-ms-docs-key-type: authoredNote /privacy/subjectRightsRequests/{subjectRightsRequest-id}/notes/$count: description: Provides operations to count the resources in the collection. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get the number of the resource operationId: privacy.subjectRightsRequests.notes.GetCount-b393 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/{subjectRightsRequest-id}/team: description: >- Provides operations to manage the team property of the microsoft.graph.subjectRightsRequest entity. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get team from privacy description: >- Information about the Microsoft Teams team that was created for the request. operationId: privacy.subjectRightsRequests.GetTeam parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.team' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. x-ms-docs-operation-type: operation parameters: - name: subjectRightsRequest-id in: path description: The unique identifier of subjectRightsRequest required: true schema: type: string x-ms-docs-key-type: subjectRightsRequest /privacy/subjectRightsRequests/$count: description: Provides operations to count the resources in the collection. get: tags: - privacy.subjectRightsRequest summary: Microsoft Graph Get the number of the resource operationId: privacy.subjectRightsRequests.GetCount-ab4f parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' deprecated: true x-ms-deprecation: removalDate: '2025-03-20' date: '2022-03-22' version: 2022-02/PrivacyDeprecate description: >- The subject rights request API under Privacy is deprecated and will stop working on March 22, 2025. Please use the new API under Security. components: schemas: microsoft.graph.privacy: title: privacy required: - '@odata.type' type: object properties: subjectRightsRequests: type: array items: $ref: '#/components/schemas/microsoft.graph.subjectRightsRequest' x-ms-navigationProperty: true '@odata.type': type: string microsoft.graph.subjectRightsRequest: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: subjectRightsRequest required: - '@odata.type' type: object properties: assignedTo: anyOf: - $ref: '#/components/schemas/microsoft.graph.identity' - type: object nullable: true description: Identity that the request is assigned to. closedDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the request was closed. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true contentQuery: type: string description: >- KQL based content query that should be used for search. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. nullable: true createdBy: anyOf: - $ref: '#/components/schemas/microsoft.graph.identitySet' - type: object nullable: true description: Identity information for the entity that created the request. createdDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the request was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true dataSubject: anyOf: - $ref: '#/components/schemas/microsoft.graph.dataSubject' - type: object nullable: true description: Information about the data subject. dataSubjectType: anyOf: - $ref: '#/components/schemas/microsoft.graph.dataSubjectType' - type: object nullable: true description: >- The type of the data subject. The possible values are: customer, currentEmployee, formerEmployee, prospectiveEmployee, student, teacher, faculty, other, unknownFutureValue. description: type: string description: Description for the request. nullable: true displayName: type: string description: The name of the request. nullable: true externalId: type: string description: >- The external ID for the request that is immutable after creation and is used for tracking the request for the external system. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. nullable: true history: type: array items: $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestHistory description: Collection of history change events. includeAllVersions: type: boolean description: >- Include all versions of the documents. By default, the current copies of the documents are returned. If SharePoint sites have versioning enabled, including all versions includes the historical copies of the documents. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. nullable: true includeAuthoredContent: type: boolean description: >- Include content authored by the data subject. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. nullable: true insight: anyOf: - $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestDetail - type: object nullable: true description: Insight about the request. internalDueDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the request is internally due. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true lastModifiedBy: anyOf: - $ref: '#/components/schemas/microsoft.graph.identitySet' - type: object nullable: true description: >- Identity information for the entity that last modified the request. lastModifiedDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the request was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true mailboxLocations: anyOf: - $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestMailboxLocation - type: object nullable: true description: >- The mailbox locations that should be searched. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. pauseAfterEstimate: type: boolean description: >- Pause the request after estimate has finished. By default, the data estimate runs and then pauses, allowing you to preview results and then select the option to retrieve data in the UI. You can set this property to false if you want it to perform the estimate and then automatically begin with the retrieval of the content. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. nullable: true regulations: type: array items: type: string nullable: true description: List of regulations that this request fulfill. siteLocations: anyOf: - $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestSiteLocation - type: object nullable: true description: >- The SharePoint and OneDrive site locations that should be searched. This property is defined only for APIs accessed using the /security query path and not the /privacy query path. stages: type: array items: $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestStageDetail description: Information about the different stages for the request. status: anyOf: - $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestStatus - type: object nullable: true description: >- The status of the request. The possible values are: active, closed, unknownFutureValue. type: anyOf: - $ref: >- #/components/schemas/microsoft.graph.subjectRightsRequestType - type: object nullable: true description: >- The type of the request. The possible values are: export, delete, access, tagForAction, unknownFutureValue. approvers: type: array items: $ref: '#/components/schemas/microsoft.graph.user' description: >- Collection of users who can approve the request. Currently only supported for requests of type delete. x-ms-navigationProperty: true collaborators: type: array items: $ref: '#/components/schemas/microsoft.graph.user' description: Collection of users who can collaborate on the request. x-ms-navigationProperty: true notes: type: array items: $ref: '#/components/schemas/microsoft.graph.authoredNote' description: List of notes associated with the request. x-ms-navigationProperty: true team: anyOf: - $ref: '#/components/schemas/microsoft.graph.team' - type: object nullable: true description: >- Information about the Microsoft Teams team that was created for the request. x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.subjectRightsRequest' microsoft.graph.user: allOf: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - title: user required: - '@odata.type' type: object properties: aboutMe: type: string description: >- A freeform text entry field for the user to describe themselves. Returned only on $select. nullable: true 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. For more information, see legal age group property definitions. Returned only on $select. Supports $filter (eq, ne, not, and in). nullable: true assignedLicenses: type: array items: $ref: '#/components/schemas/microsoft.graph.assignedLicense' description: >- The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0). 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: anyOf: - $ref: '#/components/schemas/microsoft.graph.authorizationInfo' - type: object 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. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select. format: date-time businessPhones: type: array items: type: string description: >- The telephone numbers for the user. NOTE: Although it's a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith). city: type: string description: >- The city where the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). nullable: true companyName: type: string description: >- The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters.Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). nullable: true consentProvidedForMinor: type: string description: >- Sets whether consent was obtained for minors. Allowed values: null, Granted, Denied, and NotRequired. For more information, see legal age group property definitions. Returned only on $select. Supports $filter (eq, ne, not, and in). nullable: true country: type: string description: >- The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). nullable: true createdDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). 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 a guest signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, not, in). nullable: true customSecurityAttributes: anyOf: - $ref: >- #/components/schemas/microsoft.graph.customSecurityAttributeValue - type: object nullable: true description: >- An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select. Supports $filter (eq, ne, not, startsWith). The filter value is case-sensitive. To read this property, the calling app must be assigned the CustomSecAttributeAssignment.Read.All permission. To write this property, the calling app must be assigned the CustomSecAttributeAssignment.ReadWrite.All permissions. To read or write this property in delegated scenarios, the admin must be assigned the Attribute Assignment Administrator role. department: type: string description: >- The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values). nullable: true deviceEnrollmentLimit: maximum: 2147483647 minimum: -2147483648 type: number description: >- The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000. format: int32 displayName: type: string description: >- The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search. 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 a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). format: date-time nullable: true employeeId: type: string description: >- The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). nullable: true employeeLeaveDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator (least privilege), Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user. format: date-time nullable: true employeeOrgData: anyOf: - $ref: '#/components/schemas/microsoft.graph.employeeOrgData' - type: object nullable: true description: >- Represents organization data (for example, division and costCenter) associated with a user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). 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 a guest invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in). 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 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. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. format: date-time 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. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) with limitations. 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). interests: type: array items: type: string nullable: true description: >- A list for the user to describe their interests. Returned only on $select. isManagementRestricted: type: boolean description: >- true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select. nullable: true isResourceAccount: type: boolean description: Don't 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 Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select. 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, Undefined, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select. nullable: true licenseAssignmentStates: type: array items: $ref: '#/components/schemas/microsoft.graph.licenseAssignmentState' description: >- State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select. mail: type: string description: >- The SMTP address for the user, for example, jeff@contoso.com. Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values). nullable: true mailboxSettings: anyOf: - $ref: '#/components/schemas/microsoft.graph.mailboxSettings' - type: object nullable: true description: >- Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select. 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 the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search. nullable: true mySite: type: string description: The URL for the user's site. Returned only on $select. 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 Microsoft Entra ID via Microsoft Entra 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 Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. nullable: true onPremisesExtensionAttributes: anyOf: - $ref: >- #/components/schemas/microsoft.graph.onPremisesExtensionAttributes - type: object nullable: true description: >- Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Returned only on $select. Supports $filter (eq, ne, not, in). onPremisesImmutableId: type: string description: >- This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in). 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. 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 Microsoft Entra ID via Microsoft Entra 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 Microsoft Entra ID. 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 Microsoft Entra ID via Microsoft Entra 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 other email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com']. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can't contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0). 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 might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values). nullable: true passwordProfile: anyOf: - $ref: '#/components/schemas/microsoft.graph.passwordProfile' - type: object nullable: true description: >- Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). To update this property: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that's allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role. pastProjects: type: array items: type: string nullable: true description: >- A list for the user to enumerate their past projects. Returned only on $select. postalCode: type: string description: >- The postal code for the user's postal address. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). 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. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: 'en-US', or 'es-ES'. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) nullable: true preferredName: type: string description: >- The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select. nullable: true print: anyOf: - $ref: '#/components/schemas/microsoft.graph.userPrint' - type: object 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 update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0). 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 attended. Returned only on $select. securityIdentifier: type: string description: >- Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith). nullable: true serviceProvisioningErrors: type: array items: $ref: '#/components/schemas/microsoft.graph.serviceProvisioningError' description: >- Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance). showInAddressList: type: boolean description: >- Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue. nullable: true signInActivity: anyOf: - $ref: '#/components/schemas/microsoft.graph.signInActivity' - type: object nullable: true description: >- Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: Details for this property require a Microsoft Entra ID P1 or P2 license and the AuditLog.Read.All permission.This property isn't returned for a user who never signed in or last signed in before April 2020. 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 session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select. format: date-time nullable: true skills: type: array items: type: string nullable: true description: >- A list for the user to enumerate their skills. Returned only on $select. 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 1,024 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 are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: US, JP, and GB. Not nullable. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). nullable: true userPrincipalName: type: string description: >- The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property can't contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby. nullable: true userType: type: string description: >- A string value that can be used to classify user types in your directory. The possible values are Member and Guest. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for members and guests, see What are the default user permissions in Microsoft Entra ID? nullable: 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 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 appRoleAssignments: type: array items: $ref: '#/components/schemas/microsoft.graph.appRoleAssignment' description: >- Represents the app roles a user is granted for an application. Supports $expand. x-ms-navigationProperty: true authentication: anyOf: - $ref: '#/components/schemas/microsoft.graph.authentication' - type: object nullable: true description: The authentication methods that are supported for the user. x-ms-navigationProperty: true calendar: anyOf: - $ref: '#/components/schemas/microsoft.graph.calendar' - type: object nullable: true description: The user's primary calendar. Read-only. x-ms-navigationProperty: true 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 chats: type: array items: $ref: '#/components/schemas/microsoft.graph.chat' x-ms-navigationProperty: true cloudClipboard: anyOf: - $ref: '#/components/schemas/microsoft.graph.cloudClipboardRoot' - type: object nullable: true x-ms-navigationProperty: true cloudPCs: type: array items: $ref: '#/components/schemas/microsoft.graph.cloudPC' description: The user's Cloud PCs. 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 createdObjects: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' description: Directory objects that the user created. Read-only. Nullable. x-ms-navigationProperty: true dataSecurityAndGovernance: anyOf: - $ref: >- #/components/schemas/microsoft.graph.userDataSecurityAndGovernance - type: object nullable: true description: >- The data security and governance settings for the user. Read-only. Nullable. 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 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 drive: anyOf: - $ref: '#/components/schemas/microsoft.graph.drive' - type: object nullable: true description: The user's OneDrive. Read-only. x-ms-navigationProperty: true 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 employeeExperience: anyOf: - $ref: '#/components/schemas/microsoft.graph.employeeExperienceUser' - type: object nullable: true 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 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 followedSites: type: array items: $ref: '#/components/schemas/microsoft.graph.site' x-ms-navigationProperty: true inferenceClassification: anyOf: - $ref: '#/components/schemas/microsoft.graph.inferenceClassification' - type: object nullable: true description: >- Relevance classification of the user's messages based on explicit designations that override inferred relevance or importance. x-ms-navigationProperty: true insights: anyOf: - $ref: '#/components/schemas/microsoft.graph.itemInsights' - type: object nullable: true description: >- Represents relationships between a user and items such as OneDrive for work or school documents, calculated using advanced analytics and machine learning techniques. Read-only. Nullable. x-ms-navigationProperty: true joinedTeams: type: array items: $ref: '#/components/schemas/microsoft.graph.team' 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 mailFolders: type: array items: $ref: '#/components/schemas/microsoft.graph.mailFolder' description: The user's mail folders. Read-only. Nullable. 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 managedDevices: type: array items: $ref: '#/components/schemas/microsoft.graph.managedDevice' description: The managed devices associated with the user. x-ms-navigationProperty: true manager: anyOf: - $ref: '#/components/schemas/microsoft.graph.directoryObject' - type: object nullable: true description: >- The user or contact that is this user's manager. Read-only. Supports $expand. x-ms-navigationProperty: true 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 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 oauth2PermissionGrants: type: array items: $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant' x-ms-navigationProperty: true onenote: anyOf: - $ref: '#/components/schemas/microsoft.graph.onenote' - type: object nullable: true x-ms-navigationProperty: true onlineMeetings: type: array items: $ref: '#/components/schemas/microsoft.graph.onlineMeeting' description: >- Information about a meeting, including the URL used to join a meeting, the attendees list, and the description. x-ms-navigationProperty: true outlook: anyOf: - $ref: '#/components/schemas/microsoft.graph.outlookUser' - type: object nullable: true x-ms-navigationProperty: true ownedDevices: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' description: >- Devices the user owns. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). x-ms-navigationProperty: true ownedObjects: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' description: >- Directory objects the user owns. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1). x-ms-navigationProperty: true 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 permissionGrants: type: array items: $ref: >- #/components/schemas/microsoft.graph.resourceSpecificPermissionGrant description: List all resource-specific permission grants of a user. x-ms-navigationProperty: true photo: anyOf: - $ref: '#/components/schemas/microsoft.graph.profilePhoto' - type: object nullable: true description: The user's profile photo. Read-only. x-ms-navigationProperty: true photos: type: array items: $ref: '#/components/schemas/microsoft.graph.profilePhoto' description: >- The collection of the user's profile photos in different sizes. Read-only. x-ms-navigationProperty: true planner: anyOf: - $ref: '#/components/schemas/microsoft.graph.plannerUser' - type: object nullable: true description: >- Entry-point to the Planner resource that might exist for a user. Read-only. x-ms-navigationProperty: true presence: anyOf: - $ref: '#/components/schemas/microsoft.graph.presence' - type: object nullable: true 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 and returns up to 100 objects. x-ms-navigationProperty: true scopedRoleMemberOf: type: array items: $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership' x-ms-navigationProperty: true settings: anyOf: - $ref: '#/components/schemas/microsoft.graph.userSettings' - type: object nullable: true x-ms-navigationProperty: true solutions: anyOf: - $ref: '#/components/schemas/microsoft.graph.userSolutionRoot' - type: object nullable: true description: >- The identifier that relates the user to the working time schedule triggers. Read-Only. Nullable x-ms-navigationProperty: true sponsors: type: array items: $ref: '#/components/schemas/microsoft.graph.directoryObject' description: >- The users and groups responsible for this guest's privileges in the tenant and keeping the guest's information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand. x-ms-navigationProperty: true teamwork: anyOf: - $ref: '#/components/schemas/microsoft.graph.userTeamwork' - type: object nullable: true description: >- A container for Microsoft Teams features available for the user. Read-only. Nullable. x-ms-navigationProperty: true todo: anyOf: - $ref: '#/components/schemas/microsoft.graph.todo' - type: object nullable: true description: Represents the To Do services available to a user. 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 '@odata.type': type: string default: '#microsoft.graph.user' description: Represents a Microsoft Entra user account. x-ms-discriminator-value: '#microsoft.graph.user' microsoft.graph.mailboxSettings: title: mailboxSettings required: - '@odata.type' type: object properties: archiveFolder: type: string description: Folder ID of an archive folder for the user. nullable: true automaticRepliesSetting: anyOf: - $ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting' - type: object nullable: true description: >- Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user. dateFormat: type: string description: The date format for the user's mailbox. nullable: true delegateMeetingMessageDeliveryOptions: anyOf: - $ref: >- #/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions - type: object nullable: true description: >- If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses. The possible values are: sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal, sendToDelegateOnly. language: anyOf: - $ref: '#/components/schemas/microsoft.graph.localeInfo' - type: object nullable: true description: >- The locale information for the user, including the preferred language and country/region. timeFormat: type: string description: The time format for the user's mailbox. nullable: true timeZone: type: string description: The default time zone for the user's mailbox. nullable: true userPurpose: anyOf: - $ref: '#/components/schemas/microsoft.graph.userPurpose' - type: object nullable: true description: >- The purpose of the mailbox. Differentiates a mailbox for a single user from a shared mailbox and equipment mailbox in Exchange Online. The possible values are: user, linked, shared, room, equipment, others, unknownFutureValue. Read-only. workingHours: anyOf: - $ref: '#/components/schemas/microsoft.graph.workingHours' - type: object nullable: true description: >- The days of the week and hours in a specific time zone that the user works. '@odata.type': type: string microsoft.graph.authoredNote: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: authoredNote required: - '@odata.type' type: object properties: author: anyOf: - $ref: '#/components/schemas/microsoft.graph.identity' - type: object nullable: true description: Identity information about the note's author. content: anyOf: - $ref: '#/components/schemas/microsoft.graph.itemBody' - type: object nullable: true description: The content of the note. createdDateTime: pattern: >- ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ type: string description: >- The date and time when the entity was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. format: date-time nullable: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.authoredNote' microsoft.graph.team: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: team required: - '@odata.type' 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 preconfigured 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: 1,024 characters. nullable: true displayName: type: string description: The name of the team. nullable: true firstChannelName: type: string description: >- The name of the first channel in the team. This is an optional property, only used during team creation and isn't returned in methods to get and list teams. nullable: true funSettings: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamFunSettings' - type: object nullable: true description: >- Settings to configure use of Giphy, memes, and stickers in the team. guestSettings: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamGuestSettings' - type: object nullable: true description: >- Settings to configure whether guests can create, update, or delete channels in the team. internalId: type: string description: >- A unique ID for the team that was 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: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamMemberSettings' - type: object nullable: true description: >- Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team. messagingSettings: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamMessagingSettings' - type: object nullable: true description: Settings to configure messaging and mentions in the team. specialization: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamSpecialization' - type: object nullable: true description: >- Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case. summary: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamSummary' - type: object nullable: true description: >- Contains summary information about the team, including number of owners, members, and guests. tenantId: type: string description: The ID of the Microsoft Entra tenant. nullable: true visibility: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamVisibilityType' - type: object nullable: true description: The visibility of the group and team. Defaults to Public. webUrl: type: string description: >- A hyperlink that goes to the team in the Microsoft Teams client. You get this URL 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: anyOf: - $ref: '#/components/schemas/microsoft.graph.group' - type: object nullable: true x-ms-navigationProperty: true 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 permissionGrants: type: array items: $ref: >- #/components/schemas/microsoft.graph.resourceSpecificPermissionGrant description: A collection of permissions granted to apps to access the team. x-ms-navigationProperty: true photo: anyOf: - $ref: '#/components/schemas/microsoft.graph.profilePhoto' - type: object nullable: true description: The profile photo for the team. x-ms-navigationProperty: true primaryChannel: anyOf: - $ref: '#/components/schemas/microsoft.graph.channel' - type: object nullable: true description: The general channel for the team. x-ms-navigationProperty: true schedule: anyOf: - $ref: '#/components/schemas/microsoft.graph.schedule' - type: object nullable: true description: The schedule of shifts for this team. x-ms-navigationProperty: true tags: type: array items: $ref: '#/components/schemas/microsoft.graph.teamworkTag' description: The tags associated with the team. x-ms-navigationProperty: true template: anyOf: - $ref: '#/components/schemas/microsoft.graph.teamsTemplate' - type: object nullable: true description: >- The template this team was created from. See available templates. x-ms-navigationProperty: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.team' parameters: top: name: $top in: query description: Show only the first n items style: form explode: false schema: minimum: 0 type: integer example: 50 skip: name: $skip in: query description: Skip the first n items style: form explode: false schema: minimum: 0 type: integer search: name: $search in: query description: Search items by search phrases style: form explode: false schema: type: string filter: name: $filter in: query description: Filter items by property values style: form explode: false schema: type: string count: name: $count in: query description: Include count of items style: form explode: false schema: type: boolean examples: {} responses: error: description: error content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError' microsoft.graph.userCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.userCollectionResponse' ODataCountResponse: description: The count of the resource content: text/plain: schema: $ref: '#/components/schemas/ODataCountResponse' tags: - name: Privacy.privacy - name: privacy.subjectRightsRequest