Package com.microsoft.graph.models

Class EducationUser

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.EducationUser
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class EducationUser extends Entity implements com.microsoft.kiota.serialization.Parsable

  • Constructor Details

    • EducationUser

      public EducationUser()
      Instantiates a new EducationUser and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static EducationUser createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a EducationUser

    • getAccountEnabled

      @Nullable public Boolean getAccountEnabled()
      Gets the accountEnabled property value. True if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter.
      Returns:
      a Boolean

    • getAssignedLicenses

      @Nullable public List<AssignedLicense> getAssignedLicenses()
      Gets the assignedLicenses property value. The licenses that are assigned to the user. Not nullable.
      Returns:
      a List<AssignedLicense>

    • getAssignedPlans

      @Nullable public List<AssignedPlan> getAssignedPlans()
      Gets the assignedPlans property value. The plans that are assigned to the user. Read-only. Not nullable.
      Returns:
      a List<AssignedPlan>

    • getAssignments

      @Nullable public List<EducationAssignment> getAssignments()
      Gets the assignments property value. Assignments belonging to the user.
      Returns:
      a List<EducationAssignment>

    • getBusinessPhones

      @Nullable public List<String> getBusinessPhones()
      Gets the businessPhones property value. The telephone numbers for the user. Note: Although this is a string collection, only one number can be set for this property.
      Returns:
      a List<String>

    • getClasses

      @Nullable public List<EducationClass> getClasses()
      Gets the classes property value. Classes to which the user belongs. Nullable.
      Returns:
      a List<EducationClass>

    • getCreatedBy

      @Nullable public IdentitySet getCreatedBy()
      Gets the createdBy property value. The entity who created the user.
      Returns:
      a IdentitySet

    • getDepartment

      @Nullable public String getDepartment()
      Gets the department property value. The name for the department in which the user works. Supports $filter.
      Returns:
      a String

    • getDisplayName

      @Nullable public String getDisplayName()
      Gets the displayName property value. 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.
      Returns:
      a String

    • getExternalSource

      @Nullable public EducationExternalSource getExternalSource()
      Gets the externalSource property value. Where this user was created from. Possible values are: sis, manual.
      Returns:
      a EducationExternalSource

    • getExternalSourceDetail

      @Nullable public String getExternalSourceDetail()
      Gets the externalSourceDetail property value. The name of the external source this resource was generated from.
      Returns:
      a String

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class Entity
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getGivenName

      @Nullable public String getGivenName()
      Gets the givenName property value. The given name (first name) of the user. Supports $filter.
      Returns:
      a String

    • getMail

      @Nullable public String getMail()
      Gets the mail property value. The SMTP address for the user, for example, [email protected]. Read-Only. Supports $filter.
      Returns:
      a String

    • getMailingAddress

      @Nullable public PhysicalAddress getMailingAddress()
      Gets the mailingAddress property value. The mail address of the user.
      Returns:
      a PhysicalAddress

    • getMailNickname

      @Nullable public String getMailNickname()
      Gets the mailNickname property value. The mail alias for the user. This property must be specified when a user is created. Supports $filter.
      Returns:
      a String

    • getMiddleName

      @Nullable public String getMiddleName()
      Gets the middleName property value. The middle name of the user.
      Returns:
      a String

    • getMobilePhone

      @Nullable public String getMobilePhone()
      Gets the mobilePhone property value. The primary cellular telephone number for the user.
      Returns:
      a String

    • getOfficeLocation

      @Nullable public String getOfficeLocation()
      Gets the officeLocation property value. The office location for the user.
      Returns:
      a String

    • getOnPremisesInfo

      @Nullable public EducationOnPremisesInfo getOnPremisesInfo()
      Gets the onPremisesInfo property value. Additional information used to associate the Microsoft Entra user with its Active Directory counterpart.
      Returns:
      a EducationOnPremisesInfo

    • getPasswordPolicies

      @Nullable public String getPasswordPolicies()
      Gets the passwordPolicies property value. 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.
      Returns:
      a String

    • getPasswordProfile

      @Nullable public PasswordProfile getPasswordProfile()
      Gets the passwordProfile property value. 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.
      Returns:
      a PasswordProfile

    • getPreferredLanguage

      @Nullable public String getPreferredLanguage()
      Gets the preferredLanguage property value. The preferred language for the user that should follow the ISO 639-1 code, for example, en-US.
      Returns:
      a String

    • getPrimaryRole

      @Nullable public EducationUserRole getPrimaryRole()
      Gets the primaryRole property value. The primaryRole property
      Returns:
      a EducationUserRole

    • getProvisionedPlans

      @Nullable public List<ProvisionedPlan> getProvisionedPlans()
      Gets the provisionedPlans property value. The plans that are provisioned for the user. Read-only. Not nullable.
      Returns:
      a List<ProvisionedPlan>

    • getRefreshTokensValidFromDateTime

      @Nullable public OffsetDateTime getRefreshTokensValidFromDateTime()
      Gets the refreshTokensValidFromDateTime property value. Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on $select. Read-only.
      Returns:
      a OffsetDateTime

    • getRelatedContacts

      @Nullable public List<RelatedContact> getRelatedContacts()
      Gets the relatedContacts property value. Related records associated with the user. Read-only.
      Returns:
      a List<RelatedContact>

    • getResidenceAddress

      @Nullable public PhysicalAddress getResidenceAddress()
      Gets the residenceAddress property value. The address where the user lives.
      Returns:
      a PhysicalAddress

    • getRubrics

      @Nullable public List<EducationRubric> getRubrics()
      Gets the rubrics property value. When set, the grading rubric attached to the assignment.
      Returns:
      a List<EducationRubric>

    • getSchools

      @Nullable public List<EducationSchool> getSchools()
      Gets the schools property value. Schools to which the user belongs. Nullable.
      Returns:
      a List<EducationSchool>

    • getShowInAddressList

      @Nullable public Boolean getShowInAddressList()
      Gets the showInAddressList property value. 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.
      Returns:
      a Boolean

    • getStudent

      @Nullable public EducationStudent getStudent()
      Gets the student property value. If the primary role is student, this block will contain student specific data.
      Returns:
      a EducationStudent

    • getSurname

      @Nullable public String getSurname()
      Gets the surname property value. The user's surname (family name or last name). Supports $filter.
      Returns:
      a String

    • getTaughtClasses

      @Nullable public List<EducationClass> getTaughtClasses()
      Gets the taughtClasses property value. Classes for which the user is a teacher.
      Returns:
      a List<EducationClass>

    • getTeacher

      @Nullable public EducationTeacher getTeacher()
      Gets the teacher property value. If the primary role is teacher, this block will contain teacher specific data.
      Returns:
      a EducationTeacher

    • getUsageLocation

      @Nullable public String getUsageLocation()
      Gets the usageLocation property value. 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.
      Returns:
      a String

    • getUser

      @Nullable public User getUser()
      Gets the user property value. The directory user that corresponds to this user.
      Returns:
      a User

    • getUserPrincipalName

      @Nullable public String getUserPrincipalName()
      Gets the userPrincipalName property value. 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 the organization. Supports $filter and $orderby.
      Returns:
      a String

    • getUserType

      @Nullable public String getUserType()
      Gets the userType property value. A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter.
      Returns:
      a String

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class Entity
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setAccountEnabled

      public void setAccountEnabled(@Nullable Boolean value)
      Sets the accountEnabled property value. True if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter.
      Parameters:
      value - Value to set for the accountEnabled property.

    • setAssignedLicenses

      public void setAssignedLicenses(@Nullable List<AssignedLicense> value)
      Sets the assignedLicenses property value. The licenses that are assigned to the user. Not nullable.
      Parameters:
      value - Value to set for the assignedLicenses property.

    • setAssignedPlans

      public void setAssignedPlans(@Nullable List<AssignedPlan> value)
      Sets the assignedPlans property value. The plans that are assigned to the user. Read-only. Not nullable.
      Parameters:
      value - Value to set for the assignedPlans property.

    • setAssignments

      public void setAssignments(@Nullable List<EducationAssignment> value)
      Sets the assignments property value. Assignments belonging to the user.
      Parameters:
      value - Value to set for the assignments property.

    • setBusinessPhones

      public void setBusinessPhones(@Nullable List<String> value)
      Sets the businessPhones property value. The telephone numbers for the user. Note: Although this is a string collection, only one number can be set for this property.
      Parameters:
      value - Value to set for the businessPhones property.

    • setClasses

      public void setClasses(@Nullable List<EducationClass> value)
      Sets the classes property value. Classes to which the user belongs. Nullable.
      Parameters:
      value - Value to set for the classes property.

    • setCreatedBy

      public void setCreatedBy(@Nullable IdentitySet value)
      Sets the createdBy property value. The entity who created the user.
      Parameters:
      value - Value to set for the createdBy property.

    • setDepartment

      public void setDepartment(@Nullable String value)
      Sets the department property value. The name for the department in which the user works. Supports $filter.
      Parameters:
      value - Value to set for the department property.

    • setDisplayName

      public void setDisplayName(@Nullable String value)
      Sets the displayName property value. 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.
      Parameters:
      value - Value to set for the displayName property.

    • setExternalSource

      public void setExternalSource(@Nullable EducationExternalSource value)
      Sets the externalSource property value. Where this user was created from. Possible values are: sis, manual.
      Parameters:
      value - Value to set for the externalSource property.

    • setExternalSourceDetail

      public void setExternalSourceDetail(@Nullable String value)
      Sets the externalSourceDetail property value. The name of the external source this resource was generated from.
      Parameters:
      value - Value to set for the externalSourceDetail property.

    • setGivenName

      public void setGivenName(@Nullable String value)
      Sets the givenName property value. The given name (first name) of the user. Supports $filter.
      Parameters:
      value - Value to set for the givenName property.

    • setMail

      public void setMail(@Nullable String value)
      Sets the mail property value. The SMTP address for the user, for example, [email protected]. Read-Only. Supports $filter.
      Parameters:
      value - Value to set for the mail property.

    • setMailingAddress

      public void setMailingAddress(@Nullable PhysicalAddress value)
      Sets the mailingAddress property value. The mail address of the user.
      Parameters:
      value - Value to set for the mailingAddress property.

    • setMailNickname

      public void setMailNickname(@Nullable String value)
      Sets the mailNickname property value. The mail alias for the user. This property must be specified when a user is created. Supports $filter.
      Parameters:
      value - Value to set for the mailNickname property.

    • setMiddleName

      public void setMiddleName(@Nullable String value)
      Sets the middleName property value. The middle name of the user.
      Parameters:
      value - Value to set for the middleName property.

    • setMobilePhone

      public void setMobilePhone(@Nullable String value)
      Sets the mobilePhone property value. The primary cellular telephone number for the user.
      Parameters:
      value - Value to set for the mobilePhone property.

    • setOfficeLocation

      public void setOfficeLocation(@Nullable String value)
      Sets the officeLocation property value. The office location for the user.
      Parameters:
      value - Value to set for the officeLocation property.

    • setOnPremisesInfo

      public void setOnPremisesInfo(@Nullable EducationOnPremisesInfo value)
      Sets the onPremisesInfo property value. Additional information used to associate the Microsoft Entra user with its Active Directory counterpart.
      Parameters:
      value - Value to set for the onPremisesInfo property.

    • setPasswordPolicies

      public void setPasswordPolicies(@Nullable String value)
      Sets the passwordPolicies property value. 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.
      Parameters:
      value - Value to set for the passwordPolicies property.

    • setPasswordProfile

      public void setPasswordProfile(@Nullable PasswordProfile value)
      Sets the passwordProfile property value. 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.
      Parameters:
      value - Value to set for the passwordProfile property.

    • setPreferredLanguage

      public void setPreferredLanguage(@Nullable String value)
      Sets the preferredLanguage property value. The preferred language for the user that should follow the ISO 639-1 code, for example, en-US.
      Parameters:
      value - Value to set for the preferredLanguage property.

    • setPrimaryRole

      public void setPrimaryRole(@Nullable EducationUserRole value)
      Sets the primaryRole property value. The primaryRole property
      Parameters:
      value - Value to set for the primaryRole property.

    • setProvisionedPlans

      public void setProvisionedPlans(@Nullable List<ProvisionedPlan> value)
      Sets the provisionedPlans property value. The plans that are provisioned for the user. Read-only. Not nullable.
      Parameters:
      value - Value to set for the provisionedPlans property.

    • setRefreshTokensValidFromDateTime

      public void setRefreshTokensValidFromDateTime(@Nullable OffsetDateTime value)
      Sets the refreshTokensValidFromDateTime property value. Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on $select. Read-only.
      Parameters:
      value - Value to set for the refreshTokensValidFromDateTime property.

    • setRelatedContacts

      public void setRelatedContacts(@Nullable List<RelatedContact> value)
      Sets the relatedContacts property value. Related records associated with the user. Read-only.
      Parameters:
      value - Value to set for the relatedContacts property.

    • setResidenceAddress

      public void setResidenceAddress(@Nullable PhysicalAddress value)
      Sets the residenceAddress property value. The address where the user lives.
      Parameters:
      value - Value to set for the residenceAddress property.

    • setRubrics

      public void setRubrics(@Nullable List<EducationRubric> value)
      Sets the rubrics property value. When set, the grading rubric attached to the assignment.
      Parameters:
      value - Value to set for the rubrics property.

    • setSchools

      public void setSchools(@Nullable List<EducationSchool> value)
      Sets the schools property value. Schools to which the user belongs. Nullable.
      Parameters:
      value - Value to set for the schools property.

    • setShowInAddressList

      public void setShowInAddressList(@Nullable Boolean value)
      Sets the showInAddressList property value. 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.
      Parameters:
      value - Value to set for the showInAddressList property.

    • setStudent

      public void setStudent(@Nullable EducationStudent value)
      Sets the student property value. If the primary role is student, this block will contain student specific data.
      Parameters:
      value - Value to set for the student property.

    • setSurname

      public void setSurname(@Nullable String value)
      Sets the surname property value. The user's surname (family name or last name). Supports $filter.
      Parameters:
      value - Value to set for the surname property.

    • setTaughtClasses

      public void setTaughtClasses(@Nullable List<EducationClass> value)
      Sets the taughtClasses property value. Classes for which the user is a teacher.
      Parameters:
      value - Value to set for the taughtClasses property.

    • setTeacher

      public void setTeacher(@Nullable EducationTeacher value)
      Sets the teacher property value. If the primary role is teacher, this block will contain teacher specific data.
      Parameters:
      value - Value to set for the teacher property.

    • setUsageLocation

      public void setUsageLocation(@Nullable String value)
      Sets the usageLocation property value. 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.
      Parameters:
      value - Value to set for the usageLocation property.

    • setUser

      public void setUser(@Nullable User value)
      Sets the user property value. The directory user that corresponds to this user.
      Parameters:
      value - Value to set for the user property.

    • setUserPrincipalName

      public void setUserPrincipalName(@Nullable String value)
      Sets the userPrincipalName property value. 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 the organization. Supports $filter and $orderby.
      Parameters:
      value - Value to set for the userPrincipalName property.

    • setUserType

      public void setUserType(@Nullable String value)
      Sets the userType property value. A string value that can be used to classify user types in your directory, such as Member and Guest. Supports $filter.
      Parameters:
      value - Value to set for the userType property.