diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..d7ab3f99 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "workbench.colorTheme": "Default Light+" +} \ No newline at end of file diff --git a/EDUGraphAPIs/Assignments/GettingStarted.md b/EDUGraphAPIs/Assignments/GettingStarted.md deleted file mode 100644 index 3ac71428..00000000 --- a/EDUGraphAPIs/Assignments/GettingStarted.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft Education Graph Assignments API : Getting Started - - This document provides information for getting started with assignments API. - - ### Understanding Scopes - - The Assignment Service adds a few new scopes to the **Microsoft Graph**. These scopes are used to access Assignment information. The scope applies to all the **Assignment** objects including [Assignment](./resources/educationassignment.md), [Resource](./resources/educationresource.md), and [Submission](./resources/educationsubmission.md). With an App+User Context, the API will only return objects that the user has access to. The "Basic" scopes work the same as the non-basic equivalent scopes, however grade information will not be returned in the Submission objects for "Basic" scopes. - - >**Note:** Students can only access their own Submission. - -#### App-Only Context - -| Role (scope) | Display Name |Description| -|:-----------------|:-------------------|:----------| -|EduAssignments.ReadBasic.All| Read class assignments without grades|Allows the app to read assignments without grades for all users| -|EduAssignments.ReadWriteBasic.All | Read and write class assignments without grades | Allows the app to read and write assignments without grades for all users| -|EduAssignments.Read.All| Read class assignments with grades | Allows the app to read assignments and their grades for all users | -|EduAssignments.ReadWrite.All | Read and write class assignments with grades | Allows the app to read and write assignments and their grades for all users | - - - -#### App+User Context - -| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | -|:-----------------|:-------------------|:----------|--------------|------------| -|EduAssignments.ReadBasic| Read a user's view of class assignments without grades | Allows the app to read assignments without grades on behalf of the user | View your assignments without grades | Allows the app to view your assignments on your behalf without seeing grades | -|EduAssignments.ReadWriteBasic|Read and write a user's view of class assignments without grades|Allows the app to read and write assignments without grades on behalf of the user|View and modify your assignments without grades|Allows the app to view and modify your assignments on your behalf without seeing grades| -|EduAssignments.Read|Read a user's view of class assignments and their grades|Allows the app to read assignments and their grades on behalf of the user|View your assignments and grades|Allows the app to view your assignments on your behalf including grades| -|EduAssignments.ReadWrite|Read and write a user's view of class assignments and their grades|Allows the app to read and write assignments and their grades on behalf of the user|View and modify your assignments and grades|Allows the app to view and modify your assignments on your behalf including grades| - - - ### Understanding assignment Resources - -Assignment APIs provide the following key resources: - -- [assignment](./resources/educationassignment.md) - **Assignment** is the core object of the Assignments API and owned by the class. -- [Submission](.resources/educationsubmission.md) - **Submission** objects are owned by an assignment. They represents the resources that an individual (or group) submit for an assignment and associated grade/feedback. -- [Resource](resources/educationresource.md) - A resource is associated with an **Assignment** and/or **Submission** and represents the learning object that is being assigned or submitted. - - ### Overview of APIs -Assignments endpoint in EDU Graph provide the following APIs. - -- [Create Assignment](./api/educationclass_post_assignments.md) -- [Publish Assignment](./api/educationassignment_publish.md) -- [Create Assignment Resource](./api/educationassignment_post_resources.md) -- [Create Submission Resource](./api/educationsubmission_post_resources.md) -- [Submit Assignment](./api/educationsubmission_submit.md) -- [Release Grades to student](./api/educationsubmission_release.md) -- [Get assignment Details](./api/educationuser_list_assignments.md) - -Check out the complete set of APIs [here](./api). - - -### Building your first app - -Read the [Microsoft Graph documentation](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using assignment APIs. - - The [EDUGraphAPI - Office 365 Education Code Sample](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) is available from our _GitHub_ repository. Clone the repository to learn about the end to end sample built on Assignments APIs. - diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index bd730723..2dd08918 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -1,6 +1,8 @@ # Delete educationAssignment -Use this API to delete an existing Assignment. No request body is necessary. Only Teachers within a Class can delete Assignments. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Delete an existing assignment. Only teachers within a class can delete assignments. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -13,9 +15,9 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request -```http +```http DELETE /education/classes//assignments/ ``` ## Request headers @@ -28,26 +30,29 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example -##### Request -Here is an example of the request. +### Request +The following is an example of the request. -```http -DELETE https://graph.microsoft.com/beta/education/classes//assignments/ +```http +DELETE https://graph.microsoft.com/beta/education/classes/11014/assignments/19002 ``` -##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +### Response +The following is an example of the response. + + + ```http HTTP/1.1 204 No Content ``` diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_get.md b/EDUGraphAPIs/Assignments/api/educationassignment_get.md index cb1998d1..5784cc82 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_get.md @@ -1,16 +1,13 @@ # Get educationAssignment -Use this API to get an assignment properties and its relationships. Students can only see assignments assigned to them while teachers can see all assignments in a class. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Get the properties and relationships of an assignment. Students can only see assignments assigned to them; teachers can see all assignments in a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). - ->**Note:** Due to a bug, the graph will return educationItemBody for the instructions property. This is an exact duplicate of the itemBody that -is already found on the graph. When the code moves to production, this will be updated. For clients who simply use the json being sent back and forth to the graph, there should be no work necessary to handle this change. - - |Permission type | Permissions (from least to most privileged) | |:--------------------|:---------------------------------------------------------| |Delegated (work or school account) | EduAssignments.ReadBasic, EduAssignments.ReadWriteBasic, EduAssignments.Read, EduAssignments.ReadWrite | @@ -20,7 +17,7 @@ is already found on the graph. When the code moves to production, this will be u ## HTTP request ```http -GET /education/classes//assignments/ +GET /education/classes/{id}/assignments/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -34,19 +31,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments/ +GET https://graph.microsoft.com/beta/education/classes/11014/assignments/19002 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + +```http +POST /education/classes/{id}/assignments/{id}/getResourcesFolderUrl + +``` +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer {token}. Required. | + +## Request body +Do not supply a request body for this method. +## Response +If successful, this method returns a `200 Ok` response code. The body will contain the OneDrive URL of a folder in which to put all file-based resources. + +## Example +The following example shows how to call this API. +##### Request +The following is an example of a request. + +```http +POST https://graph.microsoft.com/beta/education/classes/11012/assignments/19002/getResourcesFolderUrl +``` + +##### Response +The following is an example of a response. + + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 279 + +{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.String", + "value": "https://graph.microsoft.com/v1.0/drives/b!8-QjN2tsv0WyGnTv7vOvnQkmGHbbeMNLqYKONmHLVnvCVmBYIGpeT456457AdW9f/items/017NJZI25NOB5XZNLABF7646XAMDZTQQ6T" +} +``` + + + diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md index 92e48db1..3b0180a6 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md @@ -1,5 +1,7 @@ # List resources +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Get all the resources associated with this assignment. ## Permissions @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//resources +GET /education/classes/{id}/assignments/{id}/resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//resources +GET https://graph.microsoft.com/beta/education/classes/11012/assignments/19002/resources ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /education/classes//assignments//submissions +GET /education/classes/{id}/assignments/{id}/submissions ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -30,16 +32,19 @@ Do not supply a request body for this method. If successful, this method returns a `200 OK` response code and collection of [educationSubmission](../resources/educationsubmission.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//submissions +GET https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. + ```http -POST /education/classes//assignments//resources +POST /education/classes/{id}/assignments/{id}/resources ``` ## Request headers | Header | Value | @@ -23,21 +25,21 @@ POST /education/classes//assignments//resources | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationAssignmentResource](../resources/educationassignmentresource.md) object. +In the request body, supply a JSON representation of the [educationAssignmentResource](../resources/educationassignmentresource.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/classes//assignments//resources +POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/resources Content-type: application/json Content-length: 822 @@ -50,18 +52,19 @@ Content-length: 822 } } ``` -In the request body, supply a JSON representation of [educationAssignmentResource](../resources/educationassignmentresource.md) object. +In the request body, supply a JSON representation of the [educationAssignmentResource](../resources/educationassignmentresource.md) object. ##### Response -Here is an example of the response. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. ->**Note:** The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -```http +```http HTTP/1.1 201 Created Content-type: application/json @@ -77,7 +80,7 @@ Content-length: 842 } } - +``` -``` \ No newline at end of file diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index 8082e90e..318d7066 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -1,6 +1,8 @@ # educationAssignment: publish -This action changes the state of an assignment from its original draft status to the published status. Only a teacher in the class can make this call. When an assignment is in draft status, students will not see the assignment nor will there be any submission objects. By calling this api, submission objects will be created and the assignment will show up in the student's list. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +This action changes the state of an assignment from its original draft status to the published status. Only a teacher in the class can make this call. When an assignment is in draft status, students will not see the assignment, nor will there be any submission objects. When you call this API, submission objects are created and the assignment appears in the student's list. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//publish +POST /education/classes/{id}/assignments/{id}/publish ``` ## Request headers @@ -23,24 +25,26 @@ POST /education/classes//assignments//publish | Authorization | Bearer {token}. Required. | ## Request body +Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example -Here is an example of how to call this API. +The following example shows how to call this API. ##### Request -Here is an example of the request. +The following is an example of a request. ```http -POST https://graph.microsoft.com/beta/education/classes//assignments//publish +POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/publish ``` ##### Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +The following is an example of a response. + \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_update.md b/EDUGraphAPIs/Assignments/api/educationassignment_update.md index 560030b0..4a6845e1 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_update.md @@ -1,12 +1,8 @@ # Update educationassignment -Update the assignment object. Only teachers in the class can do this action. Note that the status of an assignment cannot be changed in a PATCH, the URL action should be used to change an assignment state. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. - - -Due to a bug, the graph will return educationItemBody for the instructions property. This is an exact duplicate of the itemBody that -is already found on the graph. When the code moves to prodution, this will be updated. For clients who simply use the json being -sent back and forth to the graph, there should be no work necessary to handle this change. +Update the assignment object. Only teachers in the class can do this. Note that you can't use a PATCH request to change the status of an assignment. Use the [publish](../api/educationassignment_publish.md) action to change the assignment status. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -20,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments/ +PATCH /education/classes/{id}/assignments/{id} ``` ## Request headers | Header | Value | @@ -29,44 +25,47 @@ PATCH /education/classes//assignments/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|allowLateSubmissions|Boolean| Whether submisions can be submitted after the due date| -|allowStudentsToAddResourcesToSubmission|Boolean| Wether a student can add resources to a submission. Indicated whether the only items on the submission came from the assignment resource list. | -|assignDateTime|DateTimeOffset| Date the assignmetn should be published to students. | -|assignTo|educationAssignmentRecipient| Students who get the assignment| +|allowLateSubmissions|Boolean| Whether submissions can be submitted after the due date.| +|allowStudentsToAddResourcesToSubmission|Boolean| Whether a student can add resources to a submission. Indicated whether the only items on the submission came from the assignment resource list. | +|assignDateTime|DateTimeOffset| Date the assignment should be published to students. | +|assignTo|educationAssignmentRecipient| Students who get the assignment.| |displayName|String| Name of assignment. | |dueDateTime|DateTimeOffset| Date assignment is due. | |grading|educationAssignmentGradeType| How the assignment will be graded.| |instructions|itemBody| Instructions to be given to the students along with the assignment. | ## Response -If successful, this method returns a `200 OK` response code and updated [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -PATCH https://graph.microsoft.com/beta/education/classes//assignments/ +PATCH https://graph.microsoft.com/beta/education/classes/11021/assignments/19002 Content-type: application/json Content-length: 279 { - "displayName": "displayName-value", + "displayName": "Week 1 reading assignment", "instructions": { - "contentType": "contentType-value", - "content": "content-value" + "contentType": "Text", + "content": "Read chapters 1 through 3" }, - "dueDateTime": "datetime-value" + "dueDateTime": "2014-02-01T00:00:00Z" } ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. + ```http -DELETE /educationClasses/assignments//resources/ +DELETE /educationClasses/assignments/{id}/resources/{id} ``` ## Request headers @@ -27,20 +29,22 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes//assignments//resources/ +DELETE https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/resources/22002 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + + ```http -GET /education/classes//assignments//resources/ +GET /education/classes/{id}/assignments/{id}/resources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -26,19 +28,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//resources/ +GET https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/resources/22002 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. + diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md index a68d18a0..18267bc4 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md @@ -1,6 +1,8 @@ # Update educationassignmentresource -Update the properties of resource associated with an assignment. Only teachers in a class can change assignment resource objects. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Update the properties of resource associated with an assignment. Only teachers in a class can change assignment resource objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments//resources/ +PATCH /education/classes/{id}/assignments/{id}/resources/{id} ``` ## Request headers | Header | Value | @@ -23,24 +25,24 @@ PATCH /education/classes//assignments//resources/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|distributeForStudentWork|Boolean| Indicates whether this resource should be copied to each student's resource object when the assignment is published| -|resource|educationResource| Resource Object. | +|distributeForStudentWork|Boolean| Indicates whether this resource should be copied to each student's resource object when the assignment is published.| +|resource|educationResource| Resource object. | ## Response -If successful, this method returns a `200 OK` response code and updated [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -PATCH https://graph.microsoft.com/beta/education/classes//assignments//resources/ +PATCH https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/resources/850f51b7-1df9-4ec0-bd62-64a0214b9cbf Content-type: application/json Content-length: 822 @@ -49,7 +51,11 @@ Content-length: 822 } ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. + + ```http -GET /education/classes//assignments +GET /education/classes/{id}/assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -34,10 +29,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationAssignment](../resources/educationassignment.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationAssignment](../resources/educationassignment.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST /education/classes//assignments +POST /education/classes/{id}/assignments ``` ## Request headers @@ -30,15 +26,15 @@ POST /education/classes//assignments | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationAssignment](../resources/educationassignment.md) object. +In the request body, supply a JSON representation of an [educationAssignment](../resources/educationassignment.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET /education/classes//assignments//submissions/ +GET /education/classes/{id}/assignments/{id}/submissions/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +31,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationSubmission](../resources/educationsubmission.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationSubmission](../resources/educationsubmission.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//submissions/ +GET https://graph.microsoft.com/beta/education/classes/11010/assignments/19002/submissions/33223 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /educationClasses/assignments//submissions//resources +GET /educationClasses/assignments/{id}/submissions/{id}/resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +29,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSubmissionResource](../resources/educationsubmissionresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSubmissionResource](../resources/educationsubmissionresource.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET /education/classes//assignments//submissions//submittedResources +GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSubmittedSubmissionResource](../resources/educationsubmittedsubmissionresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSubmittedSubmissionResource](../resources/educationsubmittedsubmissionresource.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//submissions//submittedResources +GET https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/submittedResources ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -POST /education/classes//assignments//submissions//resources +POST /education/classes/{id}/assignments/{id}/submissions/{id}/resources ``` ## Request headers @@ -24,31 +26,59 @@ POST /education/classes//assignments//submissions//resources | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationSubmissionResource](../resources/educationsubmissionresource.md) object. +In the request body, supply a JSON representation of the [educationSubmissionResource](../resources/educationsubmissionresource.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationSubmissionResource](../resources/educationsubmissionresource.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationSubmissionResource](../resources/educationsubmissionresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/classes//assignments//submissions//resources +POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/resources Content-type: application/json -Content-length: 848 +Content-length: 1097 { - "resource": {"@odata.type": "microsoft.graph.educationResource"} + "assignmentResourceUrl": "https://graph.microsoft.com/v1.0/drives/b!8-QjN2tsv0WyGnTv7vOvnQkmGHbbeMNLqYKONmHLVnvCVmBYIGpeT456457AdW9f/items/017NJZI25NOB5XZNLABF7646XAMDZTQQ6T", + "resource": { + "@odata.type": "#microsoft.graph.educationWordResource", + "displayName": "Report.docx", + "createdDateTime": "2017-10-21T07:52:53.9863696Z", + "createdBy": { + "application": null, + "device": null, + "user": { + "id": "63cc91d2-59c7-4732-9594-35b91a26b340", + "displayName": null + } + }, + "lastModifiedDateTime": "2017-10-21T07:52:53.9863696Z", + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "63cc91d2-59c7-4732-9594-35b91a26b340", + "displayName": null + } + }, + "fileUrl": "https://graph.microsoft.com/v1.0/drives/b!8-QjN2tsv0WyGnTv7vOvnQkmGHbbeMNLqYKONmHLVnvCVmBYIGpeTZ_iul5AdW9f/items/017NJZI27BCN2QI2H7HJGLIVPXR6SD2DH6" + }, + "@odata.type": "microsoft.graph.educationResource" } + ``` -In the request body, supply a JSON representation of [educationSubmissionResource](../resources/educationsubmissionresource.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -POST /education/classes//assignments//submissions//recall +POST /education/classes//assignments/{id}/submissions/{id}/recall ``` ## Request headers @@ -25,21 +27,23 @@ POST /education/classes//assignments//submissions//recall ## Request body ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example -Here is an example of how to call this API. +The following example shows how to call this API. ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/classes//assignments//submissions//recall +POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/recall ``` -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +##### Response +The following is an example of the response. + ```http -POST /education/classes//assignments//submissions//release +POST /education/classes/{id}/assignments/{id}/submissions/{id}/release ``` ## Request headers @@ -23,24 +25,27 @@ POST /education/classes//assignments//submissions//release | Authorization | Bearer {token}. Required. | ## Request body +Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example -Here is an example of how to call this API. +The following example shows how to call this API. ##### Request -Here is an example of the request. +The following is an example of the request. -##### Response ```http -POST https://graph.microsoft.com/beta/education/classes//assignments//submissions//release +POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/release ``` -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +##### Response +The following is an example of the response. + ```http -POST /education/classes//assignments//submissions//submit +POST /education/classes/{id}/assignments/{id}/submissions/{id}/submit ``` ## Request headers @@ -23,24 +25,26 @@ POST /education/classes//assignments//submissions//submit | Authorization | Bearer {token}. Required. | ## Request body +Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example -Here is an example of how to call this API. +The following example shows how to call this API. ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/classes//assignments//submissions//submit +POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/submit ``` ##### Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +The following is an example of the response. + ```http -PATCH /education/classes//assignments//submissions/ +PATCH /education/classes/{id}/assignments/{id}/submissions/{id} ``` ## Request headers | Header | Value | @@ -22,7 +24,9 @@ PATCH /education/classes//assignments//submissions/ | Authorization | Bearer {token}. Required. | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. + + | Property | Type |Description| |:---------------|:--------|:----------| @@ -30,26 +34,50 @@ In the request body, supply the values for relevant fields that should be update |grade|educationAssignmentGrade|| ## Response -If successful, this method returns a `200 OK` response code and updated [educationSubmission](../resources/educationsubmission.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationSubmission](../resources/educationsubmission.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -PATCH https://graph.microsoft.com/beta/education/classes//assignments//submissions/ +PATCH https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7 Content-type: application/json -Content-length: 712 +Content-length: 658 { - "feedback": {"@odata.type": "microsoft.graph.educationFeedback"}, - "grade": {"@odata.type": "microsoft.graph.educationAssignmentGrade"} + "feedback": { + text: "Great work!" + feedbackDateTime: "2014-01-01T00:00:00Z" + feedbackBy: { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + }, + @odata.type: "microsoft.graph.identitySet" + }, + "@odata.type": "microsoft.graph.educationFeedback" + }, + "grade": { + "gradedBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + }, + "@odata.type": "microsoft.graph.identitySet" + }, + "gradedDateTime": "2014-01-01T00:00:00Z", + "@odata.type": "microsoft.graph.educationAssignmentGrade" + } } ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md index b48be931..ef729371 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md @@ -1,6 +1,8 @@ # Delete educationSubmissionResource -Deletes a resource from the submission. This can only be done by the student. If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows a developer to "reset" the resource to its original state. If the resource was not copied from the assignment but rather added from the student, the resource is simply deleted. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Deletes a resource from the submission. This can only be done by the student. If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows you to "reset" the resource to its original state. If the resource was not copied from the assignment but was added from the student, the resource is simply deleted. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments//submissions//resources/ +DELETE /educationClasses/assignments/{id}/submissions/{id}/resources/{id} ``` ## Request headers @@ -27,20 +29,21 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes//assignments//submissions//resources/ +DELETE https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/resources/f2387c3b-ec39-4bf2-a399-d7242677f024 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + ```http -GET /educationn/classes//assignments//submissions//resources/ +GET /educationn/classes/{id}/assignments/{id}/submissions/{id}/resources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationSubmissionResource](../resources/educationsubmissionresource.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationSubmissionResource](../resources/educationsubmissionresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//submissions//resources/ +GET https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/resources/f2387c3b-ec39-4bf2-a399-d7242677f024 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /education/classes//assignments//submissions//submittedResources/ +GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationSubmittedSubmissionResource](../resources/educationsubmittedsubmissionresource.md) object in the response body. +If successful, this method returns a `200 OK` response code and an[educationSubmittedSubmissionResource](../resources/educationsubmittedsubmissionresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//assignments//submissions//submittedResources/ +GET https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/submissions/850f51b7/submittedResources/f2387c3b-ec39-4bf2-a399-d7242677f024 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md index 068c53eb..9f9311ba 100644 --- a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md @@ -1,12 +1,8 @@ # List assignments -Returns a list of assignments assigned to a user for all classes. This utility namespace allows a caller to find all of a students assignments in a single call rather than having to request assignments from each class. The assignment list contains what is needed to get the detailed information for the assignment from within the class namespace. All other operations on the assignment should use the class namespace. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. - - -Due to a bug, the graph will return educationItemBody for the instructions property. This is an exact duplicate of the itemBody that -is already found on the graph. When the code moves to prodution, this will be updated. For clients who simply use the json being -sent back and forth to the graph, there should be no work necessary to handle this change. +Returns a list of assignments assigned to a user for all classes. This utility namespace allows a caller to find all a student's assignments in a single call rather than having to request assignments from each class. The assignment list contains what is needed to get the detailed information for the assignment from within the class namespace. All other operations on the assignment should use the class namespace. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -21,7 +17,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/assignments/ -GET /education/users//assignments +GET /education/users/{id}/assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -34,10 +30,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationAssignment](../resources/educationassignment.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationAssignment](../resources/educationassignment.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md b/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md index 21cad177..d00c0516 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md @@ -1,13 +1,15 @@ # educationAssignmentClassRecipient resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. -Used inside the [assignment.assignTo](educationassignment.md) property. When set to class recipient, every student in the class will +Used inside the [assignment.assignTo](educationassignment.md) property. When set to class recipient, every student in the class will receive a submission object when the assignment is published. -Subclass of [educationAssignmentRecipient](educationassignmentrecipient.md) +This resource is a subclass of [educationAssignmentRecipient](educationassignmentrecipient.md). ## Properties -None + +None. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md index 2ad3be07..375fa33d 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md @@ -1,18 +1,20 @@ # educationAssignmentGrade resource type -Represents the **Grade** object on a Submission. This is an abstract type and will never be instantiated, however all types of grading (points, pass/fail, etc.) will all subclass from this -resource type. This object also tracks the who of the grading. This is used in the submission.grade property. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Represents the **Grade** object on a Submission. This is an abstract type that will never be instantiated; however, all types of grading (points, pass/fail, and so on) are subclasses of this +resource type. This object also tracks who is doing the grading. This is used in the **submission.grade** property. ## Properties | Property | Type |Description| |:---------------|:--------|:----------| |gradedBy|[identitySet](identityset.md)| User who did the grading. | -|gradedDateTime|DateTimeOffset| Moment in time when the grade was applied to this submission object. 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 would look like this: `'2014-01-01T00:00:00Z'`| +|gradedDateTime|DateTimeOffset| Moment in time when the grade was applied to this submission object. 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 would look like this: `'2014-01-01T00:00:00Z'`| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md index 937b7463..5d8f2677 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md @@ -1,7 +1,9 @@ # educationAssignmentPointsGrade resource type -When an assignment is set to points grade type, each submission will have this object associated with the submission.grade property. This subclasses from [educationAssignmentGrade](educationAssignmentGrade.md) -which will add the who data to this property. The max points is stored in the assignments.grading property. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +When an assignment is set to a points grade type, each submission will have this object associated with the **submission.grade** property. This creates a subclass from [educationAssignmentGrade](educationAssignmentGrade.md), +which will add the who data to this property. The max points is stored in the **assignments.grading** property. ## Properties @@ -11,7 +13,7 @@ which will add the who data to this property. The max points is stored in the a ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md index 83b1d2c3..1f030068 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md @@ -1,32 +1,34 @@ # educationAssignmentResource resource type -Wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will -be copied to the student submission. If the object is not copied, then each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a hand-out from the teacher to the student with nothing to be turned in. If the resource is distributed, each student -will receive a copy of this resource in the resource list of their assignment. Each student will be able to modify their copy and submit it for grading. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +A wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will +be copied to the student submission. If the object is not copied, each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in. If the resource is distributed, each student +will receive a copy of this resource in the resource list of their submission. Each student will be able to modify their copy and submit it for grading. ## Methods | Method | Return Type |Description| |:---------------|:--------|:----------| -|[Get educationAssignmentResource](../api/educationassignmentresource_get.md) | [educationAssignmentResource](educationassignmentresource.md) |Read properties and relationships of educationAssignmentResource object.| -|[Update](../api/educationassignmentresource_update.md) | [educationAssignmentResource](educationassignmentresource.md) |Update educationAssignmentResource object. | -|[Delete](../api/educationassignmentresource_delete.md) | None |Delete educationAssignmentResource object. | +|[Get educationAssignmentResource](../api/educationassignmentresource_get.md) | [educationAssignmentResource](educationassignmentresource.md) |Read properties and relationships of an **educationAssignmentResource** object.| +|[Update](../api/educationassignmentresource_update.md) | [educationAssignmentResource](educationassignmentresource.md) |Update an **educationAssignmentResource** object. | +|[Delete](../api/educationassignmentresource_delete.md) | None |Delete an **educationAssignmentResource** object. | ## Properties | Property | Type |Description| |:---------------|:--------|:----------| |distributeForStudentWork|Boolean|Indicates whether this resource should be copied to each student submission for modification and submission.| -|id|String| ID of this resource. Read-only.| -|resource|[educationResource](educationresource.md)|Resource object that has been assoicated with this assignment.| +|id|String| ID of this resource. Read-only.| +|resource|[educationResource](educationresource.md)|Resource object that has been associated with this assignment.| ## Relationships -None +None. ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/resources/educationexcelresource.md b/EDUGraphAPIs/Assignments/resources/educationexcelresource.md index fd793593..c32afe76 100644 --- a/EDUGraphAPIs/Assignments/resources/educationexcelresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationexcelresource.md @@ -1,20 +1,21 @@ # educationExcelResource resource type -Subclass of [educationResource](educationresource.md). This resource type represents an **Excel** - document. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +A subclass of [educationResource](educationresource.md). This resource type represents an Excel document. ->**Note:** The excel file must be in the resource folder associated with the assignment +>**Note:** The Excel file must be in the resource folder associated with the assignment or submission object to which this resource belongs. ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|fileUrl|String|Pointer to the excel file object.| +|fileUrl|String|Pointer to the Excel file object.| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md b/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md index 485a0bec..b185a282 100644 --- a/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md @@ -1,6 +1,8 @@ # educationPowerPointResource resource type -Subclass of [educationResource](educationresource.md). This is a **PowerPoint** resource. The **PowerPoint** file must be uploaded in the fileResource directory associated with the +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +A subclass of [educationResource](educationresource.md). This is a PowerPoint resource. The PowerPoint file must be uploaded in the **fileResource** directory associated with the assignment or submission. @@ -11,7 +13,7 @@ assignment or submission. ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. diff --git a/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md b/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md index 726eaab4..6abd061e 100644 --- a/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md @@ -1,19 +1,21 @@ # educationSubmissionResource resource type -Wrapper around resource for used on a submission. The wrapper adds a pointer to the assignment resource if this was copied from the assignment. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +A wrapper around a resource for use on a submission. The wrapper adds a pointer to the assignment resource if this was copied from the assignment. ## Methods | Method | Return Type |Description| |:---------------|:--------|:----------| -|[Get educationSubmissionResource](../api/educationsubmissionresource_get.md) | [educationSubmissionResource](educationsubmissionresource.md) |Read properties and relationships of educationSubmissionResource object.| -|[Delete](../api/educationsubmissionresource_delete.md) | None |Delete educationSubmissionResource object. | +|[Get educationSubmissionResource](../api/educationsubmissionresource_get.md) | [educationSubmissionResource](educationsubmissionresource.md) |Read properties and relationships of an **educationSubmissionResource** object.| +|[Delete](../api/educationsubmissionresource_delete.md) | None |Delete an **educationSubmissionResource** object. | ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|assignmentResourceUrl|String|Pointer to the assignment from which this resource was copied. If this is null, the student uploaded the resource.| +|assignmentResourceUrl|String|Pointer to the assignment from which this resource was copied. If this is null, the student uploaded the resource.| |id|String| Read-only.| |resource|[educationResource](educationresource.md)|Resource object.| @@ -23,7 +25,7 @@ None ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. ```http -DELETE /education/classes/ +DELETE /education/classes/{id} ``` ## Request headers @@ -27,20 +29,21 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes/ +DELETE https://graph.microsoft.com/beta/education/classes/11022 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + ```http -DELETE /education/classes//members/{userId}/$ref +DELETE /education/classes/{id}/members/{userId}/$ref ``` ## Request headers | Header | Value | @@ -26,21 +30,21 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and empty response body. +If successful, this method returns a `204 No Content` response code and an empty response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes//members/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008 ``` -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index 4b5e4064..7153524c 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -1,6 +1,8 @@ -# Delete educationUser from educationClass +# Remove a teacher -Delete a teacher from a Class. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Remove a teacher from a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/classes//teachers/{userId}/$ref +DELETE /education/classes/{id}/teachers/{userId}/$ref ``` ## Request headers | Header | Value | @@ -26,21 +28,21 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and empty response body. +If successful, this method returns a `204 No Content` response code and an empty response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes//teachers/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/classes//teachers/14012 ``` -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Rostering/api/educationclass_get.md b/EDUGraphAPIs/Rostering/api/educationclass_get.md index 28eba9c0..9d79b6ae 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_get.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_get.md @@ -1,6 +1,8 @@ # Get educationClass -Retreive a Class from the system. A class is a universal group with a special property indicating to the system that the group is a class. Group members represent the students while group admins represent the teachers in the class. If using the delegated token, the user will only see classes in which they are members. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are members. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/ +GET /education/classes/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,7 +29,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request Here is an example of the request. @@ -36,10 +38,13 @@ Here is an example of the request. "name": "get_educationclass" }--> ```http -GET https://graph.microsoft.com/beta/education/classes/ +GET https://graph.microsoft.com/beta/education/classes/11023 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /education/classes//members +GET /education/classes/{id}/members ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//members +GET https://graph.microsoft.com/beta/education/classes/11016/members ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /education/classes//schools +GET /education/classes/{id}/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -28,19 +30,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSchool](../resources/educationschool.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSchool](../resources/educationschool.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//schools +GET https://graph.microsoft.com/beta/education/classes/11014/schools ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 1d012d2e..902fd160 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -1,6 +1,8 @@ # List teachers -Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//teachers +GET /education/classes/{id}/teachers ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/classes//teachers +GET https://graph.microsoft.com/beta/education/classes/11023/teachers ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -POST /education/classes//members/$ref +POST /education/classes/{id}/members/$ref ``` ## Request headers | Header | Value | @@ -23,31 +25,33 @@ POST /education/classes//members/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/classes//members/$ref +POST https://graph.microsoft.com/beta/education/classes/11011/members/$ref Content-type: application/json Content-length: 56 { - "@odata.id":"https://graph.microsoft.com/beta/education/users/{userId}" + "@odata.id":"https://graph.microsoft.com/beta/education/users/13015"� } ``` -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + + ```http -POST /education/classes//teachers/$ref +POST /education/classes/{id}/teachers/$ref ``` ## Request headers | Header | Value | @@ -23,31 +25,36 @@ POST /education/classes//teachers/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/classes//teachers/$ref +POST https://graph.microsoft.com/beta/education/classes/11017/teachers/$ref Content-type: application/json Content-length: 508 { - "@odata.id":"https://graph.microsoft.com/beta/education/users/{userId}" + "@odata.id":"https://graph.microsoft.com/beta/education/users/14011"� } ``` -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + + + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -PATCH /education/classes/ +PATCH /education/classes/{id} ``` ## Request headers | Header | Value | @@ -23,39 +25,43 @@ PATCH /education/classes/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|description|String| Description of the class| -|displayName|String| Name of the Class| -|mailNickname|String| Mail name for sending email to all users if this is enabled. | -|classCode|String| Class Code used by the school.| +|description|String| Description of the class.| +|displayName|String| Name of the class.| +|mailNickname|String| Email alias for sending email to all users if that feature is enabled. | + +|classCode|String| Class code used by the school.| |externalId|String| ID of the class from the syncing system. | |externalName|String|Name of the class in the syncing system.| -|externalSource|string| How this class was creaeted. Possible values are: `sis`, `manual`, `enum_sentinel`.| +|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `enum_sentinel`.| ## Response -If successful, this method returns a `200 OK` response code and updated [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -PATCH https://graph.microsoft.com/beta/education/classes/ +PATCH https://graph.microsoft.com/beta/education/classes/11014 Content-type: application/json Content-length: 224 { - "description": "String", - "displayName": "String", + "description": "History - World History 1", + "displayName": "World History Level 1", } ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + -```http -GET /education/schools +```http GET /education/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +28,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSchool](../resources/educationschool.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSchool](../resources/educationschool.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -23,15 +27,15 @@ POST /education/users | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE /education/schools/ +DELETE /education/schools/{id} ``` ## Request headers | Header | Value | @@ -26,20 +28,21 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/schools/ +DELETE https://graph.microsoft.com/beta/education/schools/10002 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + ```http -DELETE /education/schools//classes/{classId}/$ref +DELETE /education/schools/{id}/classes/{classId}/$ref ``` ## Request headers | Header | Value | @@ -26,21 +28,22 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and a response body. +If successful, this method returns a `204 No Content` response code and a response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/schools//classes/{classId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools/10001/classes/11001 ``` -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + ```http -DELETE https://graph.microsoft.com/beta/education/schools//users/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools/10001/users/13006 ``` -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. ```http -GET https://graph.microsoft.com/beta/education/schools +GET https://graph.microsoft.com/beta/education/schools/10001 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /education/schools//classes +GET /education/schools/{id}/classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/schools//classes +GET https://graph.microsoft.com/beta/education/schools/10002/classes ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -GET /education/schools//users +GET /education/schools/{id}/users ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/schools//users +GET https://graph.microsoft.com/beta/education/schools/10002/users ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -POST /education/schools//classes/$ref +POST /education/schools/{id}/classes/$ref ``` ## Request headers | Header | Value | @@ -23,31 +25,34 @@ POST /education/schools//classes/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. +In the request body, supply a JSON representation of an [educationClass](../resources/educationclass.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST https://graph.microsoft.com/beta/education/schools//classes/$ref +POST https://graph.microsoft.com/beta/education/schools/10002/classes/$ref Content-type: application/json Content-length: 224 { - "@odata.id":"https://graph.microsoft.com/beta/education/classes/{classId}" +� "@odata.id":"https://graph.microsoft.com/beta/education/classes/11006"� } ``` -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + + + ```http -POST /education/schools//users/$ref +POST /education/schools/{id}/users/$ref ``` ## Request headers | Header | Value | @@ -23,15 +25,15 @@ POST /education/schools//users/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ```http -PATCH /education/schools/ +PATCH /education/schools/{id} ``` ## Request headers | Header | Value | @@ -23,7 +25,7 @@ PATCH /education/schools/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| @@ -42,26 +44,29 @@ In the request body, supply the values for relevant fields that should be update |createdBy|[identitySet](identityset.md)|Entity who created the school.| ## Response -If successful, this method returns a `200 OK` response code and updated [educationSchool](../resources/educationschool.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationSchool](../resources/educationschool.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -PATCH https://graph.microsoft.com/beta/education/schools/ +PATCH https://graph.microsoft.com/beta/education/schools/10002 Content-type: application/json Content-length: 292 { - "displayName": "String", - "description": "String", + "displayName": "Fabrikam Arts High School", + "description": "Magnate school for the arts. Los Angeles School District", } ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Rostering/api/educationuser_delete.md b/EDUGraphAPIs/Rostering/api/educationuser_delete.md index 2b256ac0..12b67741 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_delete.md @@ -1,7 +1,10 @@ # Delete educationUser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a user. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +17,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/users/ +DELETE /education/users/{id} ``` ## Request headers | Header | Value | @@ -26,7 +29,7 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request @@ -36,10 +39,10 @@ Here is an example of the request. "name": "delete_educationuser" }--> ```http -DELETE https://graph.microsoft.com/beta/education/users/ +DELETE https://graph.microsoft.com/beta/education/users/13019 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. ```http GET /education/me -GET /education/users/ +GET /education/users/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,19 +29,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET https://graph.microsoft.com/beta/education/users/ +GET https://graph.microsoft.com/beta/education/users/13012 ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -15,7 +19,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/classes -GET /education/users//classes +GET /education/users/{id}/classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -28,10 +32,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http GET /education/me/schools -GET /education/users//schools +GET /education/users/{id}/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +32,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSchool](../resources/educationschool.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSchool](../resources/educationschool.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http PATCH /education/me -PATCH /education/users/ +PATCH /education/users/{id} ``` ## Request headers | Header | Value | @@ -23,7 +25,7 @@ PATCH /education/users/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| @@ -52,15 +54,15 @@ Here is an example of the request. "name": "update_educationuser" }--> ```http -PATCH https://graph.microsoft.com/beta/education/users/ +PATCH https://graph.microsoft.com/beta/education/users/13020 Content-type: application/json Content-length: 508 { - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", + "displayName": "Rogelio Cazares", + "givenName": "Rogelio", + "middleName": "Fernando", + "surname": "Cazares", } ``` ##### Response @@ -76,20 +78,39 @@ Content-type: application/json Content-length: 508 { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, + "id": "13020", + "displayName": "Rogelio Cazares", + "givenName": "Rogelio", + "middleName": "Fernando", + "surname": "Cazares", + "mail": "rogelioC@contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + }, + "externalSource": "sis", + "mailingAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "student": {"@odata.type": "microsoft.graph.educationStudent"}, - "teacher": {"@odata.type": "microsoft.graph.educationTeacher"} + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "student": { + "primaryRole": "student", + "externalId": "13005", + "birthDate": "2001-01-01T00:00:00Z" + } } ``` diff --git a/EDUGraphAPIs/Rostering/resources/educationclass.md b/EDUGraphAPIs/Rostering/resources/educationclass.md index d6828f59..8ad26fe9 100644 --- a/EDUGraphAPIs/Rostering/resources/educationclass.md +++ b/EDUGraphAPIs/Rostering/resources/educationclass.md @@ -1,39 +1,39 @@ # educationClass resource type -Represents a class within a school. educationClass corresponds one-to-one with Office Group and shares the same id. -Students are modeled as regular members of the class, while teachers are modeled as owners and have appropriate rights. -For correct operation of Office experiences, teachers must be members of both the teachers and members collections. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +Represents a class within a school. The **educationClass** resource corresponds to the Office 365 group and shares the same ID. Students are regular members of the class, and teachers are owners and have appropriate rights. For Office experiences to work correctly, teachers must be members of both the teachers and members collections. ## Methods | Method | Return Type |Description| |:---------------|:--------|:----------| -|[Get educationClass](../api/educationclass_get.md) | [educationClass](educationclass.md) |Read properties and relationships of educationClass object.| -|[Add member](../api/educationclass_post_members.md) |[educationUser](educationuser.md)| Add a new educationUser for the class by posting to the members navigation property.| -|[List members](../api/educationclass_list_members.md) |[educationUser](educationuser.md) collection| Get a educationUser object collection.| -|[Remove member](../api/educationclass_delete_members.md) |[educationUser](educationuser.md)| Remove an educationUser from the class through the members navigation property.| -|[List schools](../api/educationclass_list_schools.md) |[educationSchool](educationschool.md) collection| Get a educationSchool object collection.| -|[Add teacher](../api/educationclass_post_teachers.md) |[educationUser](educationuser.md)| Add a new educationUser for the class by posting to the teachers navigation property.| +|[Get educationClass](../api/educationclass_get.md) | [educationClass](educationclass.md) |Read properties and relationships of an **educationClass** object.| +|[Add member](../api/educationclass_post_members.md) |[educationUser](educationuser.md)| Add a new **educationUser** for the class by posting to the members navigation property.| +|[List members](../api/educationclass_list_members.md) |[educationUser](educationuser.md) collection| Get an **educationUser** object collection.| +|[Remove student](../api/educationclass_delete_members.md) |[educationUser](educationuser.md)| Remove an **educationUser** from the class through the members navigation property.| +|[List schools](../api/educationclass_list_schools.md) |[educationSchool](educationschool.md) collection| Get an **educationSchool** object collection.| +|[Add teacher](../api/educationclass_post_teachers.md) |[educationUser](educationuser.md)| Add a new **educationUser** for the class by posting to the teachers navigation property.| |[List teachers](../api/educationclass_list_teachers.md) |[educationUser](educationuser.md) collection| Get a list of teachers for the class.| -|[Remove teacher](../api/educationclass_delete_teachers.md) |[educationUser](educationuser.md)| Remove an educationUser from the class through the teachers navigation property.| -|[Create educationAssignment](../../Assignments/api/educationclass_post_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md)| Create a new educationAssignment by posting to the assignments collection.| -|[List assignments](../../Assignments/api/educationclass_list_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md) collection| Get a educationAssignment object collection.| -|[Update](../api/educationclass_update.md) | [educationClass](educationclass.md) |Update educationClass object. | -|[Delete](../api/educationclass_delete.md) | None |Delete educationClass object. | +|[Remove teacher](../api/educationclass_delete_teachers.md) |[educationUser](educationuser.md)| Remove an **educationUser** from the class through the teachers navigation property.| +|[Create educationAssignment](../../Assignments/api/educationclass_post_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md)| Create a new **educationAssignment** by posting to the assignments collection.| +|[List assignments](../../Assignments/api/educationclass_list_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md) collection| Get an **educationAssignment** object collection.| +|[Update](../api/educationclass_update.md) | [educationClass](educationclass.md) |Update **educationClass** object. | +|[Delete](../api/educationclass_delete.md) | None |Delete **educationClass** object. | ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|id| String| Unique identifier for the class| -|description|String| Description of the class| -|displayName|String| Name of the class| +|id| String| Unique identifier for the class.| +|description|String| Description of the class.| +|displayName|String| Name of the class.| |mailNickname|String| Mail name for sending email to all members, if this is enabled. | |createdBy|[identitySet](identityset.md)| Entity who created the class | -|classCode|String| Class Code used by the school to identify the class.| +|classCode|String| Class code used by the school to identify the class.| |externalId|String| ID of the class from the syncing system. | |externalName|String|Name of the class in the syncing system.| -|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `unknownFutureValue`.| +|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `unknownFutureValue`.| |term|[educationTerm](educationterm.md)|Term for this class.| @@ -41,13 +41,13 @@ For correct operation of Office experiences, teachers must be members of both th | Relationship | Type |Description| |:---------------|:--------|:----------| |members|[educationUser](educationuser.md) collection| All users in the class. Nullable.| -|schools|[educationSchool](educationschool.md) collection| All schools this class is associated with. Nullable.| -|teachers|[educationUser](educationuser.md) collection| All teachers in the class. Nullable.| +|schools|[educationSchool](educationschool.md) collection| All schools that this class is associated with. Nullable.| +|teachers|[educationUser](educationuser.md) collection| All teachers in the class. Nullable.| |assignments|[educationAssignment](../../Assignments/resources/educationassignment.md) collection| All assignments associated with this class. Nullable.| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Rostering/resources/educationorganization.md b/EDUGraphAPIs/Rostering/resources/educationorganization.md index cb1acf78..7eb6b906 100644 --- a/EDUGraphAPIs/Rostering/resources/educationorganization.md +++ b/EDUGraphAPIs/Rostering/resources/educationorganization.md @@ -1,5 +1,6 @@ # educationOrganization resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. Abstract entity used to model the commonality between different organization types within the education sector. @@ -8,15 +9,15 @@ Abstract entity used to model the commonality between different organization typ |:---------------|:--------|:----------| |description|String| Organization description.| |displayName|String| Organization display name.| -|externalSource|string| Source where this organization was created from. Possible values are: `sis`, `manual`, `unknownFutureValue`.| +|externalSource|string| Source where this organization was created from. Possible values are: `sis`, `manual`, `unknownFutureValue`.| ## Relationships -None +None. ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Rostering/resources/educationstudent.md b/EDUGraphAPIs/Rostering/resources/educationstudent.md index b35781ba..664c208e 100644 --- a/EDUGraphAPIs/Rostering/resources/educationstudent.md +++ b/EDUGraphAPIs/Rostering/resources/educationstudent.md @@ -1,21 +1,22 @@ # educationStudent resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. -Additional information added to an [educationUser](educationuser.md) which is present when the primaryRole of a user is `student`. +Additional information added to an [educationUser](educationuser.md) that is present when the primaryRole of a user is `student`. ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|birthDate|Date| Birthdate of the student.| +|birthDate|Date| Birth date of the student.| |externalId|String| ID of the student in the source system.| |gender|`educationGender enumeration`| Possible values are: `female`, `male`, `other`, `unkownFutureValue`.| |grade|String|Current grade level of the student.| -|graduationYear|String| Year the child is graduating from the school.| +|graduationYear|String| Year the student is graduating from the school.| |studentNumber|String| Student Number.| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/api_overview.md b/EDUGraphAPIs/api_overview.md deleted file mode 100644 index 0a45eded..00000000 --- a/EDUGraphAPIs/api_overview.md +++ /dev/null @@ -1,84 +0,0 @@ -# Working with Edu assignments and rostering in Microsoft Graph - - -**Microsoft Graph Education Endpoint is available for private preview : -https://graph.microsoft.com/beta/education/** - -The **Microsoft Graph API** is a valuable tool that gives developers access to Office 365 resources through one REST endpoint and one access token. This is done by accessing the Graph through a set of URLs like the following examples: - - https://graph.microsost.com//users - https://graph.microsost.com//groups - https://graph.microsoft.com//me/calendars - -While these **Office 365** resources are powerful and useful inside an educational institution that uses **Office 365**, the Education endpoint in Microsoft Graph also decorates **Office 365** graph data with education related information such as students, teachers, and classes. This makes it easier for ISV Office developers to integrate with educational resources. - -In addition, the Education endpoint also introduces two new education specific resources. **Rostering** and **Assignments** make it easy to interact with the assignment and rostering services within Microsoft Teams for Education. - -The **Microsoft graph education** namespace allows developers access to schools, students, teachers, classes, enrollments, and **Assignments**. - -## Authorization - -Read about the API permissions needed for the assignment API in the Assignments API [Getting started](./Assignments/GettingStarted.md) article. The API permissions needed for the rostering API are described in the Rostering API [Getting started](./Rostering/GettingStarted.md) article. - -For more information about permissions, including delegated and application permissions, see [Permissions](../../../concepts/permissions_reference.md). - -## Common use cases - -The core use cases for the Microsoft Education Graph API include automating student assignments and managing a school roster. - -### Assignments APIs - -Microsoft Graph **Assignments** Resources allow partners to integrate with the **Assignments** service under the Microsoft Teams in **Office 365** for Education tab of the same name. The Public API is the same API that _Microsoft Teams in Office 365 for Education_ built it's user interface with. Thus, the best sample of what can be built with the Microsoft **Assignments** API is _Microsoft Teams in Office 365 for Education_. - - -#### 'Assignments' resource description - -An [Assignment](./Assignments/resources/educationassignmentresource.md) is a task or unit of work assigned to a student or team member in a class as part of their study. Only teachers or team owners can create assignments. Assignments contain handouts and tasks that the teacher wants the student to work on. Each student assignment has an associated [submission](./Assignments/resources/educationsubmissionresource.md) that contains any work their teacher asked to be turned in. A teacher can add scores and feedback to the submission turned in by the student. - - -#### Sample scenarios -As mentioned above the **Assignments** APIs allow partners to interact with the assignment Services. Here are some sample scenarios: - -1. Create Assignment - An external system can create assignment for the class and attach resources to the assignment. - -2. Read assignment information - An analytics application can get information about assignments and student submissions including dates and grades. - -3. Dashboard to track student submissions - A Teacher dashboard that shows how many Submissions have been submitted and how many need to be graded. - -These are just a few examples. The assignment APIs provide a mechanism for external applications to interact with the life-cycle of the assignment. - - - -### Rostering APIs - -Rostering APIs in the **Microsoft Graph Education endpoint** are used to extract data from the school's **Office 365** tenant which has been synced to the cloud by Microsoft School Data Sync. These results provide information about schools, sections, teachers, students, and rosters. These APIs while functionally similar to the current Roster APIs, provide first class access to the roster data. The APIs provide both app-only APIs primarily for sync-centric scenarios and app+user APIs designed for interactive scenarios. The app+user APIs will enforce region-appropriate RBAC policies based on the user role calling the API. This will provide a consistent API and minimal policy surface regardless of administrative configuration within tenants. In addition, the APIs also provide EDU specific scopes to ensure the right user has access to the data. - -#### Rostering resources description -The typical scenario for Rostering APIs to enable the user logged into a 3rd party ISV app to know: -- Who I am -- What classes I attend or teach -- What I need to do / by when - -The Rostering APIs support this by providing APIs to support the following scenarios: - -- get Roster -- get Schools -- get Classes -- get Teachers/Students -- get My Schools/Classes - - - - - - -## Next steps -Use your new understanding of the Microsoft Graph Education API to build education solutions around student assignments and school rosters. - -### Getting started with assignments API -Read [Microsoft Education Graph Assignments API : Getting Started](./Assignments/GettingStarted.md) to get started with **Assignments** API including learning about Scopes, assignment Resources, APIs, Samples, and Building your first sample. - - -### Getting started with Rostering API -Read [Microsoft Education Graph Rostering API : Getting Started](./Rostering/GettingStarted.md) to get started with Rostering API including learning about Scopes, Roster Resources , APIs, Samples and Building your first sample. - diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md new file mode 100644 index 00000000..67d6b69a --- /dev/null +++ b/EDUGraphAPIs/education-overview.md @@ -0,0 +1,123 @@ +# Working with education APIs in Microsoft Graph + +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + +The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. + +The education APIs include rostering resources and assignments resources that you can use to interact with the rostering and assignment services in Microsoft Teams. You can use these resources to manage a school roster and automate student assignments. + +## Authorization + +To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview). Your app will also need the appropriate permissions. For more information, see [Education permissions](EDUGraphAPIs/permissions_reference.md#education-permissions). + +### App permissions to enable school IT admins to consent + +To deploy apps that are integrated with the Education APIs in Microsoft Graph, school IT admins must first grant consent to the permissions requested by the app. This consent has to be granted only once, unless the permissions change. After the admin consents, the app is provisioned for all users in the tenant. + +To trigger a consent dialog box, use the following REST call. + +``` +GET https://login.microsoftonline.com/{tenant}/adminconsent? +client_id={clientId}&state=12345&redirect_uri={redirectUrl} +``` + +|Parameter|Description| +|:--------|:----------| +|Tenant|Tenant ID of the school. Use the full ID, which includes onmicrosoft.com.| +|clientId|Client ID of the app.| +|redirectUrl|App redirect URL.| + + +## Rostering + +The rostering APIs enable you to extract data from a school's Office 365 tenant provisioned with [Microsoft School Data Sync](https://sds.microsoft.com/). These APIs provide access to information about schools, sections, teachers, students, and rosters. The APIs support both app-only (sync) scenarios, and app + user (interactive) scenarios. The APIs that support interactive scenarios enforce region-appropriate RBAC policies based on the user role calling the API. This provides a consistent API and minimal policy surface, regardless of the administrative configuration within tenants. In addition, the APIs also provide education-specific permissions to ensure that the right user has access to the data. + +You can use the rostering APIs to enable an app user to know: + +- Who I am +- What classes I attend or teach +- What I need to do and by when + +The rostering APIs provide the following key resources: + +- [educationSchool](Rostering/resources/educationschool.md) - Represents the school. +- [educationClass](Rostering/resources/educationclass.md) - Represents a class within a school. +- [educationTerm](Rostering/resources/educationterm.md) - Represents a designated portion of the academic year. +- [educationTeacher](Rostering/resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. +- [educationStudent](Rostering/resources/educationstudent.md) - Represents a users with the primary role of 'student'. + +The rostering APIs support the following scenarios: + + + +- [List all schools](Rostering/api/educationroot_list_schools.md) +- [List schools in which a class is taught](Rostering/api/educationclass_list_schools.md) +- [List schools for a user](Rostering/api/educationuser_list_schools.md) +- [Get all classes](Rostering/api/educationroot_list_classes.md ) +- [Get classes in a school](Rostering/api/educationschool_list_classes.md) +- [List classes for a user](Rostering/api/educationuser_list_classes.md) +- [Add classes to a school](Rostering/api/educationschool_post_classes.md) +- [Get students and teachers for a class](Rostering/api/educationclass_list_members.md) +- [Add members to a class](Rostering/api/educationclass_post_members.md) +- [List teachers for a class](Rostering/api/educationclass_list_teachers.md) +- [Get users in a school](Rostering/api/educationschool_list_users.md) + + + +## Assignments + +You can use the assignment-related education APIs to integrate with assignments in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. + + + +The assignment APIs provide the following key resources: + +- [educationAssignment](Assignments/resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. +- [educationSubmission](Assignments/resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. +- [educationResource](Assignments/resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. + +The assignment APIs support the following scenarios: + +- [Create assignment](Assignments/api/educationclass_post_assignments.md) +- [Publish assignment](Assignments/api/educationassignment_publish.md) +- [Create assignment resource](Assignments/api/educationassignment_post_resources.md) +- [Create submission resource](Assignments/api/educationsubmission_post_resources.md) +- [Submit assignment](Assignments/api/educationsubmission_submit.md) +- [Release grades to student](Assignments/api/educationsubmission_release.md) +- [Get assignment details](Assignments/api/educationuser_list_assignments.md) + +The following are some common use cases for the assignment-related education APIs. + +|Use case|Description|See also| +|:-------|:----------|:-------| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](Assignments/api/educationassignment_post_resources.md)| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](Assignments/api/educationassignment_get.md)| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](Assignments/resources/educationsubmission.md)| + + +## Next steps +Use the Microsoft Graph education APIs to build education solutions that access student assignments and school rosters. To learn more: + +- Explore the resources and methods that are most helpful to your scenario. +- Try the API in the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer). + diff --git a/EDUGraphAPIs/permissions_reference.md b/EDUGraphAPIs/permissions_reference.md new file mode 100644 index 00000000..8e6618a3 --- /dev/null +++ b/EDUGraphAPIs/permissions_reference.md @@ -0,0 +1,844 @@ +# Microsoft Graph permissions reference +Microsoft Graph exposes granular permissions that control the access that apps have to resources, like users, groups, and mail. As a developer, you decide which permissions for Microsoft Graph your app requests. When a user signs in to your app they, or, in some cases, an administrator, are given a chance to consent to these permissions. If the user consents, your app is given access to the resources and APIs that it has requested. For apps that don't take a signed-in user, permissions can be pre-consented to by an administrator when the app is installed or during sign-up. + +## Delegated permissions, Application permissions, and effective permissions +Microsoft Graph has two types of permissions: **delegated permissions** and **application permissions**. + +- **Delegated permissions** are used by apps that have a signed-in user present. For these apps either the user or an administrator consents to the permissions that the app requests and the app is delegated permission to act as the signed-in user when making calls to Microsoft Graph. Some delegated permissions can be consented to by non-administrative users, but some higher-privileged permissions require [administrator consent](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-scopes#admin-restricted-scopes). + +- **Application permissions** are used by apps that run without a signed-in user present; for example, apps that run as background services or daemons. Application permissions can only be [consented by an administrator](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-scopes#requesting-consent-for-an-entire-tenant). + +_Effective permissions_ are the permissions that your app will have when making requests to Microsoft Graph. It is important to understand the difference between the delegated and application permissions that your app is granted and its effective permissions when making calls to Microsoft Graph. + +- For delegated permissions, the _effective permissions_ of your app will be the least privileged intersection of the delegated permissions the app has been granted (via consent) and the privileges of the currently signed-in user. Your app can never have more privileges than the signed-in user. Within organizations, the privileges of the signed-in user may be determined by policy or by membership in one or more administrator roles. For more information about administrator roles, see [Assigning administrator roles in Azure Active Directory](https://docs.microsoft.com/en-us/azure/active-directory/active-directory-assign-admin-roles).

For example, assume your app has been granted the _User.ReadWrite.All_ delegated permission. This permission nominally grants your app permission to read and update the profile of every user in an organization. If the signed-in user is a global administrator, your app will be able to update the profile of every user in the organization. However, if the signed-in user is not in an administrator role, your app will be able to update only the profile of the signed-in user. It will not be able to update the profiles of other users in the organization because the user that it has permission to act on behalf of does not have those privileges. + +- For application permissions, the _effective permissions_ of your app will be the full level of privileges implied by the permission. For example, an app that has the _User.ReadWrite.All_ application permission can update the profile of every user in the organization. + +### Microsoft Graph permission names +Microsoft Graph permission names follow a simple pattern: _resource.operation.constraint_. For example, _User.Read_ grants permission to read the profile of the signed-in user, _User.ReadWrite_ grants permission to read and modify the profile of the signed-in user, and _Mail.Send_ grants permission to send mail on behalf of the signed-in user. + +The _constraint_ element of the name determines the potential extent of access your app will have within the directory. Currently Microsoft Graph supports the following constraints: + +* **All** grants permission for the app to perform the operations on all of the resources of the specified type in a directory. For example, _User.Read.All_ potentially grants the app privileges to read the profiles of all of the users in a directory. +* **Shared** grants permission for the app to perform the operations on resources that other users have shared with the signed-in user. This constraint is mainly used with Outlook resources like mail, calendars, and contacts. For example, _Mail.Read.Shared_, grants privileges to read mail in the mailbox of the signed-in user as well as mail in mailboxes that other users in the organization have shared with the signed-in user. +* **AppFolder** grants permission for the app to read and write files in a dedicated folder in OneDrive. This constraint is only exposed on [Files permissions](#files-permissions) and is only valid for Microsoft accounts. +* If **no constraint** is specified the app is limited to performing the operations on the resources owned by the signed-in user. For example, _User.Read_ grants privileges to read the profile of the signed-in user only, and _Mail.Read_ grants permission to read only mail in the mailbox of the signed-in user. + +> **Note**: In delegated scenarios, the effective permissions granted to your app may be constrained by the privileges of the signed-in user in the organization. + +### Microsoft accounts and work or school accounts + +Not all permissions are valid for both Microsoft accounts and work or school accounts. You can check **Remarks** for each permission group to determine whether a specific permission is valid for Microsoft accounts, work or school accounts, or both. + +### User and group search limitations for guest users in organizations + +User and group search capabilities allow the app to search for any user or group in an organization's directory by performing queries against the `/users` or `/groups` resource set (for example, `https://graph.microsoft.com/v1.0/users`). Both administrators and users have this capability; however, guest users do not. + +If the signed-in user is a guest user, depending on the permissions an app has been granted, it can read the profile of a specific user or group (for example, `https://graph.microsoft.com/v1.0/users/241f22af-f634-44c0-9a15-c8cd2cea5531`); however, it cannot perform queries against the `/users` or `/groups` resource set that potentially return more than a single resource. + +With the appropriate permissions, the app can read the profiles of users or groups that it obtains by following links in navigation properties; for example, `/users/{id}/directReports` or `/groups/{id}/members`. + + +## Calendars permissions + +#### Delegated permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Calendars.Read_ |Read user calendars |Allows the app to read events in user calendars. |No | +| _Calendars.Read.Shared_ |Read user and shared calendars |Allows the app to read events in all calendars that the user can access, including delegate and shared calendars. |No | +| _Calendars.ReadWrite_ |Have full access to user calendars |Allows the app to create, read, update, and delete events in user calendars. |No | +| _Calendars.ReadWrite.Shared_ |Read and write user and shared calendars |Allows the app to create, read, update and delete events in all calendars the user has permissions to access. This includes delegate and shared calendars.|No | + +
+ +#### Application permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +|_Calendars.Read_ |Read calendars in all mailboxes |Allows the app to read events of all calendars without a signed-in user. |Yes | +|_Calendars.ReadWrite_ |Read and write calendars in all mailboxes |Allows the app to create, read, update, and delete events of all calendars without a signed-in user. |Yes | + +
+ +### Remarks + +_Calendars.Read.Shared_ and _Calendars.ReadWrite.Shared_ are only valid for work or school accounts. All other permissions are valid for both Microsoft accounts and work or school accounts. + +### Example usage + +#### Delegated + +* _Calendars.Read_: Get events on the user's calendar between April 23, 2017 and April 29, 2017 (`GET /me/calendarView?startDateTime=2017-04-23T00:00:00&endDateTime=2017-04-29T00:00:00`). +* _Calendars.Read.Shared_: Find meeting times where all attendees are available (`POST /users/{id|userPrincipalName}/findMeetingTimes`). +* _Calendars.ReadWrite_: Add an event to the user's calendar (`POST /me/events`). + +#### Application + +* _Calendars.Read_: Find events in a conference room's calendar organized by bob@contoso.com (`GET /users/{id | userPrincipalName}/events?$filter=organizer/emailAddress/address eq 'bob@contoso.com'`). +* _Calendars.Read_: List all events on a user's calendar for the month of May (`GET /users/{id | userPrincipalName}/calendarView?startDateTime=2017-05-01T00:00:00&endDateTime=2017-06-01T00:00:00`) +* _Calendars.ReadWrite_: Add an event to a user's calendar for approved time off (`POST /users/{id | userPrincipalName}/events`). +* _Calendars.Send_: Send a message (`POST /users/{id | userPrincipalName}/sendCalendars`). + + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Contacts permissions + +#### Delegated permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +|_Contacts.Read_ |Read user contacts  |Allows the app to read user contacts. |No | +|_Contacts.Read.Shared_ |Read user and shared contacts |Allows the app to read contacts that the user has permissions to access, including the user's own and shared contacts. |No | +|_Contacts.ReadWrite_ |Have full access to user contacts |Allows the app to create, read, update, and delete user contacts. |No | +|_Contacts.ReadWrite.Shared_ |Read and write user and shared contacts |Allows the app to create, read, update and delete contacts that the user has permissions to, including the user's own and shared contacts. |No | + +#### Application permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +|_Contacts.Read_ |Read contacts in all mailboxes |Allows the app to read all contacts in all mailboxes without a signed-in user. |Yes | +|_Contacts.ReadWrite_ |Read and write contacts in all mailboxes |Allows the app to create, read, update, and delete all contacts in all mailboxes without a signed-in user. |Yes | + +### Remarks +Only the _Contacts.Read_ and _Contacts.ReadWrite_ delegated permissions are valid for Microsoft accounts. + +### Example usage +#### Delegated + +* _Contacts.Read_: Read a contact from one of the top-level contact folders of the signed-in user (`GET /me/contactfolders/{Id}/contacts/{id}`). +* _Contacts.ReadWrite_: Update the contact photo of one of the signed-in user's contacts (`PUT /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value`). +* _Contacts.ReadWrite_: Add contacts to the root folder of the signed-in user (`POST /me/contacts`). + +#### Application + +* _Contacts.Read_: Read contacts from one of the top-level contact folders of any user in the organization (`GET /users/{id | userPrincipalName}/contactfolders/{Id}/contacts/{id}`). +* _Contacts.ReadWrite_: Update the photo for any contact of any user in an organization (`PUT /user/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value`). +* _Contacts.ReadWrite_: Add contacts to the root folder of any user in the organization (`POST /users/{id | userPrincipalName}/contacts`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Device permissions + +#### Delegated permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +|_Device.Read_ |Read user devices |Allows the app to read a user's list of devices on behalf of the signed-in user. |No | +|_Device.Command_ |Communicate with user devices |Allows the app to launch another app or communicate with another app on a user's device on behalf of the signed-in user. |No | + + +#### Application permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +|_Device.ReadWrite.All_ |Read and write devices |Allows the app to read and write all device properties without a signed in user. Does not allow device creation, device deletion, or update of device alternative security identifiers. |Yes | + +### Remarks + +The _Device.Read_ and _Device.Command_ delegated permissions are valid only for personal Microsoft accounts. + +### Example usage + +#### Application + +* _Device.ReadWrite.All_: Read all registered devices in the organization (`GET /devices`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Intune Device Management permissions + +#### Delegated permissions + +|Permission |Display String |Description |Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +|_DeviceManagementApps.Read.All_ | Read Microsoft Intune apps | Allows the app to read the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune. | Yes | +|_DeviceManagementApps.ReadWrite.All_ | Read and write Microsoft Intune apps | Allows the app to read and write the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune. | Yes | +|_DeviceManagementConfiguration.Read.All_ | Read Microsoft Intune device configuration and policies | Allows the app to read properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups. | Yes | +|_DeviceManagementConfiguration.ReadWrite.All_ | Read and write Microsoft Intune device configuration and policies | Allows the app to read and write properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups. | Yes | +|_DeviceManagementManagedDevices.PrivilegedOperations.All_ | Perform user-impacting remote actions on Microsoft Intune devices | Allows the app to perform remote high impact actions such as wiping the device or resetting the passcode on devices managed by Microsoft Intune. | Yes | +|_DeviceManagementManagedDevices.Read.All_ | Read Microsoft Intune devices | Allows the app to read the properties of devices managed by Microsoft Intune. | Yes | +|_DeviceManagementManagedDevices.ReadWrite.All_ | Read and write Microsoft Intune devices | Allows the app to read and write the properties of devices managed by Microsoft Intune. Does not allow high impact operations such as remote wipe and password reset on the device’s owner. | Yes | +|_DeviceManagementRBAC.Read.All_ | Read Microsoft Intune RBAC settings | Allows the app to read the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings. | Yes | +|_DeviceManagementRBAC.ReadWrite.All_ | Read and write Microsoft Intune RBAC settings | Allows the app to read and write the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings. | Yes | +|_DeviceManagementServiceConfig.Read.All_ | Read Microsoft Intune configuration | Allows the app to read Intune service properties including device enrollment and third party service connection configuration. | Yes | +|_DeviceManagementServiceConfig.ReadWrite.All_ | Read and write Microsoft Intune configuration | Allows the app to read and write Microsoft Intune service properties including device enrollment and third party service connection configuration. | Yes | + +#### Application permissions + +None. + +### Remarks + +> **Note:** Using the Microsoft Graph APIs to configure Intune controls and policies still requires that the Intune service is [correctly licensed](https://go.microsoft.com/fwlink/?linkid=839381) by the customer. + +These permissions are only valid for work or school accounts. + +### Example usage + +#### Application + +* _DeviceManagementServiceConfiguration.Read.All_: Check the current state of the Intune subscription (`GET /deviceManagement/subscriptionState`). +* _DeviceManagementServiceConfiguration.ReadWrite.All_: Create new Terms and Conditions (`POST /deviceManagement/termsAndConditions`). +* _DeviceManagementConfiguration.Read.All_: Find the status of a device configuration (`GET /deviceManagement/deviceConfigurations/{id}/deviceStatuses`). +* _DeviceManagementConfiguration.ReadWrite.All_: Assign a device compliance policy to a group (`POST deviceCompliancePolicies/{id}/assign`). +* _DeviceManagementApps.Read.All_: Find all the Windows Store apps published to Intune (`GET /deviceAppManagement/mobileApps?$filter=isOf('microsoft.graph.windowsStoreApp')`). +* _DeviceManagementApps.ReadWrite.All_: Publish a new application (`POST /deviceAppManagement/mobileApps`). +* _DeviceManagementRBAC.Read.All_: Find a role assignment by name (`GET /deviceManagement/roleAssignments?$filter=displayName eq 'My Role Assignment'`). +* _DeviceManagementRBAC.ReadWrite.All_: Create a new custom role (`POST /deviceManagement/roleDefinitions`). +* _DeviceManagementManagedDevices.Read.All_: Find a managed device by name (`GET /managedDevices/?$filter=deviceName eq 'My Device'`). +* _DeviceManagementManagedDevices.ReadWrite.All_: Remove a managed device (`DELETE /managedDevices/{id}`). +* _DeviceManagementManagedDevices.PrivilegedOperations.All_: Reset the passcode on a user's managed device (`POST /managedDevices/{id}/resetPasscode`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Directory permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Directory.Read.All_ |Read directory data | Allows the app to read data in your organization's directory, such as users, groups and apps. | Yes | +| _Directory.ReadWrite.All_ |Read and write directory data | Allows the app to read and write data in your organization's directory, such as users, and groups. It does not allow the app to delete users or groups, or reset user passwords. | Yes | +| _Directory.AccessAsUser.All_ |Access directory as the signed-in user | Allows the app to have the same access to information in the directory as the signed-in user. | Yes | + +
+ +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Directory.Read.All_ | Read directory data | Allows the app to read data in your organization's directory, such as users, groups and apps, without a signed-in user. | Yes | +| _Directory.ReadWrite.All_ | Read and write directory data | Allows the app to read and write data in your organization's directory, such as users, and groups, without a signed-in user. Does not allow user or group deletion. | Yes | + +### Remarks +Directory permissions are not supported on Microsoft accounts. + +Directory permissions provide the highest level of privilege for accessing directory resources such as [User](../api-reference/v1.0/resources/user.md), [Group](../api-reference/v1.0/resources/group.md), and [Device](../api-reference/v1.0/resources/device.md) in an organization. + +They also exclusively control access to other directory resources like: [organizational contacts](../api-reference/beta/resources/orgcontact.md), [schema extension APIs](../api-reference/beta/resources/schemaextension.md), [Privileged Identity Management (PIM) APIs](../api-reference/beta/resources/privilegedidentitymanagement_root.md), as well as many of the resources and APIs listed under the **Azure Active Directory** node in the v1.0 and beta API reference documentation. These include administrative units, directory roles, directory settings, policy, and many more. + +The _Directory.ReadWrite.All_ permission grants the following privileges: + +- Full read of all directory resources (both declared properties and navigation properties) +- Create and update users +- Disable and enable users (but not company administrator) +- Set user alternative security id (but not administrators) +- Create and update groups +- Manage group memberships +- Update group owner +- Manage license assignments +- Define schema extensions on applications +- **Note**: No rights to reset user passwords +- **Note**: No rights to delete resources (including users or groups) +- **Note**: Specifically excludes create or update for resources not listed above. This includes: application, oAauth2Permissiongrant, appRoleAssignment, device, servicePrincipal, organization, domains, and so on. + + +### Example usage + +#### Delegated +* _Directory.Read.All_: List all administrative units in an organization (`GET /beta/administrativeUnits`) +* _Directory.ReadWrite.All_: Add members to a directory role (`POST /directoryRoles/{id}/members/$ref`) + +#### Application +* _Directory.Read.All_: List all memberships of a user, including directory roles and administrative units (`GET /beta/users/{id}/memberOf`) +* _Directory.Read.All_: List all group members, including service principals (`GET /beta/groups/{id}/members`) +* _Directory.ReadWrite.All_: Add an owner to a group (`POST /groups/{id}/owners/$ref`) + + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## Education permissions + +#### Delegated permissions + +|Permission |Display String |Description | Admin Consent Required | +|:--------- |:------------- |:---------- | :--------------------- | +|EduAssignments.ReadBasic | Read users' class assignments without grades | Allows the app to read assignments without grades on behalf of the user | Yes | +|EduAssignments.ReadWriteBasic | Read and write users' class assignments without grades | Allows the app to read and write assignments without grades on behalf of the user | Yes | +|EduAssignments.Read | Read users' view of class assignments and their grades | Allows the app to read assignments and their grades on behalf of the user| Yes | +|EduAssignments.ReadWrite | Read and write users' view of class assignments and their grades | Allows the app to read and write assignments and their grades on behalf of the user|Yes | +|EduRostering.ReadBasic| Read a limited subset of users' view of the roster | Allows the app to read a limited subset of the data from the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user. | Yes | + + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +| :--------- | :------------- | :---------- | :--------------------- | +|EduAssignments.ReadBasic.All| Read class assignments without grades|Allows the app to read assignments without grades for all users| Yes | +|EduAssignments.ReadWriteBasic.All | Read and write class assignments without grades | Allows the app to read and write assignments without grades for all users| Yes | +|EduAssignments.Read.All| Read class assignments with grades | Allows the app to read assignments and their grades for all users | Yes | +|EduAssignments.ReadWrite.All | Read and write class assignments with grades | Allows the app to read and write assignments and their grades for all users | Yes | +|EduRostering.ReadBasic.All | Read a limited subset of the organization's roster. | Allows the app to read a limited subset of both the structure of schools and classes in an organization's roster and education-specific information about all users. | Yes | +|EduRostering.Read.All | Read the organization's roster. | Allows the app to read the structure of schools and classes in the organization's roster and education-specific information about all users to be read. | Yes | +|EduRostering.ReadWrite.All| Read and write the organization's roster. | Allows the app to read and write the structure of schools and classes in the organization's roster and education-specific information about all users to be read and written. | Yes | + +### Example usage + +#### Delegated + +* _EduAssignments.Read_: Get the signed-in student's assignment information (`GET /education/classes//assignments/`) +* _EduAssignments.ReadWriteBasic_: Submit signed-in student assignment (`GET /education/classes//assignments/submit`) +* _EduRoster.ReadBasic_: Classes a signed-in user attends or teaches (`GET /education/classes//members`) + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +## Files permissions + +#### Delegated permissions + +|Permission |Display String |Description | Admin Consent Required | +|:--------- |:------------- |:---------- | :--------------------- | +| _Files.Read_ | Read user files | Allows the app to read the signed-in user's files. | No | +| _Files.Read.All_ | Read all files that user can access | Allows the app to read all files the signed-in user can access. | No | +| _Files.ReadWrite_ | Have full access to user files | Allows the app to read, create, update, and delete the signed-in user's files. | No| +| _Files.ReadWrite.All_ | Have full access to all files user can access | Allows the app to read, create, update, and delete all files the signed-in user can access. | No | +| _Files.ReadWrite.AppFolder_ | Have full access to the application's folder (preview) | (Preview) Allows the app to read, create, update, and delete files in the application's folder. | No | +| _Files.Read.Selected_ | Read files that the user selects | **Limited support in Microsoft Graph; see Remarks**
(Preview) Allows the app to read files that the user selects. The app has access for several hours after the user selects a file. | No | +| _Files.ReadWrite.Selected_ | Read and write files that the user selects | **Limited support in Microsoft Graph; see Remarks**
(Preview) Allows the app to read and write files that the user selects. The app has access for several hours after the user selects a file. | No | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +| :--------- | :------------- | :---------- | :--------------------- | +| _Files.Read.All_ | Read files in all site collections | Allows the app to read all files in all site collections without a signed in user. | Yes | +| _Files.ReadWrite.All_ | Read and write files in all site collections | Allows the app to read, create, update, and delete all files in all site collections without a signed in user. | Yes | + +### Remarks + +The Files.Read, Files.ReadWrite, Files.Read.All, and Files.ReadWrite.All delegated permissions are valid on both personal Microsoft accounts and work or school accounts. +Note that for personal accounts, Files.Read and Files.ReadWrite also grant access to files shared with the signed-in user. + +The Files.Read.Selected and Files.ReadWrite.Selected delegated permissions are only valid on work or school accounts and are only exposed for working with [Office 365 file handlers (v1.0)](https://msdn.microsoft.com/office/office365/howto/using-cross-suite-apps). +They should not be used for directly calling Microsoft Graph APIs. + +The Files.ReadWrite.AppFolder delegated permission is only valid for personal accounts and is used for accessing the [App Root special folder](https://dev.onedrive.com/misc/appfolder.htm) with the OneDrive [Get special folder](../api-reference/v1.0/api/drive_get_specialfolder.md) Microsoft Graph API. + + +### Example usage + +#### Delegated + +* _Files.Read_: Read files stored in the signed-in user's OneDrive (`GET /me/drive/root/children`) +* _Files.Read.All_: Read files shared with the signed-in user (`GET /me/drive/root/sharedWithMe`) +* _Files.ReadWrite_: Write a file in the signed-in user's OneDrive (`PUT /me/drive/root/children/filename.txt/content`) +* _Files.ReadWrite.All_: Write a file shared with the user (`PUT /users/rgregg@contoso.com/drive/root/children/file.txt/content`) +* _Files.ReadWrite.AppFolder_: Write files into the app's folder in OneDrive (`PUT /me/drive/special/approot/children/file.txt/content`) + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Group permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Group.Read.All_ | Read all groups | Allows the app to list groups, and to read their properties and all group memberships on behalf of the signed-in user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. | Yes | +| _Group.ReadWrite.All_ | Read and write all groups| Allows the app to create groups and read all group properties and memberships on behalf of the signed-in user. Additionally allows group owners to manage their groups and allows group members to update group content. | Yes | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Group.Read.All_ | Read all groups | Allows the app to read memberships for all groups without a signed-in user. Note that not all group API supports access using app-only permissions. See [known issues](../concepts/known_issues.md) for examples. | Yes | +| _Group.ReadWrite.All_ | Read and write all groups | Allows the app to create groups, read and update group memberships, and delete groups. All of these operations can be performed by the app without a signed-in user. Note that not all group API supports access using app-only permissions. See [known issues](../concepts/known_issues.md) for examples.| Yes | + + +### Remarks + +Group functionality is not supported on personal Microsoft accounts. + +For Office 365 groups, Group permissions grant the app access to the contents of the group; for example, conversations, files, notes, and so on. + +For application permissions, there are some limitations for the APIs that are supported. For more information, see [known issues](../concepts/known_issues.md). + +In some cases, an app may need [Directory permissions](#directory-permissions) to read some group properties like `member` and `memberOf`. For example, if a group has a one or more [servicePrincipals](../api-reference/beta/resources/serviceprincipal.md) as members, the app will need effective permissions to read service principals through being granted one of the _Directory.\*_ permissions, otherwise Microsoft Graph will return an error. (In the case of delegated permissions, the signed-in user will also need sufficient privileges in the organization to read service principals.) The same guidance applies for the `memberOf` property, which can return [administrativeUnits](../api-reference/beta/resources/administrativeunit.md). + +Group permissions are also used to control access to [Microsoft Planner](../api-reference/beta/resources/planner_overview.md) resources and APIs. Only delegated permissions are supported for Microsoft Planner APIs; application permissions are not supported. Personal Microsoft accounts are not supported. + + +### Example usage +#### Delegated + +* _Group.Read.All_: Read all Office 365 groups that the signed-in user is a member of (`GET /me/memberOf/$/microsoft.graph.group?$filter=groupTypes/any(a:a%20eq%20'unified')`). +* _Group.Read.All_: Read all Office 365 group content like conversations (`GET /groups/{id}/conversations`). +* _Group.ReadWrite.All_: Update group properties, like photo (`PUT /groups/{id}/photo/$value`). +* _Group.ReadWrite.All_: Update group members (`POST /groups/{id}/members/$ref`). NOTE: This also requires _User.ReadBasic.All_ to read the user to add as a member. + +#### Application + +* _Group.Read.All_: Find all groups with name that starts with 'Sales' (`GET /groups?$filter=startswith(displayName,'Sales')`). +* _Group.ReadWrite.All_: Daemon service creates new events on an Office 365 group's calendar (`POST /groups/{id}/events`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## Identity Risk Event permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _IdentityRiskEvent.Read.All_ | Read identity risk event information | Allows the app to read identity risk event information for all users in your organization on behalf of the signed-in user. | Yes | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _IdentityRiskEvent.Read.All_ | Read identity risk event information | Allows the app to read identity risk event information for all users in your organization without a signed-in user. | Yes | + + +### Remarks + +_IdentityRiskEvent.Read.All_ is valid only for work or school accounts. For an app with delegated permissions to read identity risk information, the signed-in user must be a member of one of the following administrator roles: Global Administrator, Security Administrator, or Security Reader. For more information about administrator roles, see [Assigning administrator roles in Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-assign-admin-roles). + +### Example usage + +#### Delegated and Application + +The following usages are valid for both delegated and application permissions: + +* Read all risk events generated for all users in the tenant (`GET /beta/identityRiskEvents`) +* Read malware risk events generated by the Dorknet botnet (`GET /beta/malwareRiskEvents?$filter=malwareName eq 'Dorkbot'`) +* Read most recent 50 risk events (`GET /beta/identityRiskEvents?$orderBy=riskEventDateTime desc&top=50`) + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Identity provider permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _IdentityProvider.Read.All_ | Read identity provider information | Allows the app to read identity providers configured in your Azure AD or Azure AD B2C tenant on behalf of the signed-in user. | Yes | +| _IdentityProvider.ReadWrite.All_ | Read and write identity provider information | Allows the app to read or write identity providers configured in your Azure AD or Azure AD B2C tenant on behalf of the signed-in user. | Yes | + +### Remarks + +_IdentityProvider.Read.All_ and _IdentityProvider.ReadWrite.All_ are valid only for work or school accounts. For an app to read or write identity providers with delegated permissions, the signed-in user must be assigned the Global Administrator role. For more information about administrator roles, see [Assigning administrator roles in Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-assign-admin-roles). + +### Example usage + +#### Delegated +The following usages are valid for both delegated permissions: + +* _IdentityProvider.Read.All_: Read all identity providers configured in the tenant (`GET /beta/identityProviders`) +* _IdentityProvider.Read.All_: Read an existing identity provider (`GET /beta/identityProviders/{id}`) +* _IdentityProvider.ReadWrite.All_ Create an identity provider (`POST /beta/identityProviders`) +* _IdentityProvider.ReadWrite.All_ Update an existing identity provider (`PATCH /beta/identityProviders/{id}`) +* _IdentityProvider.ReadWrite.All_ Delete an existing identity provider (`DELETE /beta/identityProviders/{id}`) + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- +## Mail permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Mail.Read_ | Read user mail | Allows the app to read email in user mailboxes. | No | +| _Mail.ReadWrite_ | Read and write access to user mail | Allows the app to create, read, update, and delete email in user mailboxes. Does not include permission to send mail.| No | +| _Mail.Read.Shared_ | Read user and shared mail | Allows the app to read mail that the user can access, including the user's own and shared mail. | No | +| _Mail.ReadWrite.Shared_ | Read and write user and shared mail | Allows the app to create, read, update, and delete mail that the user has permission to access, including the user's own and shared mail. Does not include permission to send mail. | No | +| _Mail.Send_ | Send mail as a user | Allows the app to send mail as users in the organization. | No | +| _Mail.Send.Shared_ | Send mail on behalf of others | Allows the app to send mail as the signed-in user, including sending on-behalf of others. | No | +| _MailboxSettings.Read_ | Read user mailbox settings | Allows the app to the read user's mailbox settings. Does not include permission to send mail. | No | +| _MailboxSettings.ReadWrite_ | Read and write user mailbox settings | Allows the app to create, read, update, and delete user's mailbox settings. Does not include permission to send mail. | No | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _Mail.Read_ | Read mail in all mailboxes | Allows the app to read mail in all mailboxes without a signed-in user.| Yes | +| _Mail.ReadWrite_ | Read and write mail in all mailboxes | Allows the app to create, read, update, and delete mail in all mailboxes without a signed-in user. Does not include permission to send mail. | Yes | +| _Mail.Send_ | Send mail as any user | Allows the app to send mail as any user without a signed-in user. | Yes | +| _MailboxSettings.Read_ | Read all user mailbox settings | Allows the app to read user's mailbox settings without a signed-in user. Does not include permission to send mail. | No | +| _MailboxSettings.ReadWrite_ | Read and write all user mailbox settings | Allows the app to create, read, update, and delete user's mailbox settings without a signed-in user. Does not include permission to send mail. | Yes | + +### Remarks + +_Mail.Read.Shared_, _Mail.ReadWrite.Shared_, and _Mail.Send.Shared_ are only valid for work or school accounts. All other permissions are valid for both Microsoft accounts and work or school accounts. + +With the _Mail.Send_ or _Mail.Send.Shared_ permission, an app can send mail and save a copy to the user's Sent Items folder, even if the app does not use a corresponding _Mail.ReadWrite_ or _Mail.ReadWrite.Shared_ permission. + +### Example usage + +#### Delegated + +* _Mail.Read_: List messages in the user's inbox, sorted by `receivedDateTime` (`GET /me/mailfolders/inbox/messages?$orderby=receivedDateTime DESC`). +* _Mail.Read.Shared_: Find all messages with attachments in a user's inbox that has shared their inbox with the signed-in user (`GET /users{id | userPrincipalName}/mailfolders/inbox/messages?$filter=hasAttachments eq true`). +* _Mail.ReadWrite_: Mark a message read (`PATCH /me/messages/{id}`). +* _Mail.Send_: Send a message (`POST /me/sendmail`). +* _MailboxSettings.ReadWrite_: Update the user's automatic reply (`PATCH /me/mailboxSettings`). + +#### Application + +* _Mail.Read_: Find messages from bob@contoso.com (`GET /users/{id | userPrincipalName}/messages?$filter=from/emailAddress/address eq 'bob@contoso.com'`). +* _Mail.ReadWrite_: Create a new folder in the Inbox named `Expense Reports` (`POST /users/{id | userPrincipalName}/mailfolders`). +* _Mail.Send_: Send a message (`POST /users/{id | userPrincipalName}/sendmail`). +* _MailboxSettings.Read_: Get the default timezone for the user's mailbox (`GET /users/{id | userPrincipalName}/mailboxSettings/timeZone`) + + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## Member permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Member.Read.Hidden_ | Read hidden memberships | Allows the app to read the memberships of hidden groups and administrative units on behalf of the signed-in user, for those hidden groups and administrative units that the signed-in user has access to. | Yes | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Member.Read.Hidden_ | Read all hidden memberships | Allows the app to read the memberships of hidden groups and administrative units without a signed-in user. | Yes | + +### Remarks +_Member.Read.Hidden_ is valid only on work or school accounts. + +Membership in some Office 365 groups can be hidden. This means that only the members of the group can view its members. This feature can be used to help comply with regulations that require an organization to hide group membership from outsiders (for example, an Office 365 group that represents students enrolled in a class). + +### Example usage + +#### Delegated + +* _Member.Read.Hidden_: Read the members of an administrative unit with hidden membership on behalf of the signed-in user (`GET /administrativeUnits/{id}/members`). +* _Member.Read.Hidden_: Read the members of a group with hidden membership on behalf of the signed-in user (`GET /groups/{id}/members`). + +#### Application + +* _Member.Read.Hidden_: Read the members of an administrative unit with hidden membership (`GET /administrativeUnits/{id}/members`). +* _Member.Read.Hidden_: Read the members of a group with hidden membership (`GET /groups/{id}/members`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## Notes permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Notes.Read_ | Read user OneNote notebooks | Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user. | No | +| _Notes.Create_ | Create user OneNote notebooks | Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user.| No | +| _Notes.ReadWrite_ | Read and write user OneNote notebooks | Allows the app to read, share, and modify OneNote notebooks on behalf of the signed-in user. | No | +| _Notes.Read.All_ | Read all OneNote notebooks that user can access | Allows the app to read OneNote notebooks that the signed-in user has access to in the organization. | No | +| _Notes.ReadWrite.All_ | Read and write all OneNote notebooks that user can access | Allows the app to read, share, and modify OneNote notebooks that the signed-in user has access to in the organization.| No | +| _Notes.ReadWrite.CreatedByApp_ | Limited notebook access (deprecated) | **Deprecated**
Do not use. No privileges are granted by this permission. | No | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Notes.Read.All_ | Read all OneNote notebooks | Allows the app to read all the OneNote notebooks in your organization, without a signed-in user. | Yes | +| _Notes.ReadWrite.All_ | Read and write all OneNote notebooks | Allows the app to read, share, and modify all the OneNote notebooks in your organization, without a signed-in user.| Yes | + + +### Remarks +_Notes.Read.All_ and _Notes.ReadWrite.All_ are only valid for work or school accounts. All other permissions are valid for both Microsoft accounts and work or school accounts. + +With the _Notes.Create_ permission, an app can view the OneNote notebook hierarchy of the signed-in user and create OneNote content (notebooks, section groups, sections, pages, etc.). + +_Notes.ReadWrite_ and _Notes.ReadWrite.All_ also allow the app to modify the permissions on the OneNote content that can be accessed by the signed-in user. + +For work or school accounts, _Notes.Read.All_ and _Notes.ReadWrite.All_ allow the app to access other users' OneNote content that the signed-in user has permission to within the organization. + +### Example usage +#### Delegated + +* _Notes.Create_: Create a new notebooks for the signed-in user (`POST /me/onenote/notebooks`). +* _Notes.Read_: Read the notebooks for the signed-in user (`GET /me/onenote/notebooks`). +* _Notes.Read.All_: Get all notebooks that the signed-in user has access to within the organization (`GET /me/onenote/notebooks?includesharednotebooks=true`). +* _Notes.ReadWrite_: Update the page of the signed-in user (`PATCH /me/onenote/pages/{id}/$value`). +* _Notes.ReadWrite.All_: Create a page in another user's notebook that the signed-in user has access to within the organization (`POST /users/{id}/onenote/pages`). + +#### Application + +* _Notes.Read.All_: Read all users notebooks in a group (`GET /groups/{id}/onenote/notebooks`). +* _Notes.ReadWrite.All_: Update the page in a notebook for any user in the organization (`PATCH /users/{id}/onenote/pages/{id}/$value`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + + +## OpenID permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _email_ | View users' email address | Allows the app to read your users' primary email address. | No | +| _offline_access_ | Access user's data anytime | Allows the app to read and update user data, even when they are not currently using the app.| No | +| _openid_ | Sign users in | Allows users to sign in to the app with their work or school accounts and allows the app to see basic user profile information.| No | +| _profile_ | View users' basic profile | Allows the app to see your users' basic profile (name, picture, user name).| No | + +#### Application permissions + +None. + +### Remarks +You can use these permissions to specify artifacts that you want returned in Azure AD authorization and token requests. They are supported differently by the Azure AD v1.0 and v2.0 endpoints. + +With the Azure AD (v1.0) endpoint, only the _openid_ permission is used. You specify it in the *scope* parameter in an authorization request to return an ID token when you use the OpenID Connect protocol to sign in a user to your app. For more information, see [Authorize access to web applications using OpenID Connect and Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/active-directory-protocols-openid-connect-code). To successfully return an ID token, you must also make sure that the _User.Read_ permission is configured when you register your app. + +With the Azure AD v2.0 endpoint, you specify the _offline\_access_ permission in the _scope_ parameter to explicitly request a refresh token when using the OAuth 2.0 or OpenID Connect protocols. With OpenID Connect, you specify the _openid_ permission to request an ID token. You can also specify the _email_ permission, _profile_ permission, or both to return additional claims in the ID token. You do not need to specify _User.Read_ to return an ID token with the v2.0 endpoint. For more information, see [OpenID Connect scopes](https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-scopes#openid-connect-scopes). + +> **Important** The Microsoft Authentication Library (MSAL) currently specifies _offline\_access_, _openid_, _profile_, and _email_ by default in authorization and token requests. This means that, for the default case, if you specify these permissions explicitly, Azure AD may return an error. + +--- + +## People permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _People.Read_ | Read users' relevant people lists | Allows the app to read a scored list of people relevant to the signed-in user. The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications (such as email and Skype). | No | +| _People.Read.All_ | Read all users' relevant people lists | Allows the app to read a scored list of people relevant to the signed-in user or other users in the signed-in user's organization. The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications (such as email and Skype). Also allows the app to search the entire directory of the signed-in user's organization. | Yes | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| +| _People.Read.All_ | Read all users' relevant people lists | Allows the app to read a scored list of people relevant to the signed-in user or other users in the signed-in user's organization.

The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications (such as email and Skype). Also allows the app to search the entire directory of the signed-in user's organization. | Yes | + +### Remarks + +The People.Read.All permission is only valid for work and school accounts. + +### Example usage + +#### Delegated +* _People.Read_: Read a list of relevant people (`GET /me/people`) +* _People.Read.All_: Read a list of relevant people to another user in the same organization (`GET /users('{id})/people`) + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## Reports permissions + +#### Delegated permissions + +None. + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Reports.Read.All_ | Read all usage reports | Allows an app to read all service usage reports without a signed-in user. Services that provide usage reports include Office 365 and Azure Active Directory. | Yes | + +### Remarks +Reports permissions are only valid for work or school accounts. + +### Example usage + +#### Application + +* _Reports.Read.All_: Read usage detail report of email apps with period of 7 days (`GET /reports/EmailAppUsage(view='Detail',period='D7')/content`). +* _Reports.Read.All_: Read activity detail report of email with date of '2017-01-01' (`GET /reports/EmailActivity(view='Detail',data='2017-01-01')/content`). +* _Reports.Read.All_: Read Office 365 activations detail report (`GET /reports/Office365Activations(view='Detail')/content`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## Sites permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Sites.Read.All_ | Read items in all site collections | Allows the app to read documents and list items in all site collections on behalf of the signed-in user. | No | +| _Sites.ReadWrite.All_ | Read and write items in all site collections | Allows the app to edit or delete documents and list items in all site collections on behalf of the signed-in user. | No | +| _Sites.Manage.All_ | Create, edit, and delete items and lists in all site collections | Allows the app to manage and create lists, documents, and list items in all site collections on behalf of the signed-in user. | No | +| _Sites.FullControl.All_ | Have full control of all site collections | Allows the app to have full control to SharePoint sites in all site collections on behalf of the signed-in user. | Yes | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Sites.Read.All_ | Read items in all site collections | Allows the app to read documents and list items in all site collections without a signed in user. | Yes | +| _Sites.ReadWrite.All_ | Read and write items in all site collections | Allows the app to create, read, update, and delete documents and list items in all site collections without a signed in user. | Yes | +| _Sites.Manage.All_ | Have full control of all site collections | Allows the app to manage and create lists, documents, and list items in all site collections without a signed-in user. | Yes | +| _Sites.FullControl.All_ | Create, edit, and delete items and lists in all site collections | Allows the app to have full control to SharePoint sites in all site collections without a signed-in user. | Yes | + + +### Remarks + +Sites permissions are valid only on work or school accounts. + +### Example usage + +#### Delegated + +* _Sites.Read.All_: Read the lists on the SharePoint root site (`GET /v1.0/sites/root/lists`) +* _Sites.ReadWrite.All_: Create new list items in a SharePoint list (`POST /v1.0/sites/root/lists/123/items`) +* _Sites.Manage.All_: Add a new list to a SharePoint site (`POST /v1.0/sites/root/lists`) +* _Sites.FullControl.All_: Complete access to SharePoint sites and lists. + +--- + +## Tasks permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _Tasks.Read_ | Read user tasks | Allows the app to read user tasks. | No | +| _Tasks.Read.Shared_ | Read user and shared tasks | Allows the app to read tasks a user has permissions to access, including their own and shared tasks. | No | +| _Tasks.ReadWrite_ | Create, read, update and delete user tasks and containers | Allows the app to create, read, update and delete tasks and containers (and tasks in them) that are assigned to or shared with the signed-in user.| No | +| _Tasks.ReadWrite.Shared_ | Read and write user and shared tasks | Allows the app to create, read, update, and delete tasks a user has permissions to, including their own and shared tasks. | No | + +#### Application permissions + +None. + +### Remarks +_Tasks_ permissions are used to control access for Outlook tasks. Access for Microsoft Planner tasks is controlled by [_Group_ permissions](#group-permissions). + +_Shared_ permissions are currently only supported for work or school accounts. Even with _Shared_ permissions, reads and writes may fail if the user who owns the shared content has not granted the accessing user permissions to modify content within the folder. + +### Example usage +#### Delegated + +* _Tasks.Read_: Get all tasks in a user's mailbox (`GET /me/outlook/tasks`). +* _Tasks.Read.Shared_: Access tasks in a folder shared to you by another user in your organization (`Get /users{id|userPrincipalName}/outlook/taskfolders/{id}/tasks`). +* _Tasks.ReadWrite_: Add an event to the user's default task folder (`POST /me/outook/tasks`). +* _Tasks.Read_: Get all uncompleted tasks in a user's mailbox (`GET /users/{id | userPrincipalName}/outlook/tasks?$filter=status ne 'completed'`). +* _Tasks.ReadWrite_: Update a task in a user's mailbox (`PATCH /users/{id | userPrincipalName}/outlook/tasks/id`). +* _Tasks.ReadWrite.Shared_: Complete a task on behalf of another user (`POST /users/{id | userPrincipalName}/outlook/tasks/id/complete`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## User permissions + +#### Delegated permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _User.Read_ | Sign-in and read user profile | Allows users to sign-in to the app, and allows the app to read the profile of signed-in users. It also allows the app to read basic company information of signed-in users.| No | +| _User.ReadWrite_ | Read and write access to user profile | Allows the app to read your profile. It also allows the app to update your profile information on your behalf. | No | +| _User.ReadBasic.All_ | Read all users' basic profiles | Allows the app to read a basic set of profile properties of other users in your organization on behalf of the signed-in user. This includes display name, first and last name, email address and photo. | No | +| _User.Read.All_ | Read all users' full profiles | Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. | Yes | +| _User.ReadWrite.All_ | Read and write all users' full profiles | Allows the app to read and write the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. Also allows the app to create and delete users as well as reset user passwords on behalf of the signed-in user. | Yes | +| _User.Invite.All_ | Invite guest users to the organization | Allows the app to invite guest users to your organization, on behalf of the signed-in user. | Yes | + +#### Application permissions + +| Permission | Display String | Description | Admin Consent Required | +|:----------------|:------------------|:-------------|:-----------------------| +| _User.Read.All_ | Read all users' full profiles | Allows the app to read the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user.| Yes | +| _User.ReadWrite.All_ | Read and write all users' full profiles | Allows the app to read and write the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user. Also allows the app to create and delete non-administrative users. Does not allow reset of user passwords. | Yes | +| _User.Invite.All_ | Invite guest users to the organization | Allows the app to invite guest users to your organization, without a signed-in user. | Yes | + +### Remarks + +The only permissions valid for Microsoft accounts are _User.Read_ and _User.ReadWrite_. For work or school accounts, all permissions are valid. + +With the _User.Read_ permission, an app can also read the basic company information of the signed-in user for a work or school account through the [organization](../api-reference/v1.0/resources/organization.md) resource. The following properties are available: id, displayName, and verifiedDomains. + +For work or school accounts, the full profile includes all of the declared properties of the [User](../api-reference/v1.0/resources/user.md) resource. On reads, only a limited number of properties are returned by default. To read properties that are not in the default set, use `$select`. The default properties are: + +- displayName +- givenName +- jobTitle +- mail +- mobilePhone +- officeLocation +- preferredLanguage +- surname +- userPrincipalName + + _User.ReadWrite_ and _User.Readwrite.All_ delegated permissions allow the app to update the following profile properties for work or school accounts: + +- aboutMe +- birthday +- hireDate +- interests +- mobilePhone +- mySite +- pastProjects +- photo +- preferredName +- responsibilities +- schools +- skills + +With the _User.ReadWrite.All_ application permission, the app can update all of the declared properties of work or school accounts except for password. + +To read or write direct reports (`directReports`) or the manager (`manager`) of a work or school account, the app must have either _User.Read.All_ (read only) or _User.ReadWrite.All_. + +The _User.ReadBasic.All_ permission constrains app access to a limited set of properties known as the basic profile. This is because the full profile might contain sensitive directory information. The basic profile includes only the following properties: + +- displayName +- givenName +- mail +- photo +- surname +- userPrincipalName + +To read the group memberships of a user (`memberOf`), the app must have either [_Group.Read.All_](#group-permissions) or [_Group.ReadWrite.All_](#group-permissions). However, if the user also has membership in a [directoryRole](../api-reference/v1.0/resources/directoryrole.md) or an [administrativeUnit](../api-reference/beta/resources/administrativeunit.md), the app will need effective permissions to read those resources too, or Microsoft Graph will return an error. This means the app will also need [Directory permissions](#directory-permissions), and, for delegated permissions, the signed-in user will also need sufficient privileges in the organization to access directory roles and administrative units. + +### Example usage + +#### Delegated + +* _User.Read_: Read the full profile for the signed-in user (`GET /me`). +* _User.ReadWrite_: Update the photo of the signed-in user (`PUT /me/photo/$value`). +* _User.ReadBasic.All_: Find all users whose name starts with "David" (`GET /users?$filter=startswith(displayName,'David')`). +* _User.Read.All_: Read a user's manager (`GET /user/{id | userPrincipalName}/manager`). + + +#### Application + +* _User.Read.All_: Read all users and relationships through delta query (`GET /beta/users/delta?$select=displayName,givenName,surname`). +* _User.ReadWrite.All_: Update the photo for any user in the organization (`PUT /user/{id | userPrincipalName}/photo/$value`). + +For more complex scenarios involving multiple permissions, see [Permission scenarios](#permission-scenarios). + +--- + +## Permission scenarios + +This section shows some common scenarios that target [user](../api-reference/v1.0/resources/user.md) and [group](../api-reference/v1.0/resources/group.md) resources in an organization. The tables show the permissions that an app needs to be able to perform specific operations required by the scenario. Note that in some cases the ability of the app to perform specific operations will depend on whether a permission is an application or delegated permission. In the case of delegated permissions, the app's effective permissions will also depend on the privileges of the signed-in user within the organization. For more information, see [Delegated permissions, Application permissions, and effective permissions](#delegated-permissions-application-permissions-and-effective-permissions). + +### Access scenarios on the User resource + +| **App tasks involving User** | **Required permissions** | **Permission strings** | +|:-------------------------------|:---------------------|:---------------| +| App wants to read other users' basic information (only display name and picture), for example to show in a people picking experience | _User.ReadBasic.All_ | Read all user's basic profiles | +| App wants to read complete user profile for signed in user (see direct reports, and manager, etc.) | _User.Read_ | Enable sign-in and read user profile| +| App wants to read complete user profile all users | _User.Read.All_ | Read all user's full profiles | +| App wants to read files, mail and calendar information for the signed in user | _User.Read_, _Files.Read_, _Mail.Read_, _Calendars.Read_ | Enable sign-in and read user profile, Read users' files, Read user mail, Read user calendars | +| App wants to read the signed-in user's (my) files and files that other users have shared with the signed-in user (me). | _User.Read_, _Files.Read_, _Sites.Read.All_ | Enable sign-in and read user profile, Read users' files, Read items in all site collections | +| App wants to read and write complete user profile for signed in user | _User.ReadWrite_ | Read and write access to user profile | +| App wants to read and write complete user profile all users | _User.ReadWrite.All_ | Read and write all user's full profiles | +| App wants to read and write files, mail and calendar information for the signed in user | _User.ReadWrite_, _Files.ReadWrite_, _Mail.ReadWrite_, _Calendars.ReadWrite_ | Read and write access to user profile, Read and write access to user profile, Read and write access to user mail, Have full access to user calendars | + + +### Access scenarios on the Group resource + +| **App tasks involving Group** | **Required permissions** | **Permission strings** | +|:-------------------------------|:---------------------|:---------------| +| App wants to read basic group info (only display name and picture), for example to show in a group picking experience | _Group.Read.All_ | Read all groups| +| App wants to read all content in all Office 365 groups, including files, conversations. It also needs to show group memberships, be able to update group memberships, (if owner). | _Group.Read.All_ | Read items in all site collections, Read all groups| +| App wants to read and write all content in all Office 365 groups, including files, conversations. It also needs to show group memberships, be able to update group memberships, (if owner). | _Group.ReadWrite.All_, _Sites.ReadWrite.All_ | Read and write all groups, Edit or delete items in all site collections | +| App wants to discover (find) an Office 365 group. It allows the user to search for a particular group and choose one from the enumerated list to allow the user to join the group. | _Group.ReadWrite.All_ | Read and write all groups| +| App wants to create a group through AAD Graph | _Group.ReadWrite.All_ | Read and write all groups|