educationUser resource type

  • 4 minutes to read

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.

Methods

Method Return Type Description
Get educationUser educationUser Read properties and relationships of an educationUser object.
List classes educationClass collection Get the educationClass object collection for which the user is member.
List schools educationSchool collection Get the educationSchool object collection for which the user is a member.
Get user user Get the simple directory user that corresponds to this educationUser.
Update educationUser Update an educationUser object.
Delete None Delete an educationUser object.

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. 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.
relatedContacts relatedContact collection Set of contacts related to the user. This optional property must be specified in a $select clause and can only be retrieved for an individual user.
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 conatin 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. 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.

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.

Note: The educationassignment resource is a /beta version resource. If using this resource, be sure to review the change log 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:

var v1BaseUrl = “https://graph.microsoft.com/v1.0/education”;
var betaBaseUrl = “https://graph.microsoft.com/beta/education”;  // for administrativeUnit and educationOrganization

JSON representation

The following is a JSON representation of the resource.

{
  "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"
}