Updates from: 05/05/2021 03:13:50
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Accessreviewhistorydefinition Generatedownloaduri https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accessreviewhistorydefinition-generatedownloaduri.md
+
+ Title: "accessReviewHistoryDefinition: generateDownloadUri"
+description: "Generate a URI that can be used to retrieve review history data."
+
+localization_priority: Normal
++
+# accessReviewHistoryDefinition: generateDownloadUri
+
+Namespace: microsoft.graph
++
+Generate a URI that can be used to retrieve review history data for the associated [accessReviewHistoryDefinition](../resources/accessReviewHistoryDefinition.md). This URI is valid for one day and can be retrieved by fetching the **downloadUri** property from the associated [accessReviewHistoryDefinition](../resources/accessReviewHistoryDefinition.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|AccessReview.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|AccessReview.ReadWrite.All|
+
+The signed-in user must also be the creator of the associated review history definition, a Global Admin directory role member, or a Global Reader directory role member to generate the link.
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /identityGovernance/accessReviews/historyDefinitions/{definition-id}/generateDownloadUri()
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this action returns a `200 OK` response code and an [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "accessreviewhistorydefinition_generatedownloaduri"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/historyDefinitions/b2cb022f-b7e1-40f3-9854-c65a40861c38/generateDownloadUri
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessReviewHistoryDefinition"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
+ "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
+ "displayName": "Last quarter's group reviews April 2021",
+ "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
+ "reviewHistoryPeriodEndDateTime": "2021-04-05T00:00:00Z",
+ "decisions": [
+ "approve",
+ "deny",
+ "dontKnow",
+ "notReviewed",
+ "notNotified"
+ ],
+ "status": "done",
+ "createdDateTime": "2021-04-14T00:22:48.9392594Z",
+ "fulfilledDateTime": "2021-04-14T00:22:58.5276552Z",
+ "downloadUri": "https://contoso.com/df-erm-reports/Last quarter's group reviews April 2021-22be232e-a93d-42a3-8ac5-313cfd29a0eb.csv?sv=2015-04-05&ss=b&srt=o&sp=rl&st=2021-04-15T00:22:58.5276552Z&se=2021-03-23T19:41:38.0000000Z&spr=https&sig=84rlGCIgU4ToMn%2FFLncBXq95O8a8RsFlwQY1Knl%2Fo%2FI%3D",
+ "createdBy": {
+ "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
+ "displayName": "MOD Administrator",
+ "userPrincipalName": "admin@contoso.com"
+ },
+ "scopes": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
+ "queryRoot": null
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
+ "queryRoot": null
+ }
+ ]
+}
+```
v1.0 Accessreviewhistorydefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accessreviewhistorydefinition-get.md
+
+ Title: "Get accessReviewHistoryDefinition"
+description: "Retrieve an accessReviewHistoryDefinition object."
+
+localization_priority: Normal
++
+# Get accessReviewHistoryDefinition
+
+Namespace: microsoft.graph
++
+Retrieve an [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) object by its identifier. All of the properties of the access review history definition object are returned. If the download link is still valid, it is returned along with the definition. If the definition is 30 days or older, a 404 error is returned.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|AccessReview.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|AccessReview.ReadWrite.All|
+
+The signed-in user must also be the creator of the associated review history definition, a Global Admin directory role member, or a Global Reader directory role member to retrieve the definition.
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/accessReviews/historyDefinitions/{definition-id}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|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 and an [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_accessreviewhistorydefinition"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/historyDefinitions/b2cb022f-b7e1-40f3-9854-c65a40861c38
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessReviewHistoryDefinition"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
+ "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
+ "displayName": "Last quarter's group reviews April 2021",
+ "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
+ "reviewHistoryPeriodEndDateTime": "2021-04-05T00:00:00Z",
+ "decisions": [
+ "approve",
+ "deny",
+ "dontKnow",
+ "notReviewed",
+ "notNotified"
+ ],
+ "status": "done",
+ "createdDateTime": "2021-04-14T00:22:48.9392594Z",
+ "fulfilledDateTime": "2021-04-14T00:22:58.5276552Z",
+ "downloadUri": "https://contoso.com/df-erm-reports/Last quarter's group reviews April 2021-22be232e-a93d-42a3-8ac5-313cfd29a0eb.csv?sv=2015-04-05&ss=b&srt=o&sp=rl&st=2021-04-15T00:22:58.5276552Z&se=2021-03-23T19:41:38.0000000Z&spr=https&sig=84rlGCIgU4ToMn%2FFLncBXq95O8a8RsFlwQY1Knl%2Fo%2FI%3D",
+ "createdBy": {
+ "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
+ "displayName": "MOD Administrator",
+ "userPrincipalName": "admin@contoso.com"
+ },
+ "scopes": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
+ "queryRoot": null
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
+ "queryRoot": null
+ }
+ ]
+}
+```
v1.0 Accessreviewhistorydefinition List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accessreviewhistorydefinition-list.md
+
+ Title: "List accessReviewHistoryDefinitions"
+description: "Get a list of the accessReviewHistoryDefinition objects."
+
+localization_priority: Normal
++
+# List accessReviewHistoryDefinitions
+Namespace: microsoft.graph
++
+Retrieve the [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) objects created in the last 30 days, including all nested properties.
+
+>[!NOTE]
+>The default page size for this API is 100 **accessReviewHistoryDefinitions** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+>
+>If no query parameters are provided and there are more than 100 results, Microsoft Graph will automatically paginate results at 100 results per page.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|AccessReview.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|AccessReview.ReadWrite.All|
+
+If the signed-in user is not a Global Admin directory role member or a Global Reader directory role member, only the definitions that the signed-in user created will be returned.
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/accessReviews/historyDefinitions
+```
+
+## Optional query parameters
+This method supports the `$top`, `$filter`, and `$skip` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|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 and a collection of [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) objects in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_accessreviewhistorydefinition"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/historyDefinitions
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessReviewHistoryDefinition",
+ "isCollection": "true"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.count": 1,
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
+ "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
+ "displayName": "Last quarter's group reviews April 2021",
+ "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
+ "reviewHistoryPeriodEndDateTime": "2021-04-05T00:00:00Z",
+ "decisions": [
+ "approve",
+ "deny",
+ "dontKnow",
+ "notReviewed",
+ "notNotified"
+ ],
+ "status": "done",
+ "createdDateTime": "2021-04-14T00:22:48.9392594Z",
+ "fulfilledDateTime": "2021-04-14T00:22:58.5276552Z",
+ "downloadUri": "https://contoso.com/df-erm-reports/Last quarter's group reviews April 2021-22be232e-a93d-42a3-8ac5-313cfd29a0eb.csv?sv=2015-04-05&ss=b&srt=o&sp=rl&st=2021-04-15T00:22:58.5276552Z&se=2021-03-23T19:41:38.0000000Z&spr=https&sig=84rlGCIgU4ToMn%2FFLncBXq95O8a8RsFlwQY1Knl%2Fo%2FI%3D",
+ "createdBy": {
+ "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
+ "displayName": "MOD Administrator",
+ "userPrincipalName": "admin@contoso.com"
+ },
+ "scopes": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
+ "queryRoot": null
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
+ "queryRoot": null
+ }
+ ]
+ }
+ ]
+}
+```
v1.0 Accessreviewhistorydefinition Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/accessreviewhistorydefinition-post.md
+
+ Title: "Create accessReviewHistoryDefinition"
+description: "Create a new accessReviewHistoryDefinition object."
+
+localization_priority: Normal
++
+# Create accessReviewHistoryDefinition
+
+Namespace: microsoft.graph
++
+Create a new [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+|Permission type|Permissions (from least to most privileged)|
+|:|:|
+|Delegated (work or school account)|AccessReview.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|AccessReview.ReadWrite.All|
+
+The signed-in user must also be in a directory role that permits them to read an access review to retrieve any data. For more details, see the role and permission requirements for [access reviews](../resources/accessreviewsv2-root.md).
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /identityGovernance/accessReviews/historyDefinitions
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) object.
+
+The following table shows the required properties used to create an [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md).
+
+|Property|Type|Description|
+|:|:|:|
+|displayName | String | Name for the access review history data collection. Required. |
+|reviewHistoryPeriodStartDateTime | DateTimeOffset | Timestamp, reviews starting on or after this date will be included in the fetched history data. Required. |
+|reviewHistoryPeriodEndDateTime | DateTimeOffset | Timestamp, reviews starting on or before this date will be included in the fetched history data. Required. |
+|scopes|microsoft.graph.accessReviewQueryScope collection| Used to filter which reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required. |
+
+### Supported scope queries for accessReviewHistoryDefinition
+
+The following are queries supported on an [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) based on the [accessreviewqueryscope](../resources/accessreviewqueryscope.md). These scopes dictate which type of review history data is included in the downloadable CSV file which is generated when the definition is created.
+
+|Scenario| Query |
+|--|--|
+| Include every `accessReviewScheduleDefinition` review result on individual groups (excludes definitions scoped to all Microsoft 365 groups with guest users) | /identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')" |
+| Include every `accessReviewScheduleDefinition` review result on a specific group (excludes definitions scoped to all Microsoft 365 groups with guest users) | /identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups/{group id}') |
+| Include every `accessReviewScheduleDefinition` review result scoped to all Microsoft 365 groups with guest users | /identityGovernance/accessReviews/definitions?$filter=contains(scope/query, './members') |
+| Include every `accessReviewScheduleDefinition` review result on an access package | /identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments') |
+| Include every `accessReviewScheduleDefinition` review result for service principals assigned to privileged role | /identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'roleAssignmentScheduleInstances') |
+| Include every `accessReviewScheduleDefinition` review result for reivews of a specific group | /identityGovernance/accessReviews/definitions?$filter=scope/query eq '/groups/a1382a9b-8320-4e9c-8f73-dfead37d7723/members' |
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) object in the response body.
+
+## Examples
+
+The following example shows how to create an access review history definition scoped to access reviews on access packages and groups, running between the start date of 01/01/2021 and end date of 04/05/2021.
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "create_accessreviewhistorydefinition_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/historyDefinitions
+Content-Type: application/json
+
+{
+ "displayName": "Last quarter's group reviews April 2021",
+ "decisions": [
+ "approve",
+ "deny",
+ "dontKnow",
+ "notReviewed",
+ "notNotified"
+ ],
+ "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
+ "reviewHistoryPeriodEndDateTime": "2021-04-05T00:00:00Z",
+ "scopes": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
+ "queryRoot": null
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
+ "queryRoot": null
+ }
+ ]
+}
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessReviewHistoryDefinition"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
+ "id": "b2cb022f-b7e1-40f3-9854-c65a40861c38",
+ "displayName": "Last quarter's group reviews April 2021",
+ "reviewHistoryPeriodStartDateTime": "2021-01-01T00:00:00Z",
+ "reviewHistoryPeriodEndDateTime": "2021-04-05T00:00:00Z",
+ "decisions": [
+ "approve",
+ "deny",
+ "dontKnow",
+ "notReviewed",
+ "notNotified"
+ ],
+ "status": "requested",
+ "createdDateTime": "2021-04-14T00:22:48.9392594Z",
+ "fulfilledDateTime": null,
+ "downloadUri": null,
+ "createdBy": {
+ "id": "957f1027-c0ee-460d-9269-b8444459e0fe",
+ "displayName": "MOD Administrator",
+ "userPrincipalName": "admin@contoso.com"
+ },
+ "scopes": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, 'accessPackageAssignments')",
+ "queryRoot": null
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ "queryType": "MicrosoftGraph",
+ "query": "/identityGovernance/accessReviews/definitions?$filter=contains(scope/query, '/groups')",
+ "queryRoot": null
+ }
+ ]
+}
+```
v1.0 Authenticationflowspolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/authenticationflowspolicy-get.md
doc_type: apiPageType
Namespace: microsoft.graph + Read the properties and relationships of an [authenticationFlowsPolicy](../resources/authenticationflowspolicy.md) object. ## Permissions
v1.0 Emailauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/emailauthenticationmethodconfiguration-get.md
Content-length: 491
"@odata.type":"#microsoft.graph.emailAuthenticationMethodConfiguration", "id":"Email", "state":"enabled",
- "allowExternalIdToUseEmailOtp":"True",
+ "allowExternalIdToUseEmailOtp":"enabled",
"includeTargets":[ { "targetType":"group",
v1.0 Emailauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/emailauthenticationmethodconfiguration-update.md
Content-length: 147
{ "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
- "allowExternalIdToUseEmailOtp": "false",
+ "allowExternalIdToUseEmailOtp": "disabled",
} ``` # [C#](#tab/csharp)
v1.0 Provisioningobjectsummary List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/provisioningobjectsummary-list.md
For general information, see [OData query parameters](/graph/query_parameters).
|changeid|eq, contains| |cycleid|eq, contains| |action|eq, contains|
+|provisioningAction|eq, contains|
+|durationInMilliseconds|eq, gt, lt|
+|provisioningStatusInfo/status|eq, contains|
|statusInfo/status|eq, contains| |sourceSystem/displayName|eq, contains| |targetSystem/displayName|eq, contains|
Content-type: application/json
"jobId": "aws.74beb1753b704b63b8d56f0b76082b16.10a7a801-7101-4c69-ae00-ce9f75f8460a", "cycleId": "b6502552-018d-79bd-8869-j47194dc65c1", "changeId": "b6502552-018d-89bd-9969-b49194dc65c1",
- "action": "EntryExportUpdate",
+ "action": "Create",
+ "provisioningAction": "create",
"durationInMilliseconds": 3236, "statusInfo": { "status": "success" },
+ "provisioningStatusInfo": {
+ "status": "success",
+ "errorInformation" : null
+ },
"provisioningSteps": [ { "name": "EntryImport",
Content-type: application/json
} }, "initiatedBy": {
- "initiatingType": "System",
+ "initiatingType": "system",
"id": "", "displayName": "Azure AD Provisioning Service" },
Content-type: application/json
"errorCode": "ContosoEntryConflict", "reason": "Message: Contoso returned an error response with the HTTP status code 409. This response indicates that a user or a group already exisits with the same name. This can be avoided by identifying and removing the conflicting user from Contoso via the Contoso administrative user interface, or removing the current user from the scope of provisioning either by removing their assignment to the Contoso application in Azure Active Directory or adding a scoping filter to exclude the user.", "additionalDetails": null,
- "errorCategory": "NonServiceFailure",
+ "errorCategory": "nonServiceFailure",
"recommendedAction": null },
+ "provisioningStatusInfo": {
+ "status": "failure",
+ "errorInformation" : {
+ "errorCode": "ContosoEntryConflict",
+ "reason": "Message: Contoso returned an error response with the HTTP status code 409. This response indicates that a user or a group already exisits with the same name. This can be avoided by identifying and removing the conflicting user from Contoso via the Contoso administrative user interface, or removing the current user from the scope of provisioning either by removing their assignment to the Contoso application in Azure Active Directory or adding a scoping filter to exclude the user.",
+ "additionalDetails": null,
+ "errorCategory": "nonServiceFailure",
+ "recommendedAction": null
+ }
+ },
"provisioningSteps": [ { "name": "EntryImportAdd",
v1.0 User Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/api/user-update.md
In the request body, supply the values for relevant fields that should be update
|department|String|The name for the department in which the user works.| |displayName|String|The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Supports `$filter` and `$orderby`.| |employeeId|String|The employee identifier assigned to the user by the organization.|
+| employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`. Supports `$filter` with the `eq` operator.|
|givenName|String|The given name (first name) of the user.| |hireDate|DateTimeOffset|The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |identities|[objectIdentity](../resources/objectidentity.md) collection| Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft, by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. Any update to **identities** will replace the entire collection and you must supply the userPrincipalName **signInType** identity in the collection.|
v1.0 Accessreviewhistorydefinition https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/accessreviewhistorydefinition.md
+
+ Title: "accessReviewHistoryDefinition resource types"
+description: "Represents a collection of access review history data."
+
+localization_priority: Normal
++
+# accessReviewHistoryDefinition resource type
+
+Namespace: microsoft.graph
++
+Represents a collection of access review history data and the scopes used to collect that data. The **reviewHistoryPeriodStartDateTime**, **reviewHistoryPeriodEndDateTime**, **decisions**, and **scopes** properties of an **accessReviewHistoryDefinition** are used when selecting review history data, and can be modified. Each **accessReviewHistoryDefinition** object is only available for 30 days. Once a history definition's status has moved to `done` a link can be generated to retrieve the definition's data by calling [generateDownloadUri](../api/accessreviewhistorydefinition-generatedownloaduri.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[List accessReviewHistoryDefinitions](../api/accessreviewhistorydefinition-list.md)|[accessReviewHistoryDefinition](accessreviewhistorydefinition.md) collection|Get a list of the [accessReviewHistoryDefinition](accessreviewhistorydefinition.md) objects and their properties.|
+|[Create accessReviewHistoryDefinition](../api/accessreviewhistorydefinition-post.md)|[accessReviewHistoryDefinition](accessreviewhistorydefinition.md)|Create a new [accessReviewHistoryDefinition](accessreviewhistorydefinition.md) object.|
+|[Get accessReviewHistoryDefinition](../api/accessreviewhistorydefinition-get.md)|[accessReviewHistoryDefinition](accessreviewhistorydefinition.md)|Read the properties and relationships of an [accessReviewHistoryDefinition](accessreviewhistorydefinition.md) object.|
+|[generateDownloadUri](../api/accessreviewhistorydefinition-generatedownloaduri.md)|[accessReviewHistoryDefinition](accessreviewhistorydefinition.md)|Generate a URI that can be used to retrieve review history data.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[userIdentity](useridentity.md)| User who created this review history definition. |
+|createdDateTime|DateTimeOffset|Timestamp when the access review definition was created.|
+|decisions|String collection|Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions will be included by default if no decisions are provided on create. Possible values are: `approve`, `deny`, `dontKnow`, `notReviewed`, and `notNotified`.|
+|displayName|String|Name for the access review history data collection. Required.|
+|downloadUri|String|Uri which can be used to retrieve review history data. This URI will be active for 24 hours after being generated.|
+|fulfilledDateTime|DateTimeOffset|Timestamp when all of the available data for this definition was collected. This will be set after this definition's status is set to `done`.|
+|id|String|The assigned unique identifier of an access review history definition.|
+|reviewHistoryPeriodEndDateTime|DateTimeOffset|Timestamp, reviews starting on or after this date will be included in the fetched history data. Required.|
+|reviewHistoryPeriodStartDateTime|DateTimeOffset|Timestamp, reviews starting on or before this date will be included in the fetched history data. Required.|
+|scopes|microsoft.graph.accessReviewQueryScope collection|Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. See [accessreviewqueryscope](accessreviewqueryscope.md). Required.|
+|status|String collection|Represents the status of the review history data collection. Possible values are: `done`, `inprogress`, `error`, `requested`.|
+
+## JSON representation
+The following is a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.accessReviewHistoryDefinition",
+ "baseType": "microsoft.graph.entity",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "reviewHistoryPeriodStartDateTime": "String (timestamp)",
+ "reviewHistoryPeriodEndDateTime": "String (timestamp)",
+ "decisions": [
+ {
+ "@odata.type": "String"
+ }
+ ],
+ "status": "String",
+ "createdDateTime": "String (timestamp)",
+ "fulfilledDateTime": "String (timestamp)",
+ "downloadUri": "String",
+ "createdBy": {
+ "@odata.type": "#microsoft.graph.userIdentity"
+ },
+ "scopes": [
+ {
+ "@odata.type": "#microsoft.graph.accessReviewQueryScope",
+ }
+ ]
+}
+```
v1.0 Authenticationmethods Usage Insights Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/authenticationmethods-usage-insights-overview.md
The following permissions are required to call this API. To learn more, includin
|Permission type|Permissions (from least to most privileged)| |:|:|
-|Delegated (work or school account)|Reports.Read.All|
+|Delegated (work or school account)|Reports.Read.All<br>AuditLogs.Read.All|
|Delegated (personal Microsoft account)|Not supported.|
-|Application|Not supported.|
+|Application|Reports.Read.All<br>AuditLogs.Read.All|
In order to access the API, [one of the following roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles) is required:
v1.0 Emailauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/emailauthenticationmethodconfiguration.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset, or by external users for authentication in some circumstances.
+Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset, or by external users for authentication during invitation redemption and self-service sign-up for specific apps in user flows.
## Methods
Represents this tenant's email OTP authentication methods policy. Authentication
|:|:|:| |id|String|The authentication method policy identifier. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |state|authenticationMethodState|Indicates whether this authentication method is enabled or not. Possible values are: `enabled`, `disabled`.|
-|allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who did not use public preview will automatically have email OTP enabled beginning in March 2021.|
+|allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who did not use public preview will automatically have email OTP enabled beginning in October 2021.|
## Relationships
v1.0 Initiator https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/initiator.md
Describes who or what initiated the provisioning event.
|:-|:|:| |displayName|String|Name of the person or service that initiated the provisioning event.| |id|String|Uniquely identifies the person or service that initiated the provisioning event.|
-|initiatorType|String| Type of initiator. Possible values are: `user`, `app`, `system`, `unknownFutureValue`.|
+|initiatorType|String| Type of initiator. Possible values are: `user`, `application`, `system`, `unknownFutureValue`.|
## JSON representation
v1.0 Provisioningerrorinfo https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/provisioningerrorinfo.md
+
+ Title: "provisioningErrorInfo resource type"
+description: "Describes the status of the provisioning event and the associated errors."
+localization_priority: Normal
+++
+# provisioningErrorInfo resource type
+
+Namespace: microsoft.graph
++
+Describes the status of the provisioning event and the associated errors.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|additionalDetails|String|Additional details in case of error.|
+|errorCategory|String|Categorizes the error code. Possible values are `failure`, `nonServiceFailure`, `success`, `unknownFutureValue`|
+|errorCode|String|Unique error code if any occurred. [Learn more](https://docs.microsoft.com/azure/active-directory/reports-monitoring/concept-provisioning-logs#error-codes)|
+|reason|String|Summarizes the status and describes why the status happened.|
+|recommendedAction|String|Provides the resolution for the corresponding error.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.provisioningErrorInfo",
+ "baseType": null
+}-->
+
+```json
+{
+ "additionalDetails": "String",
+ "errorCategory": "String",
+ "errorCode": "String",
+ "reason": "String",
+ "recommendedAction": "String"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "provisioningErrorInfo resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Provisioningobjectsummary https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/provisioningobjectsummary.md
doc_type: "resourcePageType"
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
+>[!CAUTION]
+>The **action** and **statusInfo** properties are deprecated. Property **action** should be replaced by **provisioningAction**. Property **statusInfo** should be replaced by **provisioningStatusInfo**.
Represents an action performed by the Azure AD Provisioning service and its associated properties.
Represents an action performed by the Azure AD Provisioning service and its asso
| Property | Type | Description | |:-|:|:|
-|action|String|Indicates the activity name or the operation name (for example, Create user, Add member to group). For a list of activities logged, refer to Azure AD activity list.|
+|provisioningAction|string|Indicates the activity name or the operation name. Possible values are: `create`, `update`, `delete`, `stageddelete`, `disable`, `other` and `unknownFutureValue`. For a list of activities logged, refer to Azure AD activity list.|
|activityDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |changeId|String|Unique ID of this change in this cycle.| |cycleId|String|Unique ID per job iteration.|
Represents an action performed by the Azure AD Provisioning service and its asso
|provisioningSteps|[provisioningStep](provisioningstep.md) collection|Details of each step in provisioning.| |servicePrincipal|[servicePrincipal](serviceprincipal.md) collection|Represents the service principal used for provisioning.| |sourceIdentity|[provisionedIdentity](provisionedidentity.md)|Details of source object being provisioned.|
-|sourceSystem|[provisioningSystemDetails](provisioningsystemdetails.md)|Details of source system of the object being provisioned.|
-|statusInfo|[statusBase](statusbase.md)|Details of provisioning status.|
+|sourceSystem|[provisioningSystem](provisioningsystem.md)|Details of source system of the object being provisioned.|
+|provisioningStatusInfo|[provisioningStatusInfo](provisioningstatusinfo.md)|Details of provisioning status.|
|targetIdentity|[provisionedIdentity](provisionedidentity.md)|Details of target object being provisioned.|
-|targetSystem|[provisioningSystemDetails](provisioningsystemdetails.md)|Details of target system of the object being provisioned.|
+|targetSystem|[provisioningSystem](provisioningsystem.md)|Details of target system of the object being provisioned.|
|tenantId|String|Unique Azure AD tenant ID.|
+|action (deprecated)|String|Indicates the activity name or the operation name (for example, Create user, Add member to group). For a list of activities logged, refer to Azure AD activity list. This is deprecated. Please use provisioningAction instead.|
+|statusInfo (deprecated)|[statusBase](statusbase.md)|Details of provisioning status. This is deprecated. Please use provisioningStatusInfo instead.|
## Relationships
The following is a JSON representation of the resource.
```json { "action": "String",
+ "provisioningAction": "String",
"activityDateTime": "String (timestamp)", "changeId": "String", "cycleId": "String",
The following is a JSON representation of the resource.
"provisioningSteps": [{"@odata.type": "microsoft.graph.provisioningStep"}], "servicePrincipal": [{"@odata.type": "microsoft.graph.provisioningServicePrincipal"}], "sourceIdentity": {"@odata.type": "microsoft.graph.provisionedIdentity"},
- "sourceSystem": {"@odata.type": "microsoft.graph.provisioningSystemDetails"},
+ "sourceSystem": {"@odata.type": "microsoft.graph.provisioningSystem"},
"statusInfo": {"@odata.type": "microsoft.graph.statusBase"}, "targetIdentity": {"@odata.type": "microsoft.graph.provisionedIdentity"},
- "targetSystem": {"@odata.type": "microsoft.graph.provisioningSystemDetails"},
+ "targetSystem": {"@odata.type": "microsoft.graph.provisioningSystem"},
"tenantId": "String" } ```
v1.0 Provisioningstatusinfo https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/provisioningstatusinfo.md
+
+ Title: "provisioningStatusInfo resource type"
+description: "Describes the status of the provisioning summary event."
+localization_priority: Normal
+++
+# provisioningStatusInfo resource type
+
+Namespace: microsoft.graph
++
+Describes the status of the provisioning summary event.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|status|String| Possible values are: `success`, `warning`, `failure`, `skipped`, `unknownFutureValue`.|
+|errorInfo|[provisioningErrorInfo](provisioningerrorinfo.md)| If status is not success/ skipped details for the error are contained in this.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.provisioningStatusInfo",
+ "baseType": null
+}-->
+
+```json
+{
+ "status": "String",
+ "errorinfo": {"@odata.type": "microsoft.graph.provisioningErrorInfo"},}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "provisioningStatusInfo resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Provisioningsystem https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/provisioningsystem.md
+
+ Title: "provisioningSystem resource type"
+description: "Represents the system that a user was provisioned to or from."
+localization_priority: Normal
+++
+# provisioningSystem resource type
+
+Namespace: microsoft.graph
++
+Represents the system that a user was provisioned to or from. For example, when provisioning a user from Azure Active Directory (Azure AD) to ServiceNow, the source system is Azure AD, and the target system is ServiceNow.
+
+## Properties
+
+| Property | Type | Description |
+|:-|:|:|
+|details|[detailsInfo](detailsinfo.md)|Details of the system.|
+|displayName|String|Name of the system that a user was provisioned to or from.|
+|id|String|Identifier of the system that a user was provisioned to or from.|
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "optionalProperties": [
+
+ ],
+ "@odata.type": "microsoft.graph.provisioningSystem",
+ "baseType": null
+}-->
+
+```json
+{
+ "details": {"@odata.type": "microsoft.graph.detailsInfo"},
+ "displayName": "String",
+ "id": "String"
+}
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "provisioningSystem resource",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
++
v1.0 Serviceprincipal https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/serviceprincipal.md
This resource supports using [delta query](/graph/delta-query-overview) to track
"logoutUrl": "string", "notes": "String", "notificationEmailAddresses": ["string"],
- "notes": "string",
"publishedPermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}], "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}], "passwordSingleSignOnSettings": {"@odata.type": "microsoft.graph.passwordSingleSignOnSettings"},
v1.0 Statusbase https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/statusbase.md
ms.prod: "identity-and-access-reports"
doc_type: "resourcePageType"
-# statusBase resource type
+# statusBase resource type (deprecated)
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
+>[!CAUTION]
+> The statusBase API is deprecated and will stop returning data om December 31, 2021. Please use the new [provisioningStatusInfo](provisioningstatusinfo.md) type.
Describes the status of the provisioning summary event.
v1.0 Statusdetails https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/statusdetails.md
ms.prod: "identity-and-access-reports"
doc_type: "resourcePageType"
-# statusDetails resource type
+# statusDetails resource type (deprecated)
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
+>[!CAUTION]
+> The statusDetails API is deprecated and will stop returning data om December 31, 2021. Please use the new [provisioningStatusInfo](provisioningstatusinfo.md) type.
Describes the status of the provisioning event and the associated errors. It is inherited from [statusBase](/graph/api/resources/statusbase) and only used when status is set to `failure`.
v1.0 User https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/beta/resources/user.md
This resource supports:
| employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in case of a future hire. <br><br>Returned only on `$select`. Supports `$filter`.| | employeeId | String | The employee identifier assigned to the user by the organization. <br><br>Returned only on `$select`. Supports `$filter`.| |employeeOrgData|[employeeOrgData](employeeorgdata.md) |Represents organization data (e.g. division and costCenter) associated with a user. <br><br>Returned only on `$select`.|
-| employeeType | String | Captures enterprise worker type: Employee, Contractor, Consultant, Vendor, etc. <br><br>Returned only on `$select`. Supports `$filter`.|
+| employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`. Supports `$filter` with the `eq` operator.|
| externalUserState | String | For an external user invited to the tenant using the [invitation API](../api/invitation-post.md), this property represents the invited user's invitation status. For invited users, the state can be `PendingAcceptance` or `Accepted`, or `null` for all other users. <br><br>Returned only on `$select`. Supports `$filter` with the supported values. For example: `$filter=externalUserState eq 'PendingAcceptance'`. | | externalUserStateChangeDateTime | String | Shows the timestamp for the latest change to the externalUserState property. <br><br>Returned only on `$select`. | | faxNumber | String | The fax number of the user. <br><br>Returned only on `$select`. |
v1.0 Educationclass Delete Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-delete-members.md
Title: "Remove a student"
+ Title: "Remove member from educationClass"
description: "Removes an educationUser from an educationClass" localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# Remove a student
+# Remove member from educationClass
Namespace: microsoft.graph Removes an [educationUser](../resources/educationuser.md) from an [educationClass](../resources/educationclass.md)
->**Note:** Teachers _and_ students are in the class **members** collection. Before calling this API, insure that the **educationUser** you are removing is not a teacher. Get the list of teachers by calling [educationclass_list_teachers](educationclass-list-teachers.md) and verifying the user Id of the user to be removed is not in the returned teacher list.
+> **Note:** Teachers _and_ students are in the class **members** collection. Before calling this API, insure that the **educationUser** you are removing is not a teacher. Get the list of teachers by calling [educationclass_list_teachers](educationclass-list-teachers.md) and verifying the user Id of the user to be removed is not in the returned teacher list.
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
HTTP/1.1 204 No Content
"section": "documentation", "tocPath": "" }-->-
v1.0 Educationclass Delete Teachers https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-delete-teachers.md
Title: "Remove teacher"
+ Title: "Remove teacher from educationClass "
description: "Remove a teacher from a class." localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# Remove teacher
-
+# Remove teacher from educationClass
Namespace: microsoft.graph
-Remove a teacher from a class.
+Remove teacher from an [educationClass](../resources/educationclass.md).
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
HTTP/1.1 204 No Content
"section": "documentation", "tocPath": "" }-->-
v1.0 Educationclass Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-delete.md
Title: "Delete educationClass" description: "Delete a class. Because a class is also a universal group, deleting a class deletes the group."+ localization_priority: Normal- ms.prod: "education" doc_type: apiPageType
doc_type: apiPageType
Namespace: microsoft.graph
-Delete a class. Because a class is also a universal group, deleting a class deletes the group.
+Delete an [educationClass](../resources/educationclass.md).
+
+> [!IMPORTANT]
+> Because a class is also a universal group, deleting a class deletes the group.
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
HTTP/1.1 204 No Content
"suppressions": [ ] }-->-
v1.0 Educationclass Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-delta.md
+
+ Title: "educationClass: delta"
+description: "Get newly created or updated classes, including membership changes, without having to perform a full read of the entire class collection."
+localization_priority: Normal
+++
+# educationClass: delta
+
+Namespace: microsoft.graph
+
+Get newly created or updated classes, including membership changes, without having to perform a full read of the entire class collection. See [Use delta query](/graph/delta-query-overview) for details.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
+| Delegated (work or school account) | EduRoster.ReadBasic, EduRoster.Read, or EduRoster.ReadWrite |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.ReadBasic.All, EduRoster.Read.All, or EduRoster.WriteWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/classes/delta
+```
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns an `200 OK` response code and an [educationClass](../resources/educationclass.md) collection in the response body. The response also includes a `nextLink` URL or a `deltaLink` URL.
+
+- If a `nextLink` URL is returned, there are additional pages of data to be retrieved in the session. The application continues making requests using the `nextLink` URL until a `deltaLink` URL is included in the response.
+- If a `deltaLink` URL is returned, there is no more data about the existing state of the resource to be returned. Persist and use the `deltaLink` URL to learn about changes to the resource in the future.
+
+For details, see [Using delta query](/graph/delta-query-overview). For example requests, see [Get incremental changes for users](/graph/delta-query-users).
+
+> [!IMPORTANT]
+> educationClass deltas do not include deleted classes.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "educationclass_delta"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/classes/delta
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationClass)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(educationClass)",
+ "@odata.nextLink": "https://graph.microsoft.com/v1.0/education/classes/delta?$skiptoken=sU1S4IJGk3hwxbia8...",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
+ }
+ ]
+}
+```
v1.0 Educationclass Get Group https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-get-group.md
- Title: "Get group"
-description: "Retrieve the Microsoft 365 **group** that corresponds to this **educationClass**."
-localization_priority: Normal
-
-doc_type: apiPageType
--
-# Get group
-
-Namespace: microsoft.graph
-
-Retrieve the Microsoft 365 **group** that corresponds to this **educationClass**.
-
->**Note:** If the delegated token is used, members can only see information about their own schools. Use the `...beta/education/me/schools` resource in this case.
-
-## Permissions
-A combination of permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | One from EduRoster.ReadBasic, EduRoster.Read, EduRoster.Write plus Directory.Read.All|
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All plus Directory.Read.All|
-
-## HTTP request
-<!-- { "blockType": "ignored" } -->
-```http
-GET /education/classes/{id}/group
-```
-## 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 and a [group](../resources/group.md) object in the response body.
-## Example
-##### Request
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "educationclass_get_group"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education/classes/{class-id}/group
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
---
-##### Response
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.user",
- "isCollection": false
-} -->
-```http
-HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: xxx
-
-{
- "id": "id-value",
- "description": "description-value",
- "displayName": "displayName-value",
- "groupTypes": [
- "groupTypes-value"
- ],
- "mail": "mail-value",
- "mailEnabled": true,
- "mailNickname": "mailNickname-value",
- "onPremisesLastSyncDateTime": "onPremisesLastSyncDateTime-value",
- "onPremisesSecurityIdentifier": "onPremisesSecurityIdentifier-value",
- "onPremisesSyncEnabled": true,
- "proxyAddresses": [
- "proxyAddresses-value"
- ],
- "securityEnabled": true,
- "visibility": "visibility-value"
-}
-```
-
-<!-- uuid: 0087D9B3-1418-4C87-91C9-A18C6D93706B
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Get user",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
-
v1.0 Educationclass Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-get.md
Title: "Get educationClass"
-description: " 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."
+description: "Retrieve a class from the system"
localization_priority: Normal-+ ms.prod: "education" doc_type: apiPageType
doc_type: apiPageType
Namespace: microsoft.graph
-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.
+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](/graph/permissions-reference).
One of the following permissions is required to call this API. To learn more, in
```http GET /education/classes/{id} ```+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+You can use `$select` to get specific group properties, including those that are not returned by default.
+For more information on OData query options, see [OData Query Parameters](/graph/query-parameters).
## Request headers | Header | Value | |:|:--|
If successful, this method returns a `200 OK` response code and an [educationCla
##### Request Here is an example of the request.
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "get_educationclass"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education/classes/{class-id}
-```
-# [C#](#tab/csharp)
+If successful, this method returns a `200 OK` response code and an [educationClass](../resources/educationclass.md) object in the response body.
-# [JavaScript](#tab/javascript)
+## Examples
-# [Objective-C](#tab/objc)
+### Request
-# [Java](#tab/java)
+<!-- {
+ "blockType": "request",
+ "name": "get_educationclass"
+}
+-->
-
+```http
+GET /education/classes/{educationClassId}
+```
-##### Response
-The following is an example of the response.
+### Response
>**Note:** The response object shown here might be shortened for readability.
The following is an example of the response.
"blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.educationClass"
-} -->
+}
+-->
+ ```http HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 224
+Content-Type: application/json
{
- "id": "11023",
- "description": "English Level 2",
- "classCode": "11023",
- "createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012",
+ "value": {
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
}
- },
- "displayName": "English - Language 2",
- "externalId": "301",
- "externalName": "English Level 1",
- "externalSource": "School of Fine Art",
- "mailNickname": "fineartschool.net "
+ }
} ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Get educationClass",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
v1.0 Educationclass List Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-list-members.md
Title: "List members"
+ Title: "List members of an educationClass"
description: "Retrieves the teachers and students for a class. Note that if the delegated token is used, members can only be seen by other members of the class." localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# List members
+# List members of an educationClass
Namespace: microsoft.graph
-Retrieves the teachers and students for a class. Note that if the delegated token is used, members can only be seen by other members of the class.
+Retrieves the [educationUser](../resources/educationuser.md) members of an [educationClass](../resources/educationclass.md).
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | EduRoster.ReadBasic |
-|Delegated (personal Microsoft account) | Not supported |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All plus Member.Read.Hidden |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All plus Member.Read.Hidden |
+
+> [!NOTE]
+> Note that if the delegated token is used, members can only see information about their own classes.
## HTTP request <!-- { "blockType": "ignored" } --> ```http GET /education/classes/{id}/members ```+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+
+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`.
+
+When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
+
+For more information on OData query options, see [OData query parameters](/graph/query-parameters).
## Request headers | Header | Value |
v1.0 Educationclass List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-list.md
+
+ Title: "List educationClasses"
+description: "Get a list of the educationClass objects and their properties."
+
+localization_priority: Normal
++
+# List educationClasses
+
+Namespace: microsoft.graph
+
+Get a list of the [educationClass](../resources/educationclass.md) objects and their properties.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/classes
+```
+
+## Optional query parameters
+
+You can use the OData query option `$orderby` to sort groups in an organization by the **displayName** values, as shown in the following example:
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET https://graph.microsoft.com/v1.0/groups?$orderby=displayName
+```
+
+You can also use the `$filter`, `$count` and `$search` query parameters to limit the response.
+
+When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
+
+For more information on OData query options, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| 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 and a collection of [educationClass](../resources/educationclass.md) objects in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "list_educationclass"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/classes
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationClass)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
+ }
+ ]
+}
+```
v1.0 Educationclass Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-post.md
+
+ Title: "Create educationClass"
+description: "Create a new educationClass object."
+
+localization_priority: Normal
++
+# Create educationClass
+
+Namespace: microsoft.graph
+
+Create a new [educationClass](../resources/educationclass.md) object.
+
+> [!NOTE]
+> This will also create a universal group. When you use this API to create a class, it will add special properties to the group, which will add features such as assignments and special handling within Microsoft Teams when teams are created using the group. Please note that this API only creates the universal group and does not create a team. Microsoft Teams provides a user interface for teachers to create teams for their own classes using the groups created by this API.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+POST /education/classes
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of the [educationClass](../resources/educationclass.md) object.
+
+The following table shows the properties that are required when you create the [educationClass](../resources/educationclass.md).
+
+| Property | Type | Description |
+| :- | : | :-- |
+| id | String | Object identifier. Inherited from [entity](../resources/entity.md) |
+| displayName | String | Name of the class. |
+| mailNickname | String | Mail name for sending email to all members, if this is enabled. |
+| description | String | Description of the class. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the class |
+| classCode | String | Class code used by the school to identify the class. |
+| externalName | String | Name of the class in the syncing system. |
+| externalId | String | ID of the class from the syncing system. |
+| externalSource | educationExternalSource | How this class was created. Possible values are: `sis`, `manual` |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| grade | String | Grade level of the class. |
+| term | [educationTerm](../resources/educationterm.md) | Term for this class. |
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [educationClass](../resources/educationclass.md) object in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "create_educationclass_from_"
+}
+-->
+
+```http
+POST https://graph.microsoft.com/v1.0/education/classes
+Content-Type: application/json
+Content-length: 533
+
+{
+ "@odata.type": "#microsoft.graph.educationClass",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
+}
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.educationClass"
+}
+-->
+
+```http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
+}
+```
v1.0 Educationclass Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationclass-update.md
Title: "Update educationclass properties"
+ Title: "Update educationClass"
description: "Update the properties of a class."-+ localization_priority: Normal ms.prod: "education" doc_type: apiPageType
-# Update educationclass properties
+# Update educationClass
Namespace: microsoft.graph
-Update the properties of a class.
+Update the properties of an [educationClass](../resources/educationclass.md) object.
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
PATCH /education/classes/{id}
## 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, 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| 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 created. The possible values are: `sis`, `manual`, `enum_sentinel`.|
+| Property | Type | Description |
+| :- | :- | :-- |
+| displayName | String | Name of the class. |
+| mailNickname | String | Mail name for sending email to all members, if this is enabled. |
+| description | String | Description of the class. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the class |
+| classCode | String | Class code used by the school to identify the class. |
+| externalId | String | ID of the class from the syncing system. |
+| externalSource | educationExternalSource | How this class was created. Possible values are: `sis`, `manual` |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| grade | String | Grade level of the class. |
+| term | [educationTerm](../resources/educationterm.md) | Term for this class. |
## Response If successful, this method returns a `200 OK` response code and an updated [educationClass](../resources/educationclass.md) object in the response body.
The following is an example of the response.
} --> ```http HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 224
+Content-Type: application/json
{
- "id": "11014",
- "description": "World History Level 1",
- "classCode": "301",
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
"createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012"
- }
+ "@odata.type": "microsoft.graph.identitySet"
},
- "displayName": "History - World History 1",
- "externalId": "301",
- "externalName": "World History Level 1",
- "externalSource": "Fabrikam High School",
- "mailNickname": "Fabrikam"
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
} ```
Content-length: 224
"suppressions": [ ] }-->-
v1.0 Educationroot List Classes https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationroot-list-classes.md
- Title: "List classes"
-description: "Retrieve a list of all class objects. "
-
-localization_priority: Normal
-doc_type: apiPageType
--
-# List classes
-
-Namespace: microsoft.graph
-
-Retrieve a list of all class objects.
-
-## Permissions
-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | EduRoster.ReadBasic |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
-
-## HTTP request
-<!-- { "blockType": "ignored" } -->
-```http
-GET /education/classes
-```
-## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
-
-## 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 and a collection of [educationClass](../resources/educationclass.md) objects in the response body.
-## Example
-##### Request
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "get_classes_1"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education/classes
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
---
-##### Response
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationClass",
- "isCollection": true
-} -->
-```http
-HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 277
-
-{
- "value": [
- {
- "id": "11019",
- "description": "Health Level 1",
- "classCode": "Health 501",
- "createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012",
- }
- },
- "displayName": "Health 1",
- "externalId": "11019",
- "externalName": "Health Level 1",
- "externalSource": "sis",
- "mailNickname": "fineartschool.net"
- }
- ]
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "List classes",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
v1.0 Educationroot List Schools https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationroot-list-schools.md
- Title: "List educationSchools"
-description: "Retrieve a list of all school objects."
-
-localization_priority: Normal
-doc_type: apiPageType
--
-# List educationSchools
-
-Namespace: microsoft.graph
-
-Retrieve a list of all school objects.
-
-## Permissions
-
-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-| Permission type | Permissions (from least to most privileged) |
-| :- | : |
-| Delegated (work or school account) | EduRoster.ReadBasic |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
-
-## HTTP request
-
-<!-- { "blockType": "ignored" } -->
-```http GET /education/schools
-```
-
-## Optional query parameters
-
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
-
-## 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 and a collection of [educationSchool](../resources/educationschool.md) objects in the response body.
-
-## Example
-
-##### Request
-
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-
-<!-- {
- "blockType": "request",
- "name": "get_schools_2"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education/schools
-```
-
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
---
-##### Response
-
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationSchool",
- "isCollection": true
-} -->
-```http
-HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 345
-
-{
- "value": [
- {
- "id": "10001",
- "displayName": "Contoso High School",
- "description": "Public 9-12 high school",
- "status": "active",
- "externalSource": "sis",
- "principalEmail": "amyr@contoso.com",
- "principalName": "Amy Roebuck",
- "externalPrincipalId": "14007",
- "highestGrade": "12",
- "lowestGrade": "9",
- "schoolNumber": "10001",
- "address": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- },
- "createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012",
- }
- },
- "externalId": "10001",
- "phone": "+1 (253) 555-0102",
- }
- ]
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "List schools",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
v1.0 Educationroot List Users https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationroot-list-users.md
- Title: "List users"
-description: "Retrieve a list of user objects. These user objects will include education-specific properties."
-
-localization_priority: Normal
-doc_type: apiPageType
--
-# List users
-
-Namespace: microsoft.graph
-
-Retrieve a list of user objects. These user objects will include education-specific properties.
-
-## Permissions
-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | Not supported. |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
-
-## HTTP request
-<!-- { "blockType": "ignored" } -->
-```http
-GET /education/users
-```
-## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
-
-## 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 and a collection of [educationUser](../resources/educationuser.md) objects in the response body.
-## Example
-##### Request
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "educationroot_get_users"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education/users
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
---
-##### Response
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationUser",
- "isCollection": true
-} -->
-```http
-HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 593
-
-{
- "value": [
- {
- "id": "13012",
- "displayName": "Dion Matheson",
- "givenName": "Dion",
- "middleName": null,
- "surname": "Matheson",
- "mail": "DionM@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": "student",
- "residenceAddress": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- }
- }
- ]
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "List users",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
v1.0 Educationroot Post Classes https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationroot-post-classes.md
- Title: "Create educationClass"
-description: "Create a new class. This will also create a universal group. When you use this API to create a class, it will add special properties to the group, which will"
-localization_priority: Normal
-
-doc_type: apiPageType
--
-# Create educationClass
-
-Namespace: microsoft.graph
-
-Create a new class. This will also create a universal group. When you use this API to create a class, it will add special properties to the group, which will
-add features such as assignments and special handling within Microsoft Teams when teams are created using the group.
-Please note that this API only creates the universal group and does not create a team. Microsoft Teams provides a user interface for teachers to create teams for their own classes using the groups created by this API.
-
-## Permissions
-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | Not supported. |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.ReadWrite.All |
-
-## HTTP request
-<!-- { "blockType": "ignored" } -->
-```http
-POST /education/classes
-```
-## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json |
-
-## Request body
-In the request body, supply a JSON representation of an [educationClass](../resources/educationclass.md) object.
--
-## Response
-If successful, this method returns a `201 Created` response code and an [educationClass](../resources/educationclass.md) object in the response body.
-
-## Example
-##### Request
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "create_educationclass_from_educationroot"
-}-->
-```http
-POST https://graph.microsoft.com/v1.0/education/classes
-Content-type: application/json
-Content-length: 224
-
-{
- "description": "Health Level 1",
- "classCode": "Health 501",
- "displayName": "Health 1",
- "externalId": "11019",
- "externalName": "Health Level 1",
- "externalSource": "sis",
- "mailNickname": "fineartschool.net"
-}
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
----
-##### Response
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationClass"
-} -->
-```http
-HTTP/1.1 201 Created
-Content-type: application/json
-Content-length: 224
-
-{
- "id": "11019",
- "description": "Health Level 1",
- "classCode": "Health 501",
- "createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012",
- }
- },
- "displayName": "Health 1",
- "externalId": "11019",
- "externalName": "Health Level 1",
- "externalSource": "sis",
- "mailNickname": "fineartschool.net"
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Create educationClass",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
-
v1.0 Educationroot Post Schools https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationroot-post-schools.md
- Title: "Create educationSchool"
-description: "Create a school."
-
-localization_priority: Normal
-doc_type: apiPageType
--
-# Create educationSchool
-
-Namespace: microsoft.graph
-
-Create a school.
-
-## Permissions
-
-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-| Permission type | Permissions (from least to most privileged) |
-| :- | : |
-| Delegated (work or school account) | Not supported. |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | EduRoster.ReadWrite.All |
-
-## HTTP request
-
-<!-- { "blockType": "ignored" } -->
-```http
-POST /education/schools
-```
-
-## Request headers
-
-| Header | Value |
-| : | : |
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json |
-
-## Request body
-
-In the request body, supply a JSON representation of an [educationSchool](../resources/educationschool.md) object.
-
-## Response
-
-If successful, this method returns a `201 Created` response code and an [educationSchool](../resources/educationschool.md) object in the response body.
-
-## Example
-
-##### Request
-
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-
-<!-- {
- "blockType": "request",
- "name": "create_educationschool_from_educationroot"
-}-->
-```http
-POST https://graph.microsoft.com/v1.0/education/schools
-Content-type: application/json
-Content-length: 292
-
-{
- "displayName": "Fabrikam High School",
- "description": "Magnate school for the arts. Los Angeles School District",
- "externalSource": "String",
- "principalEmail": "AmyR@fabrikam.com",
- "principalName": "Amy Roebuck",
- "externalPrincipalId": "14007",
- "highestGrade": "12",
- "lowestGrade": "9",
- "schoolNumber": "10002",
- "address": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- },
- "externalId": "10002",
- "phone": "+1 (253) 555-0102"
-}
-```
-
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
---
-##### Response
-
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationSchool"
-} -->
-```http
-HTTP/1.1 201 Created
-Content-type: application/json
-Content-length: 292
-
-{
- "id": "10002",
- "displayName": "Fabrikam High School",
- "description": "Magnate school for the arts. Los Angeles School District",
- "status": "String",
- "externalSource": "String",
- "principalEmail": "AmyR@fabrikam.com",
- "principalName": "Amy Roebuck",
- "externalPrincipalId": "14007",
- "highestGrade": "12",
- "lowestGrade": "9",
- "schoolNumber": "10002",
- "address": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- },
- "createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012",
- }
- },
- "externalId": "10002",
- "phone": "+1 (253) 555-0102",
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Create educationSchool",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
-
v1.0 Educationroot Post Users https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationroot-post-users.md
- Title: "Create educationUser"
-description: "Create a new user."
-
-localization_priority: Normal
-doc_type: apiPageType
--
-# Create educationUser
-
-Namespace: microsoft.graph
-
-Create a new user.
-
-<!-- Add some additional text to better distinguish this method from the user_post_users (https://developer.microsoft.com/graph/docs/api-reference/v1.0/api/user_post_users) topic. -->
-
-## Permissions
-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | Not supported. |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.ReadWrite.All |
-
-## HTTP request
-<!-- { "blockType": "ignored" } -->
-```http
-POST /education/users
-```
-## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json |
-
-## Request body
-In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object.
--
-## Response
-If successful, this method returns a `201 Created` response code and an [educationUser](../resources/educationuser.md) object in the response body.
-
-## Example
-##### Request
-The following is an example of the request.
-
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "create_educationuser_from_educationroot"
-}-->
-```http
-POST https://graph.microsoft.com/v1.0/education/users
-Content-type: application/json
-Content-length: 508
-
-{
- "displayName": "Dion Matheson",
- "givenName": "Dion",
- "middleName": null,
- "surname": "Matheson",
- "mail": "DionM@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": "student",
- "residenceAddress": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- }
-}
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
----
-##### Response
-The following is an example of the response.
-
->**Note:** The response object shown here might be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationUser"
-} -->
-```http
-HTTP/1.1 201 Created
-Content-type: application/json
-Content-length: 508
-
-{
- "id": "13012",
- "displayName": "Dion Matheson",
- "givenName": "Dion",
- "middleName": " ",
- "surname": "Matheson",
- "mail": "DionM@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": "student",
- "residenceAddress": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- }
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Create educationUser",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
-
v1.0 Educationschool Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-delta.md
+
+ Title: "educationSchool: delta"
+description: "Get newly created or updated schools without having to perform a full read of the entire school collection."
+
+localization_priority: Normal
++
+# educationSchool: delta
+
+Namespace: microsoft.graph
+
+Get newly created or updated schools without having to perform a full read of the entire school collection. See [Use delta query](/graph/delta-query-overview) for details.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/schools/delta
+```
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [educationSchool](../resources/educationschool.md) collection in the response body. The response also includes a `nextLink` URL or a `deltaLink` URL.
+
+- If a `nextLink` URL is returned, there are additional pages of data to be retrieved in the session. The application continues making requests using the `nextLink` URL until a `deltaLink` URL is included in the response.
+- If a `deltaLink` URL is returned, there is no more data about the existing state of the resource to be returned. Persist and use the `deltaLink` URL to learn about changes to the resource in the future.
+
+For details, see [Using delta query](/graph/delta-query-overview). For example requests, see [Get incremental changes for users](/graph/delta-query-users).
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "educationschool_delta"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/schools/delta
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationSchool)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(educationSchool)",
+ "@odata.nextLink": "https://graph.microsoft.com/v1.0/education/schools/delta?$skiptoken=VwhMSQw1l1O5v2F1ZPm...",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationSchool",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "description": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "principalEmail": "String",
+ "principalName": "String",
+ "externalPrincipalId": "String",
+ "lowestGrade": "String",
+ "highestGrade": "String",
+ "schoolNumber": "String",
+ "externalId": "String",
+ "phone": "String",
+ "fax": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "address": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ }
+ }
+ ]
+}
+```
v1.0 Educationschool Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-get.md
Title: "Get educationSchool"
-description: "Retrieve the properties and relationships of the school object."
-
+description: "Read the properties and relationships of an educationSchool object."
+ localization_priority: Normal ms.prod: "education" doc_type: apiPageType
doc_type: apiPageType
Namespace: microsoft.graph
-Retrieve the properties and relationships of the school object.
+Read the properties and relationships of an [educationSchool](../resources/educationschool.md) object.
## Permissions+ One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | EduRoster.ReadBasic |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
## HTTP request
-<!-- { "blockType": "ignored" } -->
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+ ```http
-GET /education/schools
-GET /education/me/schools
-GET /education/users/schools
+GET /education/schools/{educationSchoolId}
```+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+
+This method supports the same OData query parameters as [Get User](../api/user-get.md#optional-query-parameters). For general information, see [OData query parameters](/graph/query-parameters).
## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Name | Description |
+| : | : |
+| 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 and an [educationSchool](../resources/educationschool.md) object in the response body.
-## Example
-##### Request
-The following is an example of the request.
-# [HTTP](#tab/http)
+## Examples
+
+### Request
+ <!-- { "blockType": "request", "name": "get_educationschool"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education/schools/{school-id}
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
+}
+-->
-
+```http
+GET https://graph.microsoft.com/v1.0/education/schools/{educationSchoolId}
+```
-##### Response
-The following is an example of the response.
+### Response
>**Note:** The response object shown here might be shortened for readability.
The following is an example of the response.
"blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.educationSchool"
-} -->
+}
+-->
+ ```http HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 292
+Content-Type: application/json
{
- "principalEmail": "AmyRoebuck@contoso.com",
- "principalName": "Amy Roebuck",
- "externalPrincipalId": "14007",
- "lowestGrade": "9",
- "highestGrade": "12"
+ "value": {
+ "@odata.type": "#microsoft.graph.educationSchool",
+ "id": "1c23c12e-c12e-1c23-2ec1-231c2ec1231c",
+ "displayName": "String",
+ "description": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "principalEmail": "String",
+ "principalName": "String",
+ "externalPrincipalId": "String",
+ "lowestGrade": "String",
+ "highestGrade": "String",
+ "schoolNumber": "String",
+ "externalId": "String",
+ "phone": "String",
+ "fax": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "address": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ }
+ }
} ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Get educationSchool",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
v1.0 Educationschool List Administrativeunit https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-list-administrativeunit.md
+
+ Title: "List administrativeUnit an educationSchool"
+description: "Get a list of administrativeUnits associated with an educationSchool object."
+
+localization_priority: Normal
++
+# List administrativeUnit an educationSchool
+
+Namespace: microsoft.graph
+
+Get a list of **administrativeUnits** associated with an [educationSchool](../resources/educationschool.md) object.
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/schools/{educationSchoolId}/administrativeUnit
+```
+
+## Optional query parameters
+
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| 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 and a collection of [administrativeUnit](../resources/administrativeunit.md) objects in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "list_administrativeunit"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/classes/{educationClassId}/members/{educationUserId}/schools/{educationSchoolId}/administrativeUnit
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.administrativeUnit)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.administrativeUnit",
+ "id": "03e281d6-81d6-03e2-d681-e203d681e203",
+ "deletedDateTime": "String (timestamp)",
+ "displayName": "String",
+ "description": "String",
+ "visibility": "String"
+ }
+ ]
+}
+```
v1.0 Educationschool List Classes https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-list-classes.md
Title: "List educationClasses"
+ Title: "List classes of an educationSchool"
description: "Retrieve a list of classes owned by a school." localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# List educationClasses
+# List classes of an educationSchool
Namespace: microsoft.graph
-Retrieve a list of classes owned by a school.
+Get the [educationClass](../resources/educationclass.md) resources owned by an [educationSchool](../resources/educationschool.md).
## Permissions+ One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | EduRoster.ReadBasic |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http
-GET /education/schools/{id}/classes
+GET /education/schools/{educationSchoolId}/classes
```+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+
+You can use the OData query option `$orderby` to sort groups in an organization by the **displayName** values, as shown in the following example:
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET https://graph.microsoft.com/v1.0/groups?$orderby=displayName
+```
+
+You can also use the `$filter`, `$count` and `$search` query parameters to limit the response.
+
+When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
+
+For more information on OData query options, see [OData query parameters](/graph/query-parameters).
## Request headers | Header | Value |
v1.0 Educationschool List Users https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-list-users.md
Title: "List educationUsers"
+ Title: "List users of an educationSchool"
description: "Retrieve a list of users at a school." localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# List educationUsers
+# List users of an educationSchool
Namespace: microsoft.graph
-Retrieve a list of users at a school.
+Get the [educationUser](../resources/educationuser.md) resources associated with an [educationSchool](../resources/educationschool.md).
## Permissions+ One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
-|Permission type | Permissions (from least to most privileged) |
-|:--|:|
-|Delegated (work or school account) | Not supported. |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http
-GET /education/schools/{id}/users
+GET /education/schools/{educationSchoolId}/users
```+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+
+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`.
+
+When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
+
+For more information on OData query options, see [OData query parameters](/graph/query-parameters).
## Request headers | Header | Value |
v1.0 Educationschool List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-list.md
+
+ Title: "List educationSchools"
+description: "Get a list of the educationSchool objects and their properties."
+
+localization_priority: Normal
++
+# List educationSchools
+
+Namespace: microsoft.graph
+
+Get a list of the [educationSchool](../resources/educationschool.md) objects and their properties.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/schools
+```
+
+## Optional query parameters
+
+This method supports the same OData query parameters as [List Users](../api/user-list.md#optional-query-parameters). For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| 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 and a collection of [educationSchool](../resources/educationschool.md) objects in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "list_educationschool"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/schools
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationSchool)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationSchool",
+ "id": "1c23c12e-c12e-1c23-2ec1-231c2ec1231c",
+ "displayName": "String",
+ "description": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "principalEmail": "String",
+ "principalName": "String",
+ "externalPrincipalId": "String",
+ "lowestGrade": "String",
+ "highestGrade": "String",
+ "schoolNumber": "String",
+ "externalId": "String",
+ "phone": "String",
+ "fax": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "address": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ }
+ }
+ ]
+}
+```
v1.0 Educationschool Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-post.md
+
+ Title: "Create educationSchool"
+description: "Create a new educationSchool object."
+
+localization_priority: Normal
++
+# Create educationSchool
+
+Namespace: microsoft.graph
+
+Create a new [educationSchool](../resources/educationschool.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+POST /education/schools
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of the [educationSchool](../resources/educationschool.md) object.
+
+The following table shows the properties that are required when you create the [educationSchool](../resources/educationschool.md).
+
+| Property | Type | Description |
+| :- | :- | :- |
+| displayName | String | Display name of the school. Inherited from [educationOrganization](../resources/educationorganization.md). |
+| description | String | Description of the school. Inherited from [educationOrganization](../resources/educationorganization.md). |
+| externalSource | educationExternalSource | Source where this organization was created from. Inherited from [educationOrganization](../resources/educationorganization.md). Possible values are: `sis`, `manual. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| principalEmail | String | Email address of the principal. |
+| principalName | String | Name of the principal. |
+| externalPrincipalId | String | ID of principal in syncing system. |
+| highestGrade | String | Highest grade taught. |
+| lowestGrade | String | Lowest grade taught. |
+| schoolNumber | String | School Number. |
+| externalId | String | ID of school in syncing system. |
+| phone | String | Phone number of school. |
+| fax | String | Fax number of school. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the school. |
+| address | [physicalAddress](../resources/physicaladdress.md) | Address of the school. |
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [educationSchool](../resources/educationschool.md) object in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "create_educationschool_from_"
+}
+-->
+
+```http
+POST https://graph.microsoft.com/v1.0/education/schools
+Content-Type: application/json
+Content-length: 583
+
+{
+ "@odata.type": "#microsoft.graph.educationSchool",
+ "displayName": "String",
+ "description": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "principalEmail": "String",
+ "principalName": "String",
+ "externalPrincipalId": "String",
+ "lowestGrade": "String",
+ "highestGrade": "String",
+ "schoolNumber": "String",
+ "externalId": "String",
+ "phone": "String",
+ "fax": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "address": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ }
+}
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.educationSchool"
+}
+-->
+
+```http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.educationSchool",
+ "id": "1c23c12e-c12e-1c23-2ec1-231c2ec1231c",
+ "displayName": "String",
+ "description": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "principalEmail": "String",
+ "principalName": "String",
+ "externalPrincipalId": "String",
+ "lowestGrade": "String",
+ "highestGrade": "String",
+ "schoolNumber": "String",
+ "externalId": "String",
+ "phone": "String",
+ "fax": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "address": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ }
+}
+```
v1.0 Educationschool Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationschool-update.md
Title: "Update educationSchool properties"
-description: "Update the properties of a school object."
-
+ Title: "Update educationSchool"
+description: "Update the properties of an educationSchool object."
+ localization_priority: Normal ms.prod: "education" doc_type: apiPageType
-# Update educationSchool properties
+# Update educationSchool
Namespace: microsoft.graph
-Update the properties of a school object.
+Update the properties of an [educationSchool](../resources/educationschool.md) object.
## Permissions
PATCH /education/schools/{id}
## 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, don't include existing values that haven't changed.
-
-| Property | Type | Description |
-| : | :- | : |
-| displayName | String | Display name of the school |
-| description | String | Description of the school |
-| principalEmail | String | Email address of the principal |
-| principalName | String | Name of the principal |
-| externalPrincipalId | String | Id of principal in syncing system. |
-| highestGrade | String | Highest grade taught. |
-| lowestGrade | String | Lowest grade taught. |
-| schoolNumber | String | School Number. |
-| externalId | String | Id of school in syncing system. |
-| phone | String | Phone number of school. |
-| address | [physicalAddress](../resources/physicaladdress.md) | Address of the School. |
-| createdBy | [identitySet](../resources/identityset.md) | Entity who created the school. |
+In the request body, supply a JSON representation of the [educationSchool](../resources/educationschool.md) object.
+
+The following table shows the properties that are required when you update the [educationSchool](../resources/educationschool.md).
+
+| Property | Type | Description |
+| :- | :- | :-- |
+| displayName | String | Display name of the school. Inherited from [educationOrganization](../resources/educationorganization.md). |
+| description | String | Description of the school. Inherited from [educationOrganization](../resources/educationorganization.md). |
+| externalSource | educationExternalSource | Source where this organization was created from. Inherited from [educationOrganization](../resources/educationorganization.md). Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| principalEmail | String | Email address of the principal. |
+| principalName | String | Name of the principal. |
+| externalPrincipalId | String | ID of principal in syncing system. |
+| highestGrade | String | Highest grade taught. |
+| lowestGrade | String | Lowest grade taught. |
+| schoolNumber | String | School Number. |
+| externalId | String | ID of school in syncing system. |
+| phone | String | Phone number of school. |
+| fax | String | Fax number of school. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the school. |
+| address | [physicalAddress](../resources/physicaladdress.md) | Address of the school. |
## Response
Content-length: 292
"suppressions": [ ] }-->-
v1.0 Educationuser Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-delta.md
+
+ Title: "educationUser: delta"
+description: "Get newly created or updated users without having to perform a full read of the entire user collection."
+
+localization_priority: Normal
++
+# educationUser: delta
+
+Namespace: microsoft.graph
+
+Get newly created or updated [educationUser](../resources/educationuser.md) without having to perform a full read of the entire collection. See [Use delta query](/graph/delta-query-overview) for details.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/users/delta
+```
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [educationUser](../resources/educationuser.md) collection in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "educationuser_delta"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/users/delta
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationUser)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(educationUser)",
+ "@odata.nextLink": "https://graph.microsoft.com/v1.0/education/users/delta?$skiptoken=VwhMSQw1l1O5v2F1ZPm...",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationUser",
+ "id": "String (identifier)",
+ "primaryRole": "String",
+ "middleName": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "residenceAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "mailingAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "student": {
+ "@odata.type": "microsoft.graph.educationStudent"
+ },
+ "teacher": {
+ "@odata.type": "microsoft.graph.educationTeacher"
+ },
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "accountEnabled": "Boolean",
+ "assignedLicenses": [
+ {
+ "@odata.type": "microsoft.graph.assignedLicense"
+ }
+ ],
+ "assignedPlans": [
+ {
+ "@odata.type": "microsoft.graph.assignedPlan"
+ }
+ ],
+ "businessPhones": [
+ "String"
+ ],
+ "department": "String",
+ "displayName": "String",
+ "givenName": "String",
+ "mail": "String",
+ "mailNickname": "String",
+ "mobilePhone": "String",
+ "passwordPolicies": "String",
+ "passwordProfile": {
+ "@odata.type": "microsoft.graph.passwordProfile"
+ },
+ "officeLocation": "String",
+ "preferredLanguage": "String",
+ "provisionedPlans": [
+ {
+ "@odata.type": "microsoft.graph.provisionedPlan"
+ }
+ ],
+ "refreshTokensValidFromDateTime": "String (timestamp)",
+ "showInAddressList": "Boolean",
+ "surname": "String",
+ "usageLocation": "String",
+ "userPrincipalName": "String",
+ "userType": "String",
+ "onPremisesInfo": {
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
+ }
+ }
+ ]
+}
+```
v1.0 Educationuser Get User https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-get-user.md
Title: "Get user"
+ Title: "Get educationUser"
description: "Retrieve the simple directory **user** that corresponds to this **educationUser**." localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# Get user
+# Get educationUser
Namespace: microsoft.graph
v1.0 Educationuser Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-get.md
Title: "Get educationUser"
-description: "Retrieve the properties and relationships of a user."
-
+description: "Read the properties and relationships of an educationUser object."
+ localization_priority: Normal ms.prod: "education" doc_type: apiPageType
doc_type: apiPageType
Namespace: microsoft.graph
-Retrieve the properties and relationships of a user.
+Read the properties and relationships of an [educationUser](../resources/educationuser.md) object.
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
The following is an example of the response.
"blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.educationUser"
-} -->
+}
+-->
+ ```http HTTP/1.1 200 OK
-Content-type: application/json
-Content-length: 508
+Content-Type: application/json
{
- "id": "13012",
- "displayName": "Dion Matheson",
- "givenName": "Dion",
- "middleName": " ",
- "surname": "Matheson",
- "mail": "DionM@contoso.com",
- "mobilePhone": "+1 (253) 555-0101",
- "createdBy": {
- "user": {
- "displayName": "Susana Rocha",
- "id": "14012"
+ "value": {
+ "@odata.type": "#microsoft.graph.educationUser",
+ "id": "90eedea1-dea1-90ee-a1de-ee90a1deee90",
+ "primaryRole": "String",
+ "middleName": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "residenceAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "mailingAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "student": {
+ "@odata.type": "microsoft.graph.educationStudent"
+ },
+ "teacher": {
+ "@odata.type": "microsoft.graph.educationTeacher"
+ },
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "accountEnabled": "Boolean",
+ "assignedLicenses": [
+ {
+ "@odata.type": "microsoft.graph.assignedLicense"
+ }
+ ],
+ "assignedPlans": [
+ {
+ "@odata.type": "microsoft.graph.assignedPlan"
+ }
+ ],
+ "businessPhones": [
+ "String"
+ ],
+ "department": "String",
+ "displayName": "String",
+ "givenName": "String",
+ "mail": "String",
+ "mailNickname": "String",
+ "mobilePhone": "String",
+ "passwordPolicies": "String",
+ "passwordProfile": {
+ "@odata.type": "microsoft.graph.passwordProfile"
+ },
+ "officeLocation": "String",
+ "preferredLanguage": "String",
+ "provisionedPlans": [
+ {
+ "@odata.type": "microsoft.graph.provisionedPlan"
+ }
+ ],
+ "refreshTokensValidFromDateTime": "String (timestamp)",
+ "showInAddressList": "Boolean",
+ "surname": "String",
+ "usageLocation": "String",
+ "userPrincipalName": "String",
+ "userType": "String",
+ "onPremisesInfo": {
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
}
- },
- "externalSource": "sis",
- "mailingAddress": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- },
- "primaryRole": "student",
- "residenceAddress": {
- "city": "Los Angeles",
- "countryOrRegion": "United States",
- "postalCode": "98055",
- "state": "CA",
- "street": "12345 Main St."
- },
+ }
} ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "Get educationUser",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
v1.0 Educationuser List Classes https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-list-classes.md
Title: "List classes"
+ Title: "List classes of an educationUser"
description: "Retrieve a list of class objects. Note that if the delegated token is used, members can only see information about their own classes. " localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# List classes
+# List classes of an educationUser
Namespace: microsoft.graph
-Retrieve a list of class objects. Note that if the delegated token is used, members can only see information about their own classes.
+Get the [educationClass](../resources/educationclass.md) resources an [educationUser](../resources/educationuser.md) is a member of.
<!-- Please verify the revision to the delegated token text. -->
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account) | Not supported. | |Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+> [!NOTE]
+> Note that if the delegated token is used, members can only see information about their own classes.
+ ## HTTP request <!-- { "blockType": "ignored" } --> ```http
Content-length: 277
"tocPath": "", "suppressions": [ ]
-}-->
+}-->
v1.0 Educationuser List Schools https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-list-schools.md
Title: "List schools"
+ Title: "List schools of an educationUser"
description: "Retrieve a list of schools for a user." localization_priority: Normal
ms.prod: "education"
doc_type: apiPageType
-# List schools
+# List schools of an educationUser
Namespace: microsoft.graph
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } --> ```http GET /education/me/schools
-GET /education/users/{id}/schools
+GET /education/users/{educationUserId}/schools
``` ## Optional query parameters
v1.0 Educationuser List Taughtclasses https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-list-taughtclasses.md
+
+ Title: "List taughtClasses"
+description: "Get the educationClass resources from the taughtClasses navigation property."
+
+localization_priority: Normal
++
+# List taughtClasses
+
+Namespace: microsoft.graph
+
+Get the [educationClass](../resources/educationclass.md) resources owned by an [educationUser](../resources/educationuser.md).
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | EduRoster.ReadBasic |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+> [!NOTE]
+> Note that if the delegated token is used, users can only see information about their own classes.
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/me/taughtClasses
+GET /education/users/{educationUserId}/taughtClasses
+```
+
+## Optional query parameters
+
+You can use the OData query option `$orderby` to sort groups in an organization by the **displayName** values, as shown in the following example:
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+GET https://graph.microsoft.com/v1.0/groups?$orderby=displayName
+```
+
+You can also use the `$filter`, `$count` and `$search` query parameters to limit the response.
+
+When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
+
+For more information on OData query options, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| 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 and a collection of [educationClass](../resources/educationclass.md) objects in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "list_educationclass"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/classes/{educationClassId}/members/{educationUserId}/taughtClasses
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationClass)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
+ "displayName": "String",
+ "mailNickname": "String",
+ "description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "classCode": "String",
+ "externalName": "String",
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
+ }
+ ]
+}
+```
v1.0 Educationuser List https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-list.md
+
+ Title: "List educationUser"
+description: "Get a list of the educationUser objects and their properties."
+
+localization_priority: Normal
++
+# List educationUsers
+
+Namespace: microsoft.graph
+
+Get a list of the [educationUser](../resources/educationuser.md) objects and their properties.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.Read.All, EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+GET /education/users
+```
+
+## Optional query parameters
+
+This method supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`.
+
+When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
+
+For more information on OData query options, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+| Name | Description |
+| : | : |
+| 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 and a collection of [educationUser](../resources/educationuser.md) objects in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "list_educationuser"
+}
+-->
+
+```http
+GET https://graph.microsoft.com/v1.0/education/users
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.educationUser)"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.educationUser",
+ "id": "90eedea1-dea1-90ee-a1de-ee90a1deee90",
+ "primaryRole": "String",
+ "middleName": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "residenceAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "mailingAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "student": {
+ "@odata.type": "microsoft.graph.educationStudent"
+ },
+ "teacher": {
+ "@odata.type": "microsoft.graph.educationTeacher"
+ },
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "accountEnabled": "Boolean",
+ "assignedLicenses": [
+ {
+ "@odata.type": "microsoft.graph.assignedLicense"
+ }
+ ],
+ "assignedPlans": [
+ {
+ "@odata.type": "microsoft.graph.assignedPlan"
+ }
+ ],
+ "businessPhones": [
+ "String"
+ ],
+ "department": "String",
+ "displayName": "String",
+ "givenName": "String",
+ "mail": "String",
+ "mailNickname": "String",
+ "mobilePhone": "String",
+ "passwordPolicies": "String",
+ "passwordProfile": {
+ "@odata.type": "microsoft.graph.passwordProfile"
+ },
+ "officeLocation": "String",
+ "preferredLanguage": "String",
+ "provisionedPlans": [
+ {
+ "@odata.type": "microsoft.graph.provisionedPlan"
+ }
+ ],
+ "refreshTokensValidFromDateTime": "String (timestamp)",
+ "showInAddressList": "Boolean",
+ "surname": "String",
+ "usageLocation": "String",
+ "userPrincipalName": "String",
+ "userType": "String",
+ "onPremisesInfo": {
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
+ }
+ }
+ ]
+}
+```
v1.0 Educationuser Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-post.md
+
+ Title: "Create educationUser"
+description: "Create a new educationUser object."
+
+localization_priority: Normal
++
+# Create educationUser
+
+Namespace: microsoft.graph
+
+Create a new [educationUser](../resources/educationuser.md) object.
+
+## Permissions
+
+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | EduRoster.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+```http
+POST /education/users
+```
+
+## Request headers
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
+
+## Request body
+
+In the request body, supply a JSON representation of the [educationUser](../resources/educationuser.md) object.
+
+The following table shows the properties that are required when you create the [educationUser](../resources/educationuser.md).
+
+| Property | Type | Description |
+| :- | :-- | :- |
+| accountEnabled | Boolean | **True** if the account is enabled; otherwise, **false**. This property is required when a user is created. Supports $filter. |
+| assignedLicenses | [assignedLicense](../resources/assignedlicense.md) collection | The licenses that are assigned to the user. Not nullable. |
+| assignedPlans | [assignedPlan](../resources/assignedplan.md) collection | The plans that are assigned to the user. Read-only. Not nullable. |
+| businessPhones | String collection | The telephone numbers for the user. **Note:** Although this is a string collection, only one number can be set for this property. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the user. |
+| department | String | The name for the department in which the user works. Supports $filter. |
+| displayName | String | The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby. |
+| externalSource | educationExternalSource | Where this user was created from. Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| givenName | String | The given name (first name) of the user. Supports $filter. |
+| mail | String | The SMTP address for the user; for example, "jeff@contoso.onmicrosoft.com". Read-Only. Supports $filter. |
+| mailingAddress | [physicalAddress](../resources/physicaladdress.md) | Mail address of user. |
+| mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Supports $filter. |
+| middleName | String | The middle name of user. |
+| mobilePhone | String | The primary cellular telephone number for the user. |
+| onPremisesInfo | [educationOnPremisesInfo](../resources/educationonpremisesinfo.md) | Additional information used to associate the AAD user with it's Active Directory counterpart. |
+| passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being "DisableStrongPassword", which allows weaker passwords than the default policy to be specified. "DisablePasswordExpiration" can also be specified. The two can be specified together; for example: "DisablePasswordExpiration, DisableStrongPassword". |
+| passwordProfile | [passwordProfile](../resources/passwordprofile.md) | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. |
+| preferredLanguage | String | The preferred language for the user. Should follow ISO 639-1 Code; for example, "en-US". |
+| primaryRole | educationUserRole | Default role for a user. The user's role might be different in an individual class. Possible values are: `student`, `teacher`, `none`. |
+| provisionedPlans | [provisionedPlan](../resources/provisionedplan.md) collection | The plans that are provisioned for the user. Read-only. Not nullable. |
+| residenceAddress | [physicalAddress](../resources/physicaladdress.md) | Address where user lives. |
+| student | [educationStudent](../resources/educationstudent.md) | If the primary role is student, this block will contain student specific data. |
+| surname | String | The user's surname (family name or last name). Supports $filter. |
+| teacher | [educationTeacher](../resources/educationteacher.md) | If the primary role is teacher, this block will contain teacher specific data. |
+| usageLocation | String | A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter. |
+| userPrincipalName | String | The user principal name (UPN) of the user. |
+| userType | String | A string value that can be used to classify user types in your directory, such as "Member" and "Guest". Supports $filter. |
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [educationUser](../resources/educationuser.md) object in the response body.
+
+## Examples
+
+### Request
+
+<!-- {
+ "blockType": "request",
+ "name": "create_educationuser_from_"
+}
+-->
+
+```http
+POST https://graph.microsoft.com/v1.0/education/users
+Content-Type: application/json
+Content-length: 1585
+
+{
+ "@odata.type": "#microsoft.graph.educationUser",
+ "primaryRole": "String",
+ "middleName": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "residenceAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "mailingAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "student": {
+ "@odata.type": "microsoft.graph.educationStudent"
+ },
+ "teacher": {
+ "@odata.type": "microsoft.graph.educationTeacher"
+ },
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "accountEnabled": "Boolean",
+ "assignedLicenses": [
+ {
+ "@odata.type": "microsoft.graph.assignedLicense"
+ }
+ ],
+ "assignedPlans": [
+ {
+ "@odata.type": "microsoft.graph.assignedPlan"
+ }
+ ],
+ "businessPhones": [
+ "String"
+ ],
+ "department": "String",
+ "displayName": "String",
+ "givenName": "String",
+ "mail": "String",
+ "mailNickname": "String",
+ "mobilePhone": "String",
+ "passwordPolicies": "String",
+ "passwordProfile": {
+ "@odata.type": "microsoft.graph.passwordProfile"
+ },
+ "officeLocation": "String",
+ "preferredLanguage": "String",
+ "provisionedPlans": [
+ {
+ "@odata.type": "microsoft.graph.provisionedPlan"
+ }
+ ],
+ "refreshTokensValidFromDateTime": "String (timestamp)",
+ "showInAddressList": "Boolean",
+ "surname": "String",
+ "usageLocation": "String",
+ "userPrincipalName": "String",
+ "userType": "String",
+ "onPremisesInfo": {
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
+ }
+}
+```
+
+### Response
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.educationUser"
+}
+-->
+
+```http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.educationUser",
+ "id": "90eedea1-dea1-90ee-a1de-ee90a1deee90",
+ "primaryRole": "String",
+ "middleName": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "residenceAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "mailingAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "student": {
+ "@odata.type": "microsoft.graph.educationStudent"
+ },
+ "teacher": {
+ "@odata.type": "microsoft.graph.educationTeacher"
+ },
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "accountEnabled": "Boolean",
+ "assignedLicenses": [
+ {
+ "@odata.type": "microsoft.graph.assignedLicense"
+ }
+ ],
+ "assignedPlans": [
+ {
+ "@odata.type": "microsoft.graph.assignedPlan"
+ }
+ ],
+ "businessPhones": [
+ "String"
+ ],
+ "department": "String",
+ "displayName": "String",
+ "givenName": "String",
+ "mail": "String",
+ "mailNickname": "String",
+ "mobilePhone": "String",
+ "passwordPolicies": "String",
+ "passwordProfile": {
+ "@odata.type": "microsoft.graph.passwordProfile"
+ },
+ "officeLocation": "String",
+ "preferredLanguage": "String",
+ "provisionedPlans": [
+ {
+ "@odata.type": "microsoft.graph.provisionedPlan"
+ }
+ ],
+ "refreshTokensValidFromDateTime": "String (timestamp)",
+ "showInAddressList": "Boolean",
+ "surname": "String",
+ "usageLocation": "String",
+ "userPrincipalName": "String",
+ "userType": "String",
+ "onPremisesInfo": {
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
+ }
+}
+```
v1.0 Educationuser Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/educationuser-update.md
Title: "Update educationUser properties"
-description: "Update the properties of an **educationuser** object."
+ Title: "Update educationUser"
+description: "Update the properties of an educationUser object."
+ localization_priority: Normal- ms.prod: "education" doc_type: apiPageType
-# Update educationUser properties
+# Update educationUser
Namespace: microsoft.graph
-Update the properties of an **educationuser** object.
+Update the properties of an [educationUser](../resources/educationuser.md) object.
+ ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
PATCH /education/users/{id}
## 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, don't include existing values that haven't changed.
-| Property | Type |Description|
-|:|:--|:-|
-|displayName| String| Display Name of User|
-|givenName| String | First Name |
-|middleName| String | Middle Name of user|
-|surname| String | Surname of user|
-|mail| String| email address|
-|mobilePhone| String | Mobile number of user |
-|externalSource|string| The possible values are: `sis`, `manual`, `enum_sentinel`.|
-|externalSource|string| Where this user was created from. The possible values are: `sis`, `manual`, `enum_sentinel`.|
-|mailingAddress|[physicalAddress](../resources/physicaladdress.md)| Mail address of user.|
-|residenceAddress|[physicalAddress](../resources/physicaladdress.md)| Address where user lives.|
-|primaryRole|string| Default Role for a user. The user's role might be different in an individual class. The possible values are: `student`, `teacher`, `enum_sentinel`.|
-|student|[educationStudent](../resources/educationstudent.md)| If the primary role is student, this block will contain student specific data.|
-|teacher|[educationTeacher](../resources/educationteacher.md)| If the primary role is teacher, this block will contain teacher specific data.|
-
+| Property | Type | Description |
+| :- | :-- | :- |
+| accountEnabled | Boolean | **True** if the account is enabled; otherwise, **false**. This property is required when a user is created. Supports $filter. |
+| assignedLicenses | [assignedLicense](../resources/assignedlicense.md) collection | The licenses that are assigned to the user. Not nullable. |
+| assignedPlans | [assignedPlan](../resources/assignedplan.md) collection | The plans that are assigned to the user. Read-only. Not nullable. |
+| businessPhones | String collection | The telephone numbers for the user. **Note:** Although this is a string collection, only one number can be set for this property. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the user. |
+| department | String | The name for the department in which the user works. Supports $filter. |
+| displayName | String | The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby. |
+| externalSource | educationExternalSource | Where this user was created from. Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| givenName | String | The given name (first name) of the user. Supports $filter. |
+| mail | String | The SMTP address for the user; for example, "jeff@contoso.onmicrosoft.com". Read-Only. Supports $filter. |
+| mailingAddress | [physicalAddress](../resources/physicaladdress.md) | Mail address of user. |
+| mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Supports $filter. |
+| middleName | String | The middle name of user. |
+| mobilePhone | String | The primary cellular telephone number for the user. |
+| onPremisesInfo | [educationOnPremisesInfo](../resources/educationonpremisesinfo.md) | Additional information used to associate the AAD user with it's Active Directory counterpart. |
+| passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being "DisableStrongPassword", which allows weaker passwords than the default policy to be specified. "DisablePasswordExpiration" can also be specified. The two can be specified together; for example: "DisablePasswordExpiration, DisableStrongPassword". |
+| passwordProfile | [passwordProfile](../resources/passwordprofile.md) | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. |
+| preferredLanguage | String | The preferred language for the user. Should follow ISO 639-1 Code; for example, "en-US". |
+| primaryRole | educationUserRole | Default role for a user. The user's role might be different in an individual class. Possible values are: `student`, `teacher`, `none`, `unknownFutureValue`. |
+| provisionedPlans | [provisionedPlan](../resources/provisionedplan.md) collection | The plans that are provisioned for the user. Read-only. Not nullable. |
+| residenceAddress | [physicalAddress](../resources/physicaladdress.md) | Address where user lives. |
+| student | [educationStudent](../resources/educationstudent.md) | If the primary role is student, this block will contain student specific data. |
+| surname | String | The user's surname (family name or last name). Supports $filter. |
+| teacher | [educationTeacher](../resources/educationteacher.md) | If the primary role is teacher, this block will contain teacher specific data. |
+| usageLocation | String | A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter. |
+| userPrincipalName | String | The user principal name (UPN) of the user. |
+| userType | String | A string value that can be used to classify user types in your directory, such as "Member" and "Guest". Supports $filter. |
## Response If successful, this method returns a `200 OK` response code and updated [educationUser](../resources/educationuser.md) object in the response body.
Content-length: 508
"state": "CA", "street": "12345 Main St." },
- "primaryRole": "student",
+ "primaryRole": "string",
"residenceAddress": { "city": "Los Angeles", "countryOrRegion": "United States",
Content-length: 508
"street": "12345 Main St." }, "student": {
+ "primaryRole": "student",
"externalId": "13005", "birthDate": "2001-01-01T00:00:00Z" }
Content-length: 508
"suppressions": [ ] }-->-
v1.0 Emailauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/emailauthenticationmethodconfiguration-get.md
Content-length: 491
"@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration", "id": "Email", "state": "enabled",
- "allowExternalIdToUseEmailOtp": "True"
+ "allowExternalIdToUseEmailOtp": "enabled"
} } ```
v1.0 User Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/api/user-update.md
doc_type: apiPageType
Namespace: microsoft.graph
-Update the properties of a user object. Not all properties can be updated by Member or Guest users with their default permissions without Administrator roles. [Compare member and guest default permissions](/azure/active-directory/fundamentals/users-default-permissions#compare-member-and-guest-default-permissions) to see properties they can manage.
+Update the properties of a [user](../resources/user.md) object. Not all properties can be updated by Member or Guest users with their default permissions without Administrator roles. [Compare member and guest default permissions](/azure/active-directory/fundamentals/users-default-permissions#compare-member-and-guest-default-permissions) to see properties they can manage.
## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
In the request body, supply the values for relevant fields that should be update
|department|String|The name for the department in which the user works.| |displayName|String|The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Supports `$filter` and `$orderby`.| | employeeId | String | The employee identifier assigned to the user by the organization. |
+| employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`. Supports `$filter` with the `eq` operator.|
|givenName|String|The given name (first name) of the user.| |hireDate|DateTimeOffset|The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |interests|String collection|A list for the user to describe their interests.|
v1.0 Education Overview https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/education-overview.md
To deploy apps that are integrated with the Education APIs in Microsoft Graph, s
To show a consent dialog box, use the following REST call.
-``` http
+```http
GET https://login.microsoftonline.com/{tenant}/adminconsent? client_id={clientId}&state=12345&redirect_uri={redirectUrl} ```
The rostering APIs provide the following key resources:
The rostering APIs support the following scenarios: -- [List all schools](../api/educationroot-list-schools.md)
+- [List all schools](../api/educationschool-list.md)
- [List schools in which a class is taught](../api/educationclass-list-schools.md) - [List schools for a user](../api/educationuser-list-schools.md)-- [Get all classes](../api/educationroot-list-classes.md)
+- [Get all classes](../api/educationclass-list.md)
- [Get classes in a school](../api/educationschool-list-classes.md) - [List classes for a user](../api/educationuser-list-classes.md) - [Add classes to a school](../api/educationschool-post-classes.md)
Find out about the [latest new features and updates](/graph/whats-new-overview)
Use the Microsoft Graph education APIs to build education solutions that access 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/graph/graph-explorer).
+- Try the API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer).
v1.0 Educationclass https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationclass.md
Title: "educationClass resource type" description: "Represents a class within a school. The **educationClass** resource corresponds to the Microsoft 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. " localization_priority: Normal-+ ms.prod: "education" doc_type: resourcePageType
doc_type: resourcePageType
Namespace: microsoft.graph
-Represents a class within a school. The **educationClass** resource corresponds to the Microsoft 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.
+Represents a class within a school. The **educationClass** resource corresponds to the Microsoft 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.
+Inherits from [entity](../resources/entity.md).
## Methods
-| Method | Return Type |Description|
-|:|:--|:-|
-|[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.|
-|[Get group](../api/educationclass-get-group.md) |[group](group.md)| Get the Microsoft 365 **group** that corresponds to this **educationClass**.|
-|[Update](../api/educationclass-update.md) | [educationClass](educationclass.md) |Update **educationClass** object. |
-|[Delete](../api/educationclass-delete.md) | None |Delete **educationClass** object. |
+| Method | Return type | Description |
+| :- | :- | : |
+| [List educationClasses](../api/educationclass-list.md) | [educationClass](../resources/educationclass.md) collection | Get a list of the [educationClass](../resources/educationclass.md) objects and their properties. |
+| [Create educationClass](../api/educationclass-post.md) | [educationClass](../resources/educationclass.md) | Create a new [educationClass](../resources/educationclass.md) object. |
+| [Get educationClass](../api/educationclass-get.md) | [educationClass](../resources/educationclass.md) | Read the properties and relationships of an [educationClass](../resources/educationclass.md) object. |
+| [Update educationClass](../api/educationclass-update.md) | [educationClass](../resources/educationclass.md) | Update the properties of an [educationClass](../resources/educationclass.md) object. |
+| [Delete educationClass](../api/educationclass-delete.md) | None | Delete an [educationClass](../resources/educationclass.md) object. |
+| [delta](../api/educationclass-delta.md) | [educationClass](../resources/educationclass.md) collection | Get incremental changes to the resource collection. |
## Properties
-| Property | Type |Description|
-|:|:--|:-|
-|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.|
-|externalId|String| ID of the class from the syncing system. |
-|externalName|String|Name of the class in the syncing system.|
-|externalSource|educationExternalSource| How this class was created. The possible values are: `sis`, `manual`, `unknownFutureValue`.|
-|term|[educationTerm](educationterm.md)|Term for this class.|
+
+| Property | Type | Description |
+| :- | : | :-- |
+| id | String | Object identifier. Inherited from [entity](../resources/entity.md). |
+| displayName | String | Name of the class. |
+| mailNickname | String | Mail name for sending email to all members, if this is enabled. |
+| description | String | Description of the class. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the class |
+| classCode | String | Class code used by the school to identify the class. |
+| externalName | String | Name of the class in the syncing system. |
+| externalId | String | ID of the class from the syncing system. |
+| externalSource | educationExternalSource | How this class was created. Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| grade | String | Grade level of the class. |
+| term | [educationTerm](../resources/educationterm.md) | Term for this class. |
## Relationships
-| Relationship | Type |Description|
-|:|:--|:-|
-|members|[educationUser](../resources/educationuser.md) collection| All users in the class. Nullable.|
-|schools|[educationSchool](../resources/educationschool.md) collection| All schools that this class is associated with. Nullable.|
-|teachers|[educationUser](../resources/educationuser.md) collection| All teachers in the class. Nullable.|
-|group|[group](../resources/group.md)| The directory group corresponding to this class.|
+
+| Relationship | Type | Description |
+| :-- | : | :-- |
+| group | [group](../resources/group.md) | The underlying Microsoft 365 group object. |
+| members | [educationUser](../resources/educationuser.md) collection | All users in the class. Nullable. |
+| schools | [educationSchool](../resources/educationschool.md) collection | All schools that this class is associated with. Nullable. |
+| teachers | [educationUser](../resources/educationuser.md) collection | All teachers in the class. Nullable. |
## JSON representation The following is a JSON representation of the resource.
-<!--{
+<!-- {
"blockType": "resource",
- "optionalProperties": [],
"keyProperty": "id",
+ "@odata.type": "microsoft.graph.educationClass",
"baseType": "microsoft.graph.entity",
- "@odata.type": "microsoft.graph.educationClass"
-}-->
+ "openType": false
+}
+-->
```json {
- "id": "String",
+ "@odata.type": "#microsoft.graph.educationClass",
+ "id": "String (identifier)",
+ "displayName": "String",
+ "mailNickname": "String",
"description": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
"classCode": "String",
- "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
- "displayName": "String",
- "externalId": "String",
"externalName": "String",
- "externalSource": "string",
- "mailNickname": "String",
- "term": {"@odata.type": "microsoft.graph.educationTerm"}
+ "externalId": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "grade": "String",
+ "term": {
+ "@odata.type": "microsoft.graph.educationTerm"
+ }
}- ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationClass resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
-
v1.0 Educationcourse https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationcourse.md
+
+ Title: "educationCourse resource type"
+description: "Represents the course information for a class."
+
+localization_priority: Normal
++
+# educationCourse resource type
+
+Namespace: microsoft.graph
+
+Represents the course information for a class. It is used within [educationClass](educationclass.md).
+
+## Properties
+
+| Property | Type | Description |
+| :-- | :-- | :- |
+| courseNumber | String | Unique identifier for the course. |
+| description | String | Description of the course. |
+| displayName | String | Name of the course. |
+| externalId | String | ID of the course from the syncing system. |
+| subject | String | Subject of the course. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.educationCourse"
+}
+-->
+
+```json
+{
+ "@odata.type": "#microsoft.graph.educationCourse",
+ "subject": "String",
+ "courseNumber": "String",
+ "description": "String",
+ "displayName": "String",
+ "externalId": "String"
+}
+```
v1.0 Educationonpremisesinfo https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationonpremisesinfo.md
+
+ Title: "educationOnPremisesInfo resource type"
+description: "Additional information used to associate an on-premises Active Directory user account to their Azure AD user object."
+
+localization_priority: Normal
++
+# educationOnPremisesInfo resource type
+
+Namespace: microsoft.graph
+
+Additional information used to associate an on-premises Active Directory user account to their Azure AD user object.
+
+## Properties
+
+| Property | Type | Description |
+| :- | :-- | : |
+| immutableId | String | Unique identifier for the user object in Active Directory. |
+
+## Relationships
+
+None.
+
+## JSON representation
+
+The following is a JSON representation of the resource.
+
+<!-- {
+ "blockType": "resource",
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
+}
+-->
+
+```json
+{
+ "@odata.type": "#microsoft.graph.educationOnPremisesInfo",
+ "immutableId": "String"
+}
+```
v1.0 Educationorganization https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationorganization.md
Title: "educationOrganization resource type" description: "Abstract entity used to model the commonality between different organization types within the education sector."-+ localization_priority: Normal ms.prod: "education" doc_type: resourcePageType
Namespace: microsoft.graph
Abstract entity used to model the commonality between different organization types within the education sector.
+Inherits from [entity](../resources/entity.md).
+ ## Properties
-| Property | Type |Description|
-|:|:--|:-|
-|description|String| Organization description.|
-|displayName|String| Organization display name.|
-|externalSource|educationExternalSource| Source where this organization was created from. The possible values are: `sis`, `manual`, `unknownFutureValue`.|
+
+| Property | Type | Description |
+| :- | :- | :- |
+| description | String | Organization description. |
+| displayName | String | Organization display name. |
+| externalSource | educationExternalSource | Source where this organization was created from. Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| id | String | Object identifier. Inherited from [entity](../resources/entity.md) |
## Relationships
-None.
+None.
## JSON representation
The following is a JSON representation of the resource.
<!-- { "blockType": "resource",
- "abstract": true,
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.educationOrganization",
"baseType": "microsoft.graph.entity",
- "optionalProperties": [
-
- ],
- "@odata.type": "microsoft.graph.educationOrganization"
-}-->
+ "openType": false
+}
+-->
```json {
- "description": "String",
+ "@odata.type": "#microsoft.graph.educationOrganization",
+ "id": "String (identifier)",
"displayName": "String",
- "externalSource": "string"
+ "description": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String"
}- ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationOrganization resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
-
v1.0 Educationroot https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationroot.md
- Title: "educationRoot resource type"
-description: "The `/education` namespace exposes functionality that is specific to the education sector. "
-
-localization_priority: Normal
-doc_type: resourcePageType
--
-# educationRoot resource type
-
-Namespace: microsoft.graph
-
-The `/education` namespace exposes functionality that is specific to the education sector.
-Some objects in the `/education` namespace can be found in other parts of Microsoft Graph (for example, [users](user.md)). The education namespace provides education-specific properties and features on these objects.
-
-## Methods
-
-| Method | Return Type |Description|
-|:|:--|:-|
-|[Create educationClass](../api/educationroot-post-classes.md) |[educationClass](educationclass.md)| Create a new **educationClass** by posting to the classes collection.|
-|[List classes](../api/educationroot-list-classes.md) |[educationClass](educationclass.md) collection| Get an **educationClass** object collection.|
-|[Create educationSchool](../api/educationroot-post-schools.md) |[educationSchool](educationschool.md)| Create a new **educationSchool** by posting to the schools collection.|
-|[List schools](../api/educationroot-list-schools.md) |[educationSchool](educationschool.md) collection| Get an **educationSchool** object collection.|
-|[Create educationUser](../api/educationroot-post-users.md) |[educationUser](educationuser.md)| Create a new **educationUser** by posting to the users collection.|
-|[List users](../api/educationroot-list-users.md) |[educationUser](educationuser.md) collection| Get an **educationUser** object collection.|
-
-## Properties
-None.
-
-## Relationships
-| Relationship | Type |Description|
-|:|:--|:-|
-|classes|[educationClass](educationclass.md) collection| Read-only. Nullable.|
-|me|[educationUser](educationuser.md)| Read-only. Nullable.|
-|schools|[educationSchool](educationschool.md) collection| Read-only. Nullable.|
-|users|[educationUser](educationuser.md) collection| Read-only. Nullable.|
-
-## JSON representation
-Here is a JSON representation of the resource.
-
-<!--{
- "blockType": "resource",
- "optionalProperties": [],
- "baseType": "microsoft.graph.entity",
- "@odata.type": "microsoft.graph.educationRoot"
-}-->
-
-```json
-{
-}
-```
--
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "get_education"
-}-->
-```msgraph-interactive
-GET https://graph.microsoft.com/v1.0/education
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
----
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.educationRoot"
-} -->
-```http
-HTTP/1.1 200 OK
-Content-type: application/json
-
-{
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationRoot resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}-->
-
v1.0 Educationschool https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationschool.md
Title: "educationSchool resource type" description: "A resource representing a school and used to manage the classes, teachers, and students of the represented school. "+ localization_priority: Normal- ms.prod: "education" doc_type: resourcePageType
doc_type: resourcePageType
Namespace: microsoft.graph
-A resource representing a school and used to manage the classes, teachers, and students of the represented school.
+A resource representing a school and used to manage the classes, teachers, and students of the represented school.
+
+Inherits from [educationOrganization](../resources/educationorganization.md).
## Methods
-| Method | Return Type | Description |
-| :- | : | : |
-| [Get](../api/educationschool-get.md) | [educationSchool](educationschool.md) | Read properties and relationships of an **educationSchool** object. |
-| [Add class](../api/educationschool-post-classes.md) | [educationClass](educationclass.md) | Add a new **educationClass** for the school by posting to the classes navigation property. |
-| [List classes](../api/educationschool-list-classes.md) | [educationClass](educationclass.md) collection | Get the **educationClass** object collection. |
-| [Remove class](../api/educationschool-delete-classes.md) | [educationClass](educationclass.md) | Remove an **educationClass** from the school through the classes navigation property. |
-| [Add user](../api/educationschool-post-users.md) | [educationUser](educationuser.md) | Add a new **educationUser** for the school by posting to the **users** navigation property. |
-| [List users](../api/educationschool-list-users.md) | [educationUser](educationuser.md) collection | Get the **educationUser** object collection. |
-| [Remove user](../api/educationschool-delete-users.md) | [educationUser](educationuser.md) | Remove an **educationUser** from the school through the **users** navigation property. |
-| [Update](../api/educationschool-update.md) | [educationSchool](educationschool.md) | Update an **educationSchool** object. |
-| [Delete](../api/educationschool-delete.md) | None | Delete an **educationSchool** object. |
+| Method | Return type | Description |
+| : | : | :-- |
+| [List educationSchools](../api/educationschool-list.md) | [educationSchool](../resources/educationschool.md) collection | Get a list of the [educationSchool](../resources/educationschool.md) objects and their properties. |
+| [Create educationSchool](../api/educationschool-post.md) | [educationSchool](../resources/educationschool.md) | Create a new [educationSchool](../resources/educationschool.md) object. |
+| [Get educationSchool](../api/educationschool-get.md) | [educationSchool](../resources/educationschool.md) | Read the properties and relationships of an [educationSchool](../resources/educationschool.md) object. |
+| [Update educationSchool](../api/educationschool-update.md) | [educationSchool](../resources/educationschool.md) | Update the properties of an [educationSchool](../resources/educationschool.md) object. |
+| [Delete educationSchool](../api/educationschool-delete.md) | None | Delete an [educationSchool](../resources/educationschool.md) object. |
+| [delta](../api/educationschool-delta.md) | [educationSchool](../resources/educationschool.md) collection | Get incremental changes to the resource collection. |
## Properties
-| Property | Type | Description |
-| : | : | : |
-| id | String | GUID of this school. |
-| displayName | String | Display name of the school. |
-| description | String | Description of the school. |
-| status | string | Read-Only. The possible values are: `inactive`, `active`, `expired`, `deleteable`. |
-| externalSource | educationExternalSource | Read-Only. The possible values are: `sis`, `manual`, `unknownFutureValue`. |
-| principalEmail | String | Email address of the principal. |
-| principalName | String | Name of the principal. |
-| externalPrincipalId | String | ID of principal in syncing system. |
-| highestGrade | String | Highest grade taught. |
-| lowestGrade | String | Lowest grade taught. |
-| schoolNumber | String | School Number. |
-| externalId | String | ID of school in syncing system. |
-| phone | String | Phone number of school. |
-| address | [physicalAddress](physicaladdress.md) | Address of the school. |
-| createdBy | [identitySet](identityset.md) | Entity who created the school. |
+| Property | Type | Description |
+| :- | :- | :- |
+| address | [physicalAddress](../resources/physicaladdress.md) | Address of the school. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the school. |
+| description | String | Description of the school. Inherited from [educationOrganization](../resources/educationorganization.md). |
+| displayName | String | Display name of the school. Inherited from [educationOrganization](../resources/educationorganization.md). |
+| externalId | String | ID of school in syncing system. |
+| externalPrincipalId | String | ID of principal in syncing system. |
+| externalSource | educationExternalSource | Source where this organization was created from. Inherited from [educationOrganization](../resources/educationorganization.md). Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| highestGrade | String | Highest grade taught. |
+| id | String | Object identifier. Inherited from [entity](../resources/entity.md). |
+| lowestGrade | String | Lowest grade taught. |
+| phone | String | Phone number of school. |
+| principalEmail | String | Email address of the principal. |
+| principalName | String | Name of the principal. |
+| schoolNumber | String | School Number. |
## Relationships
-| Relationship | Type | Description |
-| :-- | : | :-- |
-| classes | [educationClass](educationclass.md) collection | Classes taught at the school. Nullable. |
-| users | [educationUser](educationuser.md) collection | Users in the school. Nullable. |
+| Relationship | Type | Description |
+| :-- | :- | : |
+| administrativeUnit | [administrativeUnit](../resources/administrativeunit.md) | The underlying administrativeUnit for this school. |
+| classes | [educationClass](../resources/educationclass.md) collection | Classes taught at the school. Nullable. |
+| users | [educationUser](../resources/educationuser.md) collection | Users in the school. Nullable. |
## JSON representation The following is a JSON representation of the resource.
-<!--{
+<!-- {
"blockType": "resource",
- "optionalProperties": [],
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.educationSchool",
"baseType": "microsoft.graph.educationOrganization",
- "@odata.type": "microsoft.graph.educationSchool"
-}-->
+ "openType": false
+}
+-->
```json {
- "id": "String",
+ "@odata.type": "#microsoft.graph.educationSchool",
+ "id": "String (identifier)",
"displayName": "String", "description": "String",
- "status": "String",
"externalSource": "String",
+ "externalSourceDetail": "String",
"principalEmail": "String", "principalName": "String", "externalPrincipalId": "String",
- "highestGrade": "String",
"lowestGrade": "String",
+ "highestGrade": "String",
"schoolNumber": "String",
- "address": {"@odata.type": "microsoft.graph.physicalAddress"},
- "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"externalId": "String",
- "phone": "String"
+ "phone": "String",
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "address": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ }
} ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationSchool resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
-
v1.0 Educationstudent https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationstudent.md
Namespace: microsoft.graph
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| Birth date of the student.|
-|externalId|String| ID of the student in the source system.|
-|gender|educationGender| The possible values are: `female`, `male`, `other`, `unknownFutureValue`.|
-|grade|String|Current grade level of the student.|
-|graduationYear|String| Year the student is graduating from the school.|
-|studentNumber|String| Student Number.|
+
+| Property | Type | Description |
+| :- | :-- | : |
+| birthDate | Date | Birth date of the student. |
+| externalId | String | ID of the student in the source system. |
+| gender | educationGender | The possible values are: `female`, `male`, `other`, `unknownFutureValue`. |
+| grade | String | Current grade level of the student. |
+| graduationYear | String | Year the student is graduating from the school. |
+| studentNumber | String | Student Number. |
+
+## Relationships
+
+None.
## JSON representation
The following is a JSON representation of the resource.
<!-- { "blockType": "resource",
- "optionalProperties": [
-
- ],
"@odata.type": "microsoft.graph.educationStudent"
-}-->
+}
+-->
```json {
- "birthDate": "String (timestamp)",
- "externalId": "String",
- "gender": "educationGender",
- "grade": "String",
+ "@odata.type": "#microsoft.graph.educationStudent",
"graduationYear": "String",
- "studentNumber": "String"
+ "grade": "String",
+ "birthDate": "DateTimeOffset",
+ "gender": "String",
+ "studentNumber": "String",
+ "externalId": "String"
} ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationStudent resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
-
v1.0 Educationteacher https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationteacher.md
ms.prod: "education"
doc_type: resourcePageType
-# educationTeacher resource type
+# Teacher resource type
Namespace: microsoft.graph Additional information added to an [educationUser](educationuser.md) that is present when the primaryRole of a user is `teacher`. - ## Properties
-| Property | Type |Description|
-|:|:--|:-|
-|externalId|String| ID of the teacher in the source system.|
-|teacherNumber|String|Teacher number.|
+
+| Property | Type | Description |
+| : | :-- | :-- |
+| externalId | String | ID of the teacher in the source system. |
+| teacherNumber | String | Teacher number. |
+
+## Relationships
+
+None.
## JSON representation
The following is a JSON representation of the resource.
<!-- { "blockType": "resource",
- "optionalProperties": [
-
- ],
"@odata.type": "microsoft.graph.educationTeacher"
-}-->
+}
+-->
```json {
- "externalId": "String",
- "teacherNumber": "String"
+ "@odata.type": "#microsoft.graph.educationTeacher",
+ "teacherNumber": "String",
+ "externalId": "String"
}- ```-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationTeacher resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
-
v1.0 Educationterm https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationterm.md
Namespace: microsoft.graph
A term. This represents a designated portion of the academic year. It is used within [educationClass](educationclass.md). ## Properties
-| Property | Type |Description|
-|:|:--|:-|
-|displayName| String| Display name of the term.|
-|externalId|String| ID of term in the syncing system.|
-|startDate|Date|Start of the term.|
-|endDate|Date|End of the term.|
+
+| Property | Type | Description |
+| :- | :-- | :-- |
+| displayName | String | Display name of the term. |
+| externalId | String | ID of term in the syncing system. |
+| startDate | Date | Start of the term. |
+| endDate | Date | End of the term. |
+
+## Relationships
+
+None.
## JSON representation
The following is a JSON representation of the resource.
<!-- { "blockType": "resource",
- "optionalProperties": [
-
- ],
"@odata.type": "microsoft.graph.educationTerm"
-}-->
+}
+-->
```json {
- "displayName": "String",
+ "@odata.type": "#microsoft.graph.educationTerm",
"externalId": "String", "startDate": "Date",
- "endDate": "Date"
+ "endDate": "Date",
+ "displayName": "String"
} ```-
-<!-- uuid: 4e9d671f-3068-4e09-aba2-b39e81a0e452
-2015-10-25 14:57:30 UTC -->
-<!-- {
- "type": "#page.annotation",
- "description": "educationTerm resource",
- "keywords": "",
- "section": "documentation",
- "tocPath": ""
-}-->
-
v1.0 Educationuser https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/educationuser.md
Title: "educationUser resource type" description: "A user in the system. This is an education-specific variant of the user with the same `id` that Microsoft Graph will return from the non-education-specific `/users` endpoint."-+ localization_priority: Normal ms.prod: "education" doc_type: resourcePageType
doc_type: resourcePageType
Namespace: microsoft.graph
-A user in the system. This is an education-specific variant of the user with the same `id` that Microsoft Graph will return from the non-education-specific `/users` endpoint.
-This object provides a targeted subset of properties from the core [user] object and adds a set of education-specific properties such as `primaryRole`, student, and teacher data.
+A user in the system. This is an education-specific variant of the user with the same `id` that Microsoft Graph will return from the non-education-specific `/users` endpoint. This object provides a targeted subset of properties from the core [user](../resources/user.md) object and adds a set of education-specific properties such as `primaryRole`, student, and teacher data.
+
+Inherits from [entity](../resources/entity.md).
## Methods
-| Method | Return Type | Description |
-| : | : | :- |
-| [Get educationUser](../api/educationuser-get.md) | [educationUser] | Read properties and relationships of an **educationUser** object. |
-| [List classes](../api/educationuser-list-classes.md) | [educationClass] collection | Get the **educationClass** object collection for which the user is member. |
-| [List schools](../api/educationuser-list-schools.md) | [educationSchool] collection | Get the **educationSchool** object collection for which the user is a member. |
-| [Get user](../api/educationuser-get-user.md) | [user] | Get the simple directory **user** that corresponds to this **educationUser**. |
-| [Update](../api/educationuser-update.md) | [educationUser] | Update an **educationUser** object. |
-| [Delete](../api/educationuser-delete.md) | None | Delete an **educationUser** object. |
+| Method | Return type | Description |
+| : | :- | :- |
+| [List educationUsers](../api/educationuser-list.md) | [educationUser](../resources/educationuser.md) collection | Get a list of the [educationUser](../resources/educationuser.md) objects and their properties. |
+| [Create educationUser](../api/educationuser-post.md) | [educationUser](../resources/educationuser.md) | Create a new [educationUser](../resources/educationuser.md) object. |
+| [Get educationUser](../api/educationuser-get.md) | [educationUser](../resources/educationuser.md) | Read the properties and relationships of an [educationUser](../resources/educationuser.md) object. |
+| [Update educationUser](../api/educationuser-update.md) | [educationUser](../resources/educationuser.md) | Update the properties of an [educationUser](../resources/educationuser.md) object. |
+| [Delete educationUser](../api/educationuser-delete.md) | None | Delete an [educationUser](../resources/educationuser.md) object. |
+| [delta](../api/educationuser-delta.md) | [educationUser](../resources/educationuser.md) collection | Get incremental changes to the resource collection. |
+| [List taughtClasses](../api/educationuser-list-taughtclasses.md) | [educationClass](../resources/educationclass.md) collection | Get the educationClass resources from the taughtClasses navigation property. |
## Properties
-| Property | Type | Description |
-| :- | : | :- |
-| accountEnabled | Boolean | **True** if the account is enabled; otherwise, **false**. This property is required when a user is created. Supports $filter. |
-| assignedLicenses | [assignedLicense] collection | The licenses that are assigned to the user. Not nullable. |
-| assignedPlans | [assignedPlan] collection | The plans that are assigned to the user. Read-only. Not nullable. |
-| businessPhones | String collection | The telephone numbers for the user. **Note:** Although this is a string collection, only one number can be set for this property. |
-| createdBy | [identitySet] | Entity who created the user. |
-| department | String | The name for the department in which the user works. Supports $filter. |
-| displayName | String | The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby. |
-| externalSource | `educationExternalSource` | Where this user was created from. The possible values are: `sis`, `manual`. |
-| givenName | String | The given name (first name) of the user. Supports $filter. |
-| id | String | The unique identifier for the user. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. |
-| mail | String | The SMTP address for the user; for example, "jeff@contoso.onmicrosoft.com". Read-Only. Supports $filter. |
-| mailingAddress | [physicalAddress] | Mail address of user. |
-| mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Supports $filter. |
-| middleName | String | The middle name of user. |
-| mobilePhone | String | The primary cellular telephone number for the user. |
-| passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being "DisableStrongPassword", which allows weaker passwords than the default policy to be specified. "DisablePasswordExpiration" can also be specified. The two can be specified together; for example: "DisablePasswordExpiration, DisableStrongPassword". |
-| passwordProfile | [PasswordProfile] | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. |
-| preferredLanguage | String | The preferred language for the user. Should follow ISO 639-1 Code; for example, "en-US". |
-| primaryRole | educationUserRole | Default role for a user. The user's role might be different in an individual class. The possible values are: `student`, `teacher`. Supports $filter. |
-| provisionedPlans | [ProvisionedPlan] collection | The plans that are provisioned for the user. Read-only. Not nullable. |
-| residenceAddress | [physicalAddress] | Address where user lives. |
-| student | [educationStudent] | If the primary role is student, this block will contain student specific data. |
-| surname | String | The user's surname (family name or last name). Supports $filter. |
-| teacher | [educationTeacher] | If the primary role is teacher, this block will contain teacher specific data. |
-| usageLocation | String | A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter. |
-| userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md). Supports $filter and $orderby. |
-| userType | String | A string value that can be used to classify user types in your directory, such as "Member" and "Guest". Supports $filter. |
+| Property | Type | Description |
+| :- | :-- | :- |
+| accountEnabled | Boolean | `True` if the account is enabled; otherwise, `false`. This property is required when a user is created. Supports $filter. |
+| assignedLicenses | [assignedLicense](../resources/assignedlicense.md) collection | The licenses that are assigned to the user. Not nullable. |
+| assignedPlans | [assignedPlan](../resources/assignedplan.md) collection | The plans that are assigned to the user. Read-only. Not nullable. |
+| businessPhones | String collection | The telephone numbers for the user. **Note:** Although this is a string collection, only one number can be set for this property. |
+| createdBy | [identitySet](../resources/identityset.md) | Entity who created the user. |
+| department | String | The name for the department in which the user works. Supports `$filter`. |
+| displayName | String | The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports `$filter` and `$orderby`. |
+| externalSource | educationExternalSource | Where this user was created from. Possible values are: `sis`, `manual`. |
+| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| givenName | String | The given name (first name) of the user. Supports `$filter`. |
+| id | String | Object identifier. Inherited from [entity](../resources/entity.md) |
+| mail | String | The SMTP address for the user; for example, jeff@contoso.onmicrosoft.com. Read-Only. Supports `$filter`. |
+| mailingAddress | [physicalAddress](../resources/physicaladdress.md) | Mail address of user. |
+| mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Supports `$filter`. |
+| middleName | String | The middle name of user. |
+| mobilePhone | String | The primary cellular telephone number for the user. |
+| onPremisesInfo | [educationOnPremisesInfo](../resources/educationonpremisesinfo.md) | Additional information used to associate the Azure AD user with its Active Directory counterpart. |
+| passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two can be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`. |
+| passwordProfile | [passwordProfile](../resources/passwordprofile.md) | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. |
+| preferredLanguage | String | The preferred language for the user. Should follow ISO 639-1 Code; for example, "en-US". |
+| primaryRole | educationUserRole | Default role for a user. The user's role might be different in an individual class. Possible values are: `student`, `teacher`, `none`, `unknownFutureValue`. |
+| provisionedPlans | [provisionedPlan](../resources/provisionedplan.md) collection | The plans that are provisioned for the user. Read-only. Not nullable. |
+| residenceAddress | [physicalAddress](../resources/physicaladdress.md) | Address where user lives. |
+| showInAddressList | Boolean | true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. |
+| student | [educationStudent](../resources/educationstudent.md) | If the primary role is student, this block will contain student specific data. |
+| surname | String | The user's surname (family name or last name). Supports `$filter`. |
+| teacher | [educationTeacher](../resources/educationteacher.md) | If the primary role is teacher, this block will contain teacher specific data. |
+| usageLocation | String | A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: "US", "JP", and "GB". Not nullable. Supports `$filter`. |
+| userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md). Supports `$filter` and `$orderby`. |
+| userType | String | A string value that can be used to classify user types in your directory, such as "Member" and "Guest". Supports `$filter`. |
+
+> [!IMPORTANT]
+> When using Delegated permission scopes, Graph will only return a limited set of properties: `id`, `primaryRole`, `accountEnabled`, `displayName`, `givenName`, `surname`, `userPrincipalName`, `userType`, `onPremisesInfo`, `student/externalId`, `teacher/externalId`. If your application requires additional properties, you must use Application permission scopes.
## Relationships
-| Relationship | Type | Description |
-| :-- | : | : |
-| classes | [educationClass] collection | Classes to which the user belongs. Nullable. |
-| schools | [educationSchool] collection | Schools to which the user belongs. Nullable. |
-| assignments | [educationAssignment] | List of assignments for the user. Nullable. |
-| user | [user] | The directory user corresponding to this user. |
-
->[!IMPORTANT]
->The **[educationAssignment]** resource is a /beta version resource. If using this resource, be sure to review the [change log](/graph/changelog) periodically. When Microsoft Graph API resources are released to the /v1.0 endpoint, the release is noted in the change log. If your app consumes the **educationAssignment** resource, you will need to declare base request URLs as shown in the following code block:
->
->```JavaScript
->var v1BaseUrl = "https://graph.microsoft.com/v1.0/education";
->var betaBaseUrl = "https://graph.microsoft.com/beta/education"; // for administrativeUnit and educationOrganization
->```
+| Relationship | Type | Description |
+| : | : | : |
+| classes | [educationClass](../resources/educationclass.md) collection | Classes to which the user belongs. Nullable. |
+| schools | [educationSchool](../resources/educationschool.md) collection | Schools to which the user belongs. Nullable. |
+| taughtClasses | [educationClass](../resources/educationclass.md) collection | Classes for which the user is a teacher. |
+| user | [user](../resources/user.md) | The directory user corresponding to this user. |
## JSON representation The following is a JSON representation of the resource.
-<!--{
+<!-- {
"blockType": "resource",
- "optionalProperties": [],
"keyProperty": "id",
+ "@odata.type": "microsoft.graph.educationUser",
"baseType": "microsoft.graph.entity",
- "@odata.type": "microsoft.graph.educationUser"
-}-->
+ "openType": false
+}
+-->
```json {
- "id": "string",
- "accountEnabled": true,
- "assignedLicenses": [{"@odata.type": "microsoft.graph.assignedLicense"}],
- "assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}],
- "businessPhones": ["555-555-6568"],
- "department": "string",
- "displayName": "string",
- "givenName": "string",
- "middleName": "string",
- "surname": "string",
- "mail": "string",
- "mailNickname": "string",
- "mobilePhone": "string",
- "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
- "externalSource": "string",
- "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"},
- "passwordPolicies": "string",
- "passwordProfile": {"@odata.type": "microsoft.graph.passwordProfile"},
- "preferredLanguage": "string",
- "primaryRole": "string",
- "provisionedPlans": [{"@odata.type": "microsoft.graph.provisionedPlan"}],
- "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"},
- "student": {"@odata.type": "microsoft.graph.educationStudent"},
- "teacher": {"@odata.type": "microsoft.graph.educationTeacher"},
- "usageLocation": "string",
- "userPrincipalName": "string",
- "userType": "string"
+ "@odata.type": "#microsoft.graph.educationUser",
+ "id": "String (identifier)",
+ "primaryRole": "String",
+ "middleName": "String",
+ "externalSource": "String",
+ "externalSourceDetail": "String",
+ "residenceAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "mailingAddress": {
+ "@odata.type": "microsoft.graph.physicalAddress"
+ },
+ "student": {
+ "@odata.type": "microsoft.graph.educationStudent"
+ },
+ "teacher": {
+ "@odata.type": "microsoft.graph.educationTeacher"
+ },
+ "createdBy": {
+ "@odata.type": "microsoft.graph.identitySet"
+ },
+ "accountEnabled": "Boolean",
+ "assignedLicenses": [
+ {
+ "@odata.type": "microsoft.graph.assignedLicense"
+ }
+ ],
+ "assignedPlans": [
+ {
+ "@odata.type": "microsoft.graph.assignedPlan"
+ }
+ ],
+ "businessPhones": ["String"],
+ "department": "String",
+ "displayName": "String",
+ "givenName": "String",
+ "mail": "String",
+ "mailNickname": "String",
+ "mobilePhone": "String",
+ "passwordPolicies": "String",
+ "passwordProfile": {
+ "@odata.type": "microsoft.graph.passwordProfile"
+ },
+ "officeLocation": "String",
+ "preferredLanguage": "String",
+ "provisionedPlans": [
+ {
+ "@odata.type": "microsoft.graph.provisionedPlan"
+ }
+ ],
+ "refreshTokensValidFromDateTime": "String (timestamp)",
+ "showInAddressList": "Boolean",
+ "surname": "String",
+ "usageLocation": "String",
+ "userPrincipalName": "String",
+ "userType": "String",
+ "onPremisesInfo": {
+ "@odata.type": "microsoft.graph.educationOnPremisesInfo"
+ }
}- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Emailauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/emailauthenticationmethodconfiguration.md
doc_type: "resourcePageType"
Namespace: microsoft.graph
-Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset, or by external users for authentication in some circumstances.
+Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset, or by external users for authentication during invitation redemption and self-service sign-up for specific apps in user flows.
## Methods
Represents this tenant's email OTP authentication methods policy. Authentication
|:|:|:| |id|String|The authentication method policy identifier. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |state|authenticationMethodState|Indicates whether this authentication method is enabled or not. Possible values are: `enabled`, `disabled`.|
-|allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who did not use public preview will automatically have email OTP enabled beginning in March 2021.|
+|allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who did not use public preview will automatically have email OTP enabled beginning in October 2021.|
## Relationships
v1.0 Enums https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/enums.md
Namespace: microsoft.graph
| lightRed | 8 | maxColor | 9 - ### educationExternalSource values
-| Member
-|:-
-| sis
-| manual
-| unknownFutureValue
-
+| Member |
+| :-- |
+| sis |
+| manual |
+| unknownFutureValue |
### educationGender values
Namespace: microsoft.graph
| normal | high - ### educationUserRole values
-| Member
-|:
-| student
-| teacher
+
+| Member |
+| :-- |
+| student |
+| teacher |
+| none |
+| unknownFutureValue |
### meetingMessageType values
v1.0 Printer https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/printer.md
Inherits from [printerBase](../resources/printerbase.md).
|location|[printerLocation](printerlocation.md)|The physical and/or organizational location of the printer. Inherited from [printerBase](../resources/printerbase.md).| |defaults|[printerDefaults](printerdefaults.md)|The printer's default print settings. Inherited from [printerBase](../resources/printerbase.md).| |capabilities|[printerCapabilities](printercapabilities.md)|The capabilities of the printer associated with this printer share. Inherited from [printerBase](../resources/printerbase.md).|
+|lastSeenDateTime|DateTimeOffset|The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.|
## Relationships |Relationship|Type|Description|
The following is a JSON representation of the resource.
}, "registeredDateTime": "String (timestamp)", "isShared": "Boolean",
- "hasPhysicalDevice": "Boolean"
+ "hasPhysicalDevice": "Boolean",
+ "lastSeenDateTime": "String (timestamp)"
} ```
v1.0 Serviceprincipal https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/serviceprincipal.md
This resource supports using [delta query](/graph/delta-query-overview) to track
|loginUrl|String|Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with [SAML-based single sign-on](/azure/active-directory/manage-apps/what-is-single-sign-on#saml-sso). The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.| |logoutUrl|String| Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect [front-channel](https://openid.net/specs/openid-connect-frontchannel-1_0.html), [back-channel](https://openid.net/specs/openid-connect-backchannel-1_0.html) or SAML logout protocols.| |notes|String|Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.|
-|oauth2PermissionScopes|[permissionScope](permissionScope.md) collection|The delegated permissions exposed by the application. For more information see the **oauth2PermissionScopes** property on the [application](application.md) entity's **api** property. Not nullable.|
-| notes | String | Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. |
|notificationEmailAddresses|String collection|Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.|
+|oauth2PermissionScopes|[permissionScope](permissionScope.md) collection|The delegated permissions exposed by the application. For more information see the **oauth2PermissionScopes** property on the [application](application.md) entity's **api** property. Not nullable.|
|preferredSingleSignOnMode|string|Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are `password`, `saml`, `notSupported`, and `oidc`.| |replyUrls|String collection|The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. | |samlSingleSignOnSettings|[samlSingleSignOnSettings](samlsinglesignonsettings.md)|The collection for settings related to saml single sign-on.|
v1.0 User https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/resources/user.md
This resource supports:
| employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in case of a future hire. <br><br>Returned only on `$select`. Supports `$filter`.| | employeeId | String | The employee identifier assigned to the user by the organization. <br><br>Returned only on `$select`. Supports `$filter`.| |employeeOrgData|[employeeOrgData](employeeorgdata.md) |Represents organization data (e.g. division and costCenter) associated with a user. <br><br>Returned only on `$select`.|
-| employeeType | String | Captures enterprise worker type: Employee, Contractor, Consultant, Vendor, etc. <br><br>Returned only on `$select`. Supports `$filter`.|
+| employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`. Supports `$filter` with the `eq` operator.|
|externalUserState|String|For an external user invited to the tenant using the [invitation API](../api/invitation-post.md), this property represents the invited user's invitation status. For invited users, the state can be `PendingAcceptance` or `Accepted`, or `null` for all other users. <br><br>Returned only on `$select`. Supports `$filter` with the supported values. For example: `$filter=externalUserState eq 'PendingAcceptance'`.| |externalUserStateChangeDateTime|DateTimeOffset|Shows the timestamp for the latest change to the **externalUserState** property. <br><br>Returned only on `$select`.| |faxNumber|String|The fax number of the user.|
v1.0 Toc.Yml https://github.com/microsoftgraph/microsoft-graph-docs/commits/master/api-reference/v1.0/toc.yml a/api-reference/v1.0/toc.yml
items:
href: resources/educationschool.md items: - name: List schools
- href: api/educationroot-list-schools.md
+ href: api/educationschool-list.md
- name: Create school
- href: api/educationroot-post-schools.md
+ href: api/educationschool-post.md
- name: Get school href: api/educationschool-get.md - name: Update school href: api/educationschool-update.md - name: Delete school href: api/educationschool-delete.md
+ - name: Get changes to schools
+ href: api/educationschool-delta.md
- name: List classes href: api/educationschool-list-classes.md - name: Create class
items:
- name: Classes href: resources/educationclass.md items:
- - name: List schools
- href: api/educationclass-list-schools.md
- name: List classes
- href: api/educationroot-list-classes.md
+ href: api/educationclass-list.md
- name: Create class
- href: api/educationroot-post-classes.md
+ href: api/educationclass-post.md
- name: Get class href: api/educationclass-get.md - name: Update class href: api/educationclass-update.md - name: Delete class href: api/educationclass-delete.md
+ - name: Get changes to classes
+ href: api/educationclass-delta.md
- name: List teachers href: api/educationclass-list-teachers.md - name: Add teacher
items:
- name: Users href: resources/educationuser.md items:
- - name: List schools
- href: api/educationuser-list-schools.md
- - name: List classes
- href: api/educationuser-list-classes.md
+ - name: List users
+ href: api/educationuser-list.md
+ - name: Create user
+ href: api/educationuser-post.md
- name: Get user href: api/educationuser-get.md - name: Delete user href: api/educationuser-delete.md
+ - name: Get changes to users
+ href: api/educationuser-delta.md
+ - name: List classes
+ href: api/educationuser-list-classes.md
+ - name: List taught classes
+ href: api/educationuser-list-taughtclasses.md
- name: Extensions items: - name: Open extensions